Google Cloud Dataproc v1 API - Class ClusterControllerClientImpl (5.11.0)

Version 5.11.0

• 5.16.0 (latest)
• 5.15.0
• 5.14.0
• 5.13.0
• 5.12.0
• 5.11.0
• 5.10.0
• 5.9.0
• 5.8.0
• 5.7.0
• 5.6.0
• 5.5.0
• 5.4.0
• 5.3.0
• 5.2.0
• 5.1.0
• 5.0.0
• 4.0.0
• 3.4.0
• 3.3.0
• 3.2.0
• 3.1.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

Inherited Members

ClusterControllerClient.DefaultEndpoint

ClusterControllerClient.DefaultScopes

ClusterControllerClient.ServiceMetadata

ClusterControllerClient.CreateAsync(CancellationToken)

ClusterControllerClient.Create()

ClusterControllerClient.ShutdownDefaultChannelsAsync()

ClusterControllerClient.CreateClusterAsync(CreateClusterRequest, CancellationToken)

ClusterControllerClient.PollOnceCreateCluster(string, CallSettings)

ClusterControllerClient.PollOnceCreateClusterAsync(string, CallSettings)

ClusterControllerClient.CreateCluster(string, string, Cluster, CallSettings)

ClusterControllerClient.CreateClusterAsync(string, string, Cluster, CallSettings)

ClusterControllerClient.CreateClusterAsync(string, string, Cluster, CancellationToken)

ClusterControllerClient.UpdateClusterAsync(UpdateClusterRequest, CancellationToken)

ClusterControllerClient.PollOnceUpdateCluster(string, CallSettings)

ClusterControllerClient.PollOnceUpdateClusterAsync(string, CallSettings)

ClusterControllerClient.UpdateCluster(string, string, string, Cluster, FieldMask, CallSettings)

ClusterControllerClient.UpdateClusterAsync(string, string, string, Cluster, FieldMask, CallSettings)

ClusterControllerClient.UpdateClusterAsync(string, string, string, Cluster, FieldMask, CancellationToken)

ClusterControllerClient.StopClusterAsync(StopClusterRequest, CancellationToken)

ClusterControllerClient.PollOnceStopCluster(string, CallSettings)

ClusterControllerClient.PollOnceStopClusterAsync(string, CallSettings)

ClusterControllerClient.StartClusterAsync(StartClusterRequest, CancellationToken)

ClusterControllerClient.PollOnceStartCluster(string, CallSettings)

ClusterControllerClient.PollOnceStartClusterAsync(string, CallSettings)

ClusterControllerClient.DeleteClusterAsync(DeleteClusterRequest, CancellationToken)

ClusterControllerClient.PollOnceDeleteCluster(string, CallSettings)

ClusterControllerClient.PollOnceDeleteClusterAsync(string, CallSettings)

ClusterControllerClient.DeleteCluster(string, string, string, CallSettings)

ClusterControllerClient.DeleteClusterAsync(string, string, string, CallSettings)

ClusterControllerClient.DeleteClusterAsync(string, string, string, CancellationToken)

ClusterControllerClient.GetClusterAsync(GetClusterRequest, CancellationToken)

ClusterControllerClient.GetCluster(string, string, string, CallSettings)

ClusterControllerClient.GetClusterAsync(string, string, string, CallSettings)

ClusterControllerClient.GetClusterAsync(string, string, string, CancellationToken)

ClusterControllerClient.ListClusters(string, string, string, int?, CallSettings)

ClusterControllerClient.ListClustersAsync(string, string, string, int?, CallSettings)

ClusterControllerClient.ListClusters(string, string, string, string, int?, CallSettings)

ClusterControllerClient.ListClustersAsync(string, string, string, string, int?, CallSettings)

ClusterControllerClient.DiagnoseClusterAsync(DiagnoseClusterRequest, CancellationToken)

ClusterControllerClient.PollOnceDiagnoseCluster(string, CallSettings)

ClusterControllerClient.PollOnceDiagnoseClusterAsync(string, CallSettings)

ClusterControllerClient.DiagnoseCluster(string, string, string, CallSettings)

ClusterControllerClient.DiagnoseClusterAsync(string, string, string, CallSettings)

ClusterControllerClient.DiagnoseClusterAsync(string, string, string, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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
Name	Description
grpcClient	ClusterControllerClusterControllerClient The underlying gRPC client.
settings	ClusterControllerSettings The base ClusterControllerSettings used within this client.
logger	ILogger Optional ILogger to use within this client.

Properties

CreateClusterOperationsClient

public override OperationsClient CreateClusterOperationsClient { get; }

The long-running operations client for CreateCluster.

Property Value
Type	Description
OperationsClient

Overrides

ClusterControllerClient.CreateClusterOperationsClient

DeleteClusterOperationsClient

public override OperationsClient DeleteClusterOperationsClient { get; }

The long-running operations client for DeleteCluster.

Property Value
Type	Description
OperationsClient

Overrides

ClusterControllerClient.DeleteClusterOperationsClient

DiagnoseClusterOperationsClient

public override OperationsClient DiagnoseClusterOperationsClient { get; }

The long-running operations client for DiagnoseCluster.

Property Value
Type	Description
OperationsClient

Overrides

ClusterControllerClient.DiagnoseClusterOperationsClient

GrpcClient

public override ClusterController.ClusterControllerClient GrpcClient { get; }

The underlying gRPC ClusterController client

Property Value
Type	Description
ClusterControllerClusterControllerClient

Overrides

ClusterControllerClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
IAMPolicyClient

Overrides

ClusterControllerClient.IAMPolicyClient

StartClusterOperationsClient

public override OperationsClient StartClusterOperationsClient { get; }

The long-running operations client for StartCluster.

Property Value
Type	Description
OperationsClient

Overrides

ClusterControllerClient.StartClusterOperationsClient

StopClusterOperationsClient

public override OperationsClient StopClusterOperationsClient { get; }

The long-running operations client for StopCluster.

Property Value
Type	Description
OperationsClient

Overrides

ClusterControllerClient.StopClusterOperationsClient

UpdateClusterOperationsClient

public override OperationsClient UpdateClusterOperationsClient { get; }

The long-running operations client for UpdateCluster.

Property Value
Type	Description
OperationsClient

Overrides

ClusterControllerClient.UpdateClusterOperationsClient

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
Name	Description
request	CreateClusterRequest 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
OperationClusterClusterOperationMetadata	The RPC response.

Overrides

ClusterControllerClient.CreateCluster(CreateClusterRequest, CallSettings)

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
Name	Description
request	CreateClusterRequest 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
TaskOperationClusterClusterOperationMetadata	A Task containing the RPC response.

Overrides

ClusterControllerClient.CreateClusterAsync(CreateClusterRequest, CallSettings)

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
Name	Description
request	DeleteClusterRequest 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
OperationEmptyClusterOperationMetadata	The RPC response.

Overrides

ClusterControllerClient.DeleteCluster(DeleteClusterRequest, CallSettings)

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
Name	Description
request	DeleteClusterRequest 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
TaskOperationEmptyClusterOperationMetadata	A Task containing the RPC response.

Overrides

ClusterControllerClient.DeleteClusterAsync(DeleteClusterRequest, CallSettings)

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
Name	Description
request	DiagnoseClusterRequest 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
OperationDiagnoseClusterResultsClusterOperationMetadata	The RPC response.

Overrides

ClusterControllerClient.DiagnoseCluster(DiagnoseClusterRequest, CallSettings)

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
Name	Description
request	DiagnoseClusterRequest 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
TaskOperationDiagnoseClusterResultsClusterOperationMetadata	A Task containing the RPC response.

Overrides

ClusterControllerClient.DiagnoseClusterAsync(DiagnoseClusterRequest, CallSettings)

GetCluster(GetClusterRequest, CallSettings)

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

Gets the resource representation for a cluster in a project.

Parameters
Name	Description
request	GetClusterRequest 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
Cluster	The RPC response.

Overrides

ClusterControllerClient.GetCluster(GetClusterRequest, CallSettings)

GetClusterAsync(GetClusterRequest, CallSettings)

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

Gets the resource representation for a cluster in a project.

Parameters
Name	Description
request	GetClusterRequest 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
TaskCluster	A Task containing the RPC response.

Overrides

ClusterControllerClient.GetClusterAsync(GetClusterRequest, CallSettings)

ListClusters(ListClustersRequest, CallSettings)

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

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

Parameters
Name	Description
request	ListClustersRequest 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
PagedEnumerableListClustersResponseCluster	A pageable sequence of Cluster resources.

Overrides

ClusterControllerClient.ListClusters(ListClustersRequest, CallSettings)

ListClustersAsync(ListClustersRequest, CallSettings)

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

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

Parameters
Name	Description
request	ListClustersRequest 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
PagedAsyncEnumerableListClustersResponseCluster	A pageable asynchronous sequence of Cluster resources.

Overrides

ClusterControllerClient.ListClustersAsync(ListClustersRequest, CallSettings)

StartCluster(StartClusterRequest, CallSettings)

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

Starts a cluster in a project.

Parameters
Name	Description
request	StartClusterRequest 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
OperationClusterClusterOperationMetadata	The RPC response.

Overrides

ClusterControllerClient.StartCluster(StartClusterRequest, CallSettings)

StartClusterAsync(StartClusterRequest, CallSettings)

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

Starts a cluster in a project.

Parameters
Name	Description
request	StartClusterRequest 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
TaskOperationClusterClusterOperationMetadata	A Task containing the RPC response.

Overrides

ClusterControllerClient.StartClusterAsync(StartClusterRequest, CallSettings)

StopCluster(StopClusterRequest, CallSettings)

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

Stops a cluster in a project.

Parameters
Name	Description
request	StopClusterRequest 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
OperationClusterClusterOperationMetadata	The RPC response.

Overrides

ClusterControllerClient.StopCluster(StopClusterRequest, CallSettings)

StopClusterAsync(StopClusterRequest, CallSettings)

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

Stops a cluster in a project.

Parameters
Name	Description
request	StopClusterRequest 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
TaskOperationClusterClusterOperationMetadata	A Task containing the RPC response.

Overrides

ClusterControllerClient.StopClusterAsync(StopClusterRequest, CallSettings)

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
Name	Description
request	UpdateClusterRequest 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
OperationClusterClusterOperationMetadata	The RPC response.

Overrides

ClusterControllerClient.UpdateCluster(UpdateClusterRequest, CallSettings)

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
Name	Description
request	UpdateClusterRequest 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
TaskOperationClusterClusterOperationMetadata	A Task containing the RPC response.

Overrides

ClusterControllerClient.UpdateClusterAsync(UpdateClusterRequest, CallSettings)