Managed Service for Apache Kafka API v1 API - Class ManagedKafkaConnectClientImpl (1.0.0-beta05) 

public sealed class ManagedKafkaConnectClientImpl : ManagedKafkaConnectClient

Reference documentation and code samples for the Managed Service for Apache Kafka API v1 API class ManagedKafkaConnectClientImpl.

ManagedKafkaConnect client wrapper implementation, for convenient use.

Inheritance

object > ManagedKafkaConnectClient > ManagedKafkaConnectClientImpl

Namespace

Google.Cloud.ManagedKafka.V1

Assembly

Google.Cloud.ManagedKafka.V1.dll

Remarks

The service that a client application uses to manage Apache Kafka Connect clusters and connectors.

Constructors

ManagedKafkaConnectClientImpl(ManagedKafkaConnectClient, ManagedKafkaConnectSettings, ILogger)

public ManagedKafkaConnectClientImpl(ManagedKafkaConnect.ManagedKafkaConnectClient grpcClient, ManagedKafkaConnectSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient ManagedKafkaConnectManagedKafkaConnectClient

The underlying gRPC client.
settings ManagedKafkaConnectSettings

The base ManagedKafkaConnectSettings used within this client.
logger ILogger

Optional ILogger to use within this client.

Properties

CreateConnectClusterOperationsClient

public override OperationsClient CreateConnectClusterOperationsClient { get; }

The long-running operations client for CreateConnectCluster.

Property Value
Type Description
OperationsClient
Overrides

DeleteConnectClusterOperationsClient

public override OperationsClient DeleteConnectClusterOperationsClient { get; }

The long-running operations client for DeleteConnectCluster.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override ManagedKafkaConnect.ManagedKafkaConnectClient GrpcClient { get; }

The underlying gRPC ManagedKafkaConnect client

Property Value
Type Description
ManagedKafkaConnectManagedKafkaConnectClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

UpdateConnectClusterOperationsClient

public override OperationsClient UpdateConnectClusterOperationsClient { get; }

The long-running operations client for UpdateConnectCluster.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateConnectCluster(CreateConnectClusterRequest, CallSettings)

public override Operation<ConnectCluster, OperationMetadata> CreateConnectCluster(CreateConnectClusterRequest request, CallSettings callSettings = null)

Creates a new Kafka Connect cluster in a given project and location.

Parameters
Name Description
request CreateConnectClusterRequest

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
OperationConnectClusterOperationMetadata

The RPC response.
Overrides

CreateConnectClusterAsync(CreateConnectClusterRequest, CallSettings)

public override Task<Operation<ConnectCluster, OperationMetadata>> CreateConnectClusterAsync(CreateConnectClusterRequest request, CallSettings callSettings = null)

Creates a new Kafka Connect cluster in a given project and location.

Parameters
Name Description
request CreateConnectClusterRequest

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
TaskOperationConnectClusterOperationMetadata

A Task containing the RPC response.
Overrides

CreateConnector(CreateConnectorRequest, CallSettings)

public override Connector CreateConnector(CreateConnectorRequest request, CallSettings callSettings = null)

Creates a new connector in a given Connect cluster.

Parameters
Name Description
request CreateConnectorRequest

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

CreateConnectorAsync(CreateConnectorRequest, CallSettings)

public override Task<Connector> CreateConnectorAsync(CreateConnectorRequest request, CallSettings callSettings = null)

Creates a new connector in a given Connect cluster.

Parameters
Name Description
request CreateConnectorRequest

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

DeleteConnectCluster(DeleteConnectClusterRequest, CallSettings)

public override Operation<Empty, OperationMetadata> DeleteConnectCluster(DeleteConnectClusterRequest request, CallSettings callSettings = null)

Deletes a single Connect cluster.

Parameters
Name Description
request DeleteConnectClusterRequest

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

DeleteConnectClusterAsync(DeleteConnectClusterRequest, CallSettings)

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

Deletes a single Connect cluster.

Parameters
Name Description
request DeleteConnectClusterRequest

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

DeleteConnector(DeleteConnectorRequest, CallSettings)

public override void DeleteConnector(DeleteConnectorRequest request, CallSettings callSettings = null)

Deletes a connector.

Parameters
Name Description
request DeleteConnectorRequest

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

If not null, applies overrides to this RPC call.
Overrides

DeleteConnectorAsync(DeleteConnectorRequest, CallSettings)

public override Task DeleteConnectorAsync(DeleteConnectorRequest request, CallSettings callSettings = null)

Deletes a connector.

Parameters
Name Description
request DeleteConnectorRequest

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
Task

A Task containing the RPC response.
Overrides

GetConnectCluster(GetConnectClusterRequest, CallSettings)

public override ConnectCluster GetConnectCluster(GetConnectClusterRequest request, CallSettings callSettings = null)

Returns the properties of a single Kafka Connect cluster.

Parameters
Name Description
request GetConnectClusterRequest

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
ConnectCluster

The RPC response.
Overrides

GetConnectClusterAsync(GetConnectClusterRequest, CallSettings)

public override Task<ConnectCluster> GetConnectClusterAsync(GetConnectClusterRequest request, CallSettings callSettings = null)

Returns the properties of a single Kafka Connect cluster.

Parameters
Name Description
request GetConnectClusterRequest

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
TaskConnectCluster

A Task containing the RPC response.
Overrides

GetConnector(GetConnectorRequest, CallSettings)

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

Returns the properties 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)

Returns the properties 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

ListConnectClusters(ListConnectClustersRequest, CallSettings)

public override PagedEnumerable<ListConnectClustersResponse, ConnectCluster> ListConnectClusters(ListConnectClustersRequest request, CallSettings callSettings = null)

Lists the Kafka Connect clusters in a given project and location.

Parameters
Name Description
request ListConnectClustersRequest

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
PagedEnumerableListConnectClustersResponseConnectCluster

A pageable sequence of ConnectCluster resources.
Overrides

ListConnectClustersAsync(ListConnectClustersRequest, CallSettings)

public override PagedAsyncEnumerable<ListConnectClustersResponse, ConnectCluster> ListConnectClustersAsync(ListConnectClustersRequest request, CallSettings callSettings = null)

Lists the Kafka Connect clusters in a given project and location.

Parameters
Name Description
request ListConnectClustersRequest

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
PagedAsyncEnumerableListConnectClustersResponseConnectCluster

A pageable asynchronous sequence of ConnectCluster resources.
Overrides

ListConnectors(ListConnectorsRequest, CallSettings)

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

Lists the connectors in a given Connect cluster.

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 the connectors in a given Connect cluster.

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

PauseConnector(PauseConnectorRequest, CallSettings)

public override PauseConnectorResponse PauseConnector(PauseConnectorRequest request, CallSettings callSettings = null)

Pauses the connector and its tasks.

Parameters
Name Description
request PauseConnectorRequest

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
PauseConnectorResponse

The RPC response.
Overrides

PauseConnectorAsync(PauseConnectorRequest, CallSettings)

public override Task<PauseConnectorResponse> PauseConnectorAsync(PauseConnectorRequest request, CallSettings callSettings = null)

Pauses the connector and its tasks.

Parameters
Name Description
request PauseConnectorRequest

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
TaskPauseConnectorResponse

A Task containing the RPC response.
Overrides

RestartConnector(RestartConnectorRequest, CallSettings)

public override RestartConnectorResponse RestartConnector(RestartConnectorRequest request, CallSettings callSettings = null)

Restarts the connector.

Parameters
Name Description
request RestartConnectorRequest

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
RestartConnectorResponse

The RPC response.
Overrides

RestartConnectorAsync(RestartConnectorRequest, CallSettings)

public override Task<RestartConnectorResponse> RestartConnectorAsync(RestartConnectorRequest request, CallSettings callSettings = null)

Restarts the connector.

Parameters
Name Description
request RestartConnectorRequest

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
TaskRestartConnectorResponse

A Task containing the RPC response.
Overrides

ResumeConnector(ResumeConnectorRequest, CallSettings)

public override ResumeConnectorResponse ResumeConnector(ResumeConnectorRequest request, CallSettings callSettings = null)

Resumes the connector and its tasks.

Parameters
Name Description
request ResumeConnectorRequest

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
ResumeConnectorResponse

The RPC response.
Overrides

ResumeConnectorAsync(ResumeConnectorRequest, CallSettings)

public override Task<ResumeConnectorResponse> ResumeConnectorAsync(ResumeConnectorRequest request, CallSettings callSettings = null)

Resumes the connector and its tasks.

Parameters
Name Description
request ResumeConnectorRequest

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
TaskResumeConnectorResponse

A Task containing the RPC response.
Overrides

StopConnector(StopConnectorRequest, CallSettings)

public override StopConnectorResponse StopConnector(StopConnectorRequest request, CallSettings callSettings = null)

Stops the connector.

Parameters
Name Description
request StopConnectorRequest

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
StopConnectorResponse

The RPC response.
Overrides

StopConnectorAsync(StopConnectorRequest, CallSettings)

public override Task<StopConnectorResponse> StopConnectorAsync(StopConnectorRequest request, CallSettings callSettings = null)

Stops the connector.

Parameters
Name Description
request StopConnectorRequest

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
TaskStopConnectorResponse

A Task containing the RPC response.
Overrides

UpdateConnectCluster(UpdateConnectClusterRequest, CallSettings)

public override Operation<ConnectCluster, OperationMetadata> UpdateConnectCluster(UpdateConnectClusterRequest request, CallSettings callSettings = null)

Updates the properties of a single Kafka Connect cluster.

Parameters
Name Description
request UpdateConnectClusterRequest

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
OperationConnectClusterOperationMetadata

The RPC response.
Overrides

UpdateConnectClusterAsync(UpdateConnectClusterRequest, CallSettings)

public override Task<Operation<ConnectCluster, OperationMetadata>> UpdateConnectClusterAsync(UpdateConnectClusterRequest request, CallSettings callSettings = null)

Updates the properties of a single Kafka Connect cluster.

Parameters
Name Description
request UpdateConnectClusterRequest

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
TaskOperationConnectClusterOperationMetadata

A Task containing the RPC response.
Overrides

UpdateConnector(UpdateConnectorRequest, CallSettings)

public override Connector UpdateConnector(UpdateConnectorRequest request, CallSettings callSettings = null)

Updates the properties of a connector.

Parameters
Name Description
request UpdateConnectorRequest

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

UpdateConnectorAsync(UpdateConnectorRequest, CallSettings)

public override Task<Connector> UpdateConnectorAsync(UpdateConnectorRequest request, CallSettings callSettings = null)

Updates the properties of a connector.

Parameters
Name Description
request UpdateConnectorRequest

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