Integration Connectors v1 API - Class ConnectorsClientImpl (1.3.0)

public sealed class ConnectorsClientImpl : ConnectorsClient

Reference documentation and code samples for the Integration Connectors v1 API class ConnectorsClientImpl.

Connectors client wrapper implementation, for convenient use.

Inheritance

object > ConnectorsClient > ConnectorsClientImpl

Namespace

Google.Cloud.Connectors.V1

Assembly

Google.Cloud.Connectors.V1.dll

Remarks

Connectors is the interface for managing Connectors.

Constructors

ConnectorsClientImpl(ConnectorsClient, ConnectorsSettings, ILogger)

public ConnectorsClientImpl(Connectors.ConnectorsClient grpcClient, ConnectorsSettings settings, ILogger logger)

Constructs a client wrapper for the Connectors service, with the specified gRPC client and settings.

Parameters
Name Description
grpcClient ConnectorsConnectorsClient

The underlying gRPC client.
settings ConnectorsSettings

The base ConnectorsSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateConnectionOperationsClient

public override OperationsClient CreateConnectionOperationsClient { get; }

The long-running operations client for CreateConnection.

Property Value
Type Description
OperationsClient
Overrides

DeleteConnectionOperationsClient

public override OperationsClient DeleteConnectionOperationsClient { get; }

The long-running operations client for DeleteConnection.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Connectors.ConnectorsClient GrpcClient { get; }

The underlying gRPC Connectors client

Property Value
Type Description
ConnectorsConnectorsClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type Description
IAMPolicyClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RefreshConnectionSchemaMetadataOperationsClient

public override OperationsClient RefreshConnectionSchemaMetadataOperationsClient { get; }

The long-running operations client for RefreshConnectionSchemaMetadata.

Property Value
Type Description
OperationsClient
Overrides

UpdateConnectionOperationsClient

public override OperationsClient UpdateConnectionOperationsClient { get; }

The long-running operations client for UpdateConnection.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateConnection(CreateConnectionRequest, CallSettings)

public override Operation<Connection, OperationMetadata> CreateConnection(CreateConnectionRequest request, CallSettings callSettings = null)

Creates a new Connection in a given project and location.

Parameters
Name Description
request CreateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationConnectionOperationMetadata

The RPC response.
Overrides

CreateConnectionAsync(CreateConnectionRequest, CallSettings)

public override Task<Operation<Connection, OperationMetadata>> CreateConnectionAsync(CreateConnectionRequest request, CallSettings callSettings = null)

Creates a new Connection in a given project and location.

Parameters
Name Description
request CreateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationConnectionOperationMetadata

A Task containing the RPC response.
Overrides

DeleteConnection(DeleteConnectionRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteConnection(DeleteConnectionRequest request, CallSettings callSettings = null)

Deletes a single Connection.

Parameters
Name Description
request DeleteConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationEmptyOperationMetadata

The RPC response.
Overrides

DeleteConnectionAsync(DeleteConnectionRequest, CallSettings)

public override Task<Operation<Empty, OperationMetadata>> DeleteConnectionAsync(DeleteConnectionRequest request, CallSettings callSettings = null)

Deletes a single Connection.

Parameters
Name Description
request DeleteConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationEmptyOperationMetadata

A Task containing the RPC response.
Overrides

GetConnection(GetConnectionRequest, CallSettings)

public override Connection GetConnection(GetConnectionRequest request, CallSettings callSettings = null)

Gets details of a single Connection.

Parameters
Name Description
request GetConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Connection

The RPC response.
Overrides

GetConnectionAsync(GetConnectionRequest, CallSettings)

public override Task<Connection> GetConnectionAsync(GetConnectionRequest request, CallSettings callSettings = null)

Gets details of a single Connection.

Parameters
Name Description
request GetConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConnection

A Task containing the RPC response.
Overrides

GetConnectionSchemaMetadata(GetConnectionSchemaMetadataRequest, CallSettings)

public override ConnectionSchemaMetadata GetConnectionSchemaMetadata(GetConnectionSchemaMetadataRequest request, CallSettings callSettings = null)

Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection.

Parameters
Name Description
request GetConnectionSchemaMetadataRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConnectionSchemaMetadata

The RPC response.
Overrides

GetConnectionSchemaMetadataAsync(GetConnectionSchemaMetadataRequest, CallSettings)

public override Task<ConnectionSchemaMetadata> GetConnectionSchemaMetadataAsync(GetConnectionSchemaMetadataRequest request, CallSettings callSettings = null)

Gets schema metadata of a connection. SchemaMetadata is a singleton resource for each connection.

Parameters
Name Description
request GetConnectionSchemaMetadataRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConnectionSchemaMetadata

A Task containing the RPC response.
Overrides

GetConnector(GetConnectorRequest, CallSettings)

public override Connector GetConnector(GetConnectorRequest request, CallSettings callSettings = null)

Gets details of a single Connector.

Parameters
Name Description
request GetConnectorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Connector

The RPC response.
Overrides

GetConnectorAsync(GetConnectorRequest, CallSettings)

public override Task<Connector> GetConnectorAsync(GetConnectorRequest request, CallSettings callSettings = null)

Gets details of a single Connector.

Parameters
Name Description
request GetConnectorRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConnector

A Task containing the RPC response.
Overrides

GetConnectorVersion(GetConnectorVersionRequest, CallSettings)

public override ConnectorVersion GetConnectorVersion(GetConnectorVersionRequest request, CallSettings callSettings = null)

Gets details of a single connector version.

Parameters
Name Description
request GetConnectorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
ConnectorVersion

The RPC response.
Overrides

GetConnectorVersionAsync(GetConnectorVersionRequest, CallSettings)

public override Task<ConnectorVersion> GetConnectorVersionAsync(GetConnectorVersionRequest request, CallSettings callSettings = null)

Gets details of a single connector version.

Parameters
Name Description
request GetConnectorVersionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskConnectorVersion

A Task containing the RPC response.
Overrides

GetGlobalSettings(GetGlobalSettingsRequest, CallSettings)

public override Settings GetGlobalSettings(GetGlobalSettingsRequest request, CallSettings callSettings = null)

GetGlobalSettings gets settings of a project. GlobalSettings is a singleton resource.

Parameters
Name Description
request GetGlobalSettingsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Settings

The RPC response.
Overrides

GetGlobalSettingsAsync(GetGlobalSettingsRequest, CallSettings)

public override Task<Settings> GetGlobalSettingsAsync(GetGlobalSettingsRequest request, CallSettings callSettings = null)

GetGlobalSettings gets settings of a project. GlobalSettings is a singleton resource.

Parameters
Name Description
request GetGlobalSettingsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskSettings

A Task containing the RPC response.
Overrides

GetProvider(GetProviderRequest, CallSettings)

public override Provider GetProvider(GetProviderRequest request, CallSettings callSettings = null)

Gets details of a provider.

Parameters
Name Description
request GetProviderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
Provider

The RPC response.
Overrides

GetProviderAsync(GetProviderRequest, CallSettings)

public override Task<Provider> GetProviderAsync(GetProviderRequest request, CallSettings callSettings = null)

Gets details of a provider.

Parameters
Name Description
request GetProviderRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskProvider

A Task containing the RPC response.
Overrides

GetRuntimeConfig(GetRuntimeConfigRequest, CallSettings)

public override RuntimeConfig GetRuntimeConfig(GetRuntimeConfigRequest request, CallSettings callSettings = null)

Gets the runtimeConfig of a location. RuntimeConfig is a singleton resource for each location.

Parameters
Name Description
request GetRuntimeConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
RuntimeConfig

The RPC response.
Overrides

GetRuntimeConfigAsync(GetRuntimeConfigRequest, CallSettings)

public override Task<RuntimeConfig> GetRuntimeConfigAsync(GetRuntimeConfigRequest request, CallSettings callSettings = null)

Gets the runtimeConfig of a location. RuntimeConfig is a singleton resource for each location.

Parameters
Name Description
request GetRuntimeConfigRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskRuntimeConfig

A Task containing the RPC response.
Overrides

ListConnections(ListConnectionsRequest, CallSettings)

public override PagedEnumerable<ListConnectionsResponse, Connection> ListConnections(ListConnectionsRequest request, CallSettings callSettings = null)

Lists Connections in a given project and location.

Parameters
Name Description
request ListConnectionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListConnectionsResponseConnection

A pageable sequence of Connection resources.
Overrides

ListConnectionsAsync(ListConnectionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConnectionsResponse, Connection> ListConnectionsAsync(ListConnectionsRequest request, CallSettings callSettings = null)

Lists Connections in a given project and location.

Parameters
Name Description
request ListConnectionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListConnectionsResponseConnection

A pageable asynchronous sequence of Connection resources.
Overrides

ListConnectorVersions(ListConnectorVersionsRequest, CallSettings)

public override PagedEnumerable<ListConnectorVersionsResponse, ConnectorVersion> ListConnectorVersions(ListConnectorVersionsRequest request, CallSettings callSettings = null)

Lists Connector Versions in a given project and location.

Parameters
Name Description
request ListConnectorVersionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListConnectorVersionsResponseConnectorVersion

A pageable sequence of ConnectorVersion resources.
Overrides

ListConnectorVersionsAsync(ListConnectorVersionsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConnectorVersionsResponse, ConnectorVersion> ListConnectorVersionsAsync(ListConnectorVersionsRequest request, CallSettings callSettings = null)

Lists Connector Versions in a given project and location.

Parameters
Name Description
request ListConnectorVersionsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListConnectorVersionsResponseConnectorVersion

A pageable asynchronous sequence of ConnectorVersion resources.
Overrides

ListConnectors(ListConnectorsRequest, CallSettings)

public override PagedEnumerable<ListConnectorsResponse, Connector> ListConnectors(ListConnectorsRequest request, CallSettings callSettings = null)

Lists Connectors in a given project and location.

Parameters
Name Description
request ListConnectorsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListConnectorsResponseConnector

A pageable sequence of Connector resources.
Overrides

ListConnectorsAsync(ListConnectorsRequest, CallSettings)

public override PagedAsyncEnumerable<ListConnectorsResponse, Connector> ListConnectorsAsync(ListConnectorsRequest request, CallSettings callSettings = null)

Lists Connectors in a given project and location.

Parameters
Name Description
request ListConnectorsRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListConnectorsResponseConnector

A pageable asynchronous sequence of Connector resources.
Overrides

ListProviders(ListProvidersRequest, CallSettings)

public override PagedEnumerable<ListProvidersResponse, Provider> ListProviders(ListProvidersRequest request, CallSettings callSettings = null)

Lists Providers in a given project and location.

Parameters
Name Description
request ListProvidersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListProvidersResponseProvider

A pageable sequence of Provider resources.
Overrides

ListProvidersAsync(ListProvidersRequest, CallSettings)

public override PagedAsyncEnumerable<ListProvidersResponse, Provider> ListProvidersAsync(ListProvidersRequest request, CallSettings callSettings = null)

Lists Providers in a given project and location.

Parameters
Name Description
request ListProvidersRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListProvidersResponseProvider

A pageable asynchronous sequence of Provider resources.
Overrides

ListRuntimeActionSchemas(ListRuntimeActionSchemasRequest, CallSettings)

public override PagedEnumerable<ListRuntimeActionSchemasResponse, RuntimeActionSchema> ListRuntimeActionSchemas(ListRuntimeActionSchemasRequest request, CallSettings callSettings = null)

List schema of a runtime actions filtered by action name.

Parameters
Name Description
request ListRuntimeActionSchemasRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListRuntimeActionSchemasResponseRuntimeActionSchema

A pageable sequence of RuntimeActionSchema resources.
Overrides

ListRuntimeActionSchemasAsync(ListRuntimeActionSchemasRequest, CallSettings)

public override PagedAsyncEnumerable<ListRuntimeActionSchemasResponse, RuntimeActionSchema> ListRuntimeActionSchemasAsync(ListRuntimeActionSchemasRequest request, CallSettings callSettings = null)

List schema of a runtime actions filtered by action name.

Parameters
Name Description
request ListRuntimeActionSchemasRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListRuntimeActionSchemasResponseRuntimeActionSchema

A pageable asynchronous sequence of RuntimeActionSchema resources.
Overrides

ListRuntimeEntitySchemas(ListRuntimeEntitySchemasRequest, CallSettings)

public override PagedEnumerable<ListRuntimeEntitySchemasResponse, RuntimeEntitySchema> ListRuntimeEntitySchemas(ListRuntimeEntitySchemasRequest request, CallSettings callSettings = null)

List schema of a runtime entities filtered by entity name.

Parameters
Name Description
request ListRuntimeEntitySchemasRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedEnumerableListRuntimeEntitySchemasResponseRuntimeEntitySchema

A pageable sequence of RuntimeEntitySchema resources.
Overrides

ListRuntimeEntitySchemasAsync(ListRuntimeEntitySchemasRequest, CallSettings)

public override PagedAsyncEnumerable<ListRuntimeEntitySchemasResponse, RuntimeEntitySchema> ListRuntimeEntitySchemasAsync(ListRuntimeEntitySchemasRequest request, CallSettings callSettings = null)

List schema of a runtime entities filtered by entity name.

Parameters
Name Description
request ListRuntimeEntitySchemasRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
PagedAsyncEnumerableListRuntimeEntitySchemasResponseRuntimeEntitySchema

A pageable asynchronous sequence of RuntimeEntitySchema resources.
Overrides

RefreshConnectionSchemaMetadata(RefreshConnectionSchemaMetadataRequest, CallSettings)

public override Operation<ConnectionSchemaMetadata, OperationMetadata> RefreshConnectionSchemaMetadata(RefreshConnectionSchemaMetadataRequest request, CallSettings callSettings = null)

Refresh runtime schema of a connection.

Parameters
Name Description
request RefreshConnectionSchemaMetadataRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationConnectionSchemaMetadataOperationMetadata

The RPC response.
Overrides

RefreshConnectionSchemaMetadataAsync(RefreshConnectionSchemaMetadataRequest, CallSettings)

public override Task<Operation<ConnectionSchemaMetadata, OperationMetadata>> RefreshConnectionSchemaMetadataAsync(RefreshConnectionSchemaMetadataRequest request, CallSettings callSettings = null)

Refresh runtime schema of a connection.

Parameters
Name Description
request RefreshConnectionSchemaMetadataRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationConnectionSchemaMetadataOperationMetadata

A Task containing the RPC response.
Overrides

UpdateConnection(UpdateConnectionRequest, CallSettings)

public override Operation<Connection, OperationMetadata> UpdateConnection(UpdateConnectionRequest request, CallSettings callSettings = null)

Updates the parameters of a single Connection.

Parameters
Name Description
request UpdateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
OperationConnectionOperationMetadata

The RPC response.
Overrides

UpdateConnectionAsync(UpdateConnectionRequest, CallSettings)

public override Task<Operation<Connection, OperationMetadata>> UpdateConnectionAsync(UpdateConnectionRequest request, CallSettings callSettings = null)

Updates the parameters of a single Connection.

Parameters
Name Description
request UpdateConnectionRequest

The request object containing all of the parameters for the API call.
callSettings CallSettings

If not null, applies overrides to this RPC call.
Returns
Type Description
TaskOperationConnectionOperationMetadata

A Task containing the RPC response.
Overrides