Google Cloud Dataproc v1 API - Class ClusterControllerClientImpl (5.9.0)

public sealed class ClusterControllerClientImpl : ClusterControllerClient

Reference documentation and code samples for the Google Cloud Dataproc v1 API class ClusterControllerClientImpl.

ClusterController client wrapper implementation, for convenient use.

Inheritance

object > ClusterControllerClient > ClusterControllerClientImpl

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Remarks

The ClusterControllerService provides methods to manage clusters of Compute Engine instances.

Constructors

ClusterControllerClientImpl(ClusterControllerClient, ClusterControllerSettings, ILogger)

public ClusterControllerClientImpl(ClusterController.ClusterControllerClient grpcClient, ClusterControllerSettings settings, ILogger logger)

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

Parameters
NameDescription
grpcClientClusterControllerClusterControllerClient

The underlying gRPC client.

settingsClusterControllerSettings

The base ClusterControllerSettings used within this client.

loggerILogger

Optional ILogger to use within this client.

Properties

CreateClusterOperationsClient

public override OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
TypeDescription
OperationsClient
Overrides

DeleteClusterOperationsClient

public override OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
TypeDescription
OperationsClient
Overrides

DiagnoseClusterOperationsClient

public override OperationsClient DiagnoseClusterOperationsClient { get; }

The long-running operations client for DiagnoseCluster.

Property Value
TypeDescription
OperationsClient
Overrides

GrpcClient

public override ClusterController.ClusterControllerClient GrpcClient { get; }

The underlying gRPC ClusterController client

Property Value
TypeDescription
ClusterControllerClusterControllerClient
Overrides

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
TypeDescription
IAMPolicyClient
Overrides

StartClusterOperationsClient

public override OperationsClient StartClusterOperationsClient { get; }

The long-running operations client for StartCluster.

Property Value
TypeDescription
OperationsClient
Overrides

StopClusterOperationsClient

public override OperationsClient StopClusterOperationsClient { get; }

The long-running operations client for StopCluster.

Property Value
TypeDescription
OperationsClient
Overrides

UpdateClusterOperationsClient

public override OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
TypeDescription
OperationsClient
Overrides

Methods

CreateCluster(CreateClusterRequest, CallSettings)

public override Operation<Cluster, ClusterOperationMetadata> CreateCluster(CreateClusterRequest request, CallSettings callSettings = null)

Creates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
NameDescription
requestCreateClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterClusterOperationMetadata

The RPC response.

Overrides

CreateClusterAsync(CreateClusterRequest, CallSettings)

public override Task<Operation<Cluster, ClusterOperationMetadata>> CreateClusterAsync(CreateClusterRequest request, CallSettings callSettings = null)

Creates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
NameDescription
requestCreateClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterClusterOperationMetadata

A Task containing the RPC response.

Overrides

DeleteCluster(DeleteClusterRequest, CallSettings)

public override Operation<Empty, ClusterOperationMetadata> DeleteCluster(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
NameDescription
requestDeleteClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationEmptyClusterOperationMetadata

The RPC response.

Overrides

DeleteClusterAsync(DeleteClusterRequest, CallSettings)

public override Task<Operation<Empty, ClusterOperationMetadata>> DeleteClusterAsync(DeleteClusterRequest request, CallSettings callSettings = null)

Deletes a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata.

Parameters
NameDescription
requestDeleteClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationEmptyClusterOperationMetadata

A Task containing the RPC response.

Overrides

DiagnoseCluster(DiagnoseClusterRequest, CallSettings)

public override Operation<DiagnoseClusterResults, ClusterOperationMetadata> DiagnoseCluster(DiagnoseClusterRequest request, CallSettings callSettings = null)

Gets cluster diagnostic information. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata. After the operation completes, [Operation.response][google.longrunning.Operation.response] contains DiagnoseClusterResults.

Parameters
NameDescription
requestDiagnoseClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationDiagnoseClusterResultsClusterOperationMetadata

The RPC response.

Overrides

DiagnoseClusterAsync(DiagnoseClusterRequest, CallSettings)

public override Task<Operation<DiagnoseClusterResults, ClusterOperationMetadata>> DiagnoseClusterAsync(DiagnoseClusterRequest request, CallSettings callSettings = null)

Gets cluster diagnostic information. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata. After the operation completes, [Operation.response][google.longrunning.Operation.response] contains DiagnoseClusterResults.

Parameters
NameDescription
requestDiagnoseClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationDiagnoseClusterResultsClusterOperationMetadata

A Task containing the RPC response.

Overrides

GetCluster(GetClusterRequest, CallSettings)

public override Cluster GetCluster(GetClusterRequest request, CallSettings callSettings = null)

Gets the resource representation for a cluster in a project.

Parameters
NameDescription
requestGetClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
Cluster

The RPC response.

Overrides

GetClusterAsync(GetClusterRequest, CallSettings)

public override Task<Cluster> GetClusterAsync(GetClusterRequest request, CallSettings callSettings = null)

Gets the resource representation for a cluster in a project.

Parameters
NameDescription
requestGetClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskCluster

A Task containing the RPC response.

Overrides

ListClusters(ListClustersRequest, CallSettings)

public override PagedEnumerable<ListClustersResponse, Cluster> ListClusters(ListClustersRequest request, CallSettings callSettings = null)

Lists all regions/{region}/clusters in a project alphabetically.

Parameters
NameDescription
requestListClustersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedEnumerableListClustersResponseCluster

A pageable sequence of Cluster resources.

Overrides

ListClustersAsync(ListClustersRequest, CallSettings)

public override PagedAsyncEnumerable<ListClustersResponse, Cluster> ListClustersAsync(ListClustersRequest request, CallSettings callSettings = null)

Lists all regions/{region}/clusters in a project alphabetically.

Parameters
NameDescription
requestListClustersRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
PagedAsyncEnumerableListClustersResponseCluster

A pageable asynchronous sequence of Cluster resources.

Overrides

StartCluster(StartClusterRequest, CallSettings)

public override Operation<Cluster, ClusterOperationMetadata> StartCluster(StartClusterRequest request, CallSettings callSettings = null)

Starts a cluster in a project.

Parameters
NameDescription
requestStartClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterClusterOperationMetadata

The RPC response.

Overrides

StartClusterAsync(StartClusterRequest, CallSettings)

public override Task<Operation<Cluster, ClusterOperationMetadata>> StartClusterAsync(StartClusterRequest request, CallSettings callSettings = null)

Starts a cluster in a project.

Parameters
NameDescription
requestStartClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterClusterOperationMetadata

A Task containing the RPC response.

Overrides

StopCluster(StopClusterRequest, CallSettings)

public override Operation<Cluster, ClusterOperationMetadata> StopCluster(StopClusterRequest request, CallSettings callSettings = null)

Stops a cluster in a project.

Parameters
NameDescription
requestStopClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterClusterOperationMetadata

The RPC response.

Overrides

StopClusterAsync(StopClusterRequest, CallSettings)

public override Task<Operation<Cluster, ClusterOperationMetadata>> StopClusterAsync(StopClusterRequest request, CallSettings callSettings = null)

Stops a cluster in a project.

Parameters
NameDescription
requestStopClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterClusterOperationMetadata

A Task containing the RPC response.

Overrides

UpdateCluster(UpdateClusterRequest, CallSettings)

public override Operation<Cluster, ClusterOperationMetadata> UpdateCluster(UpdateClusterRequest request, CallSettings callSettings = null)

Updates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata. The cluster must be in a [RUNNING][google.cloud.dataproc.v1.ClusterStatus.State] state or an error is returned.

Parameters
NameDescription
requestUpdateClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
OperationClusterClusterOperationMetadata

The RPC response.

Overrides

UpdateClusterAsync(UpdateClusterRequest, CallSettings)

public override Task<Operation<Cluster, ClusterOperationMetadata>> UpdateClusterAsync(UpdateClusterRequest request, CallSettings callSettings = null)

Updates a cluster in a project. The returned [Operation.metadata][google.longrunning.Operation.metadata] will be ClusterOperationMetadata. The cluster must be in a [RUNNING][google.cloud.dataproc.v1.ClusterStatus.State] state or an error is returned.

Parameters
NameDescription
requestUpdateClusterRequest

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

callSettingsCallSettings

If not null, applies overrides to this RPC call.

Returns
TypeDescription
TaskOperationClusterClusterOperationMetadata

A Task containing the RPC response.

Overrides