Google Cloud Dataproc v1 API - Class ClusterController.ClusterControllerClient (5.1.0)

public class ClusterControllerClient : ClientBase<ClusterController.ClusterControllerClient>

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

Client for ClusterController

Inheritance

Object > ClientBase > ClientBase<ClusterController.ClusterControllerClient> > ClusterController.ClusterControllerClient

Inherited Members

ClientBase<ClusterController.ClusterControllerClient>.WithHost(String)

ClientBase.CallInvoker

Object.GetHashCode()

Object.GetType()

Object.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

ClusterControllerClient()

protected ClusterControllerClient()

Protected parameterless constructor to allow creation of test doubles.

ClusterControllerClient(CallInvoker)

public ClusterControllerClient(CallInvoker callInvoker)

Creates a new client for ClusterController that uses a custom CallInvoker.

Parameter
Name	Description
`callInvoker`	`CallInvoker` The callInvoker to use to make remote calls.

ClusterControllerClient(ChannelBase)

public ClusterControllerClient(ChannelBase channel)

Creates a new client for ClusterController

Parameter
Name	Description
`channel`	`ChannelBase` The channel to use to make remote calls.

ClusterControllerClient(ClientBase.ClientBaseConfiguration)

protected ClusterControllerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration` The client configuration.

Methods

CreateCluster(CreateClusterRequest, CallOptions)

public virtual Operation CreateCluster(CreateClusterRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`CreateClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateCluster(CreateClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation CreateCluster(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
`request`	`CreateClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

CreateClusterAsync(CreateClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`CreateClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

CreateClusterAsync(CreateClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> CreateClusterAsync(CreateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
`request`	`CreateClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

Creates a new instance of Operations.OperationsClient using the same call invoker as this client.

Returns
Type	Description
`Operations.OperationsClient`	A new Operations client for the same target as this client.

DeleteCluster(DeleteClusterRequest, CallOptions)

public virtual Operation DeleteCluster(DeleteClusterRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`DeleteClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteCluster(DeleteClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DeleteCluster(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
`request`	`DeleteClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

DeleteClusterAsync(DeleteClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`DeleteClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

DeleteClusterAsync(DeleteClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DeleteClusterAsync(DeleteClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
`request`	`DeleteClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

DiagnoseCluster(DiagnoseClusterRequest, CallOptions)

public virtual Operation DiagnoseCluster(DiagnoseClusterRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

DiagnoseCluster(DiagnoseClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation DiagnoseCluster(DiagnoseClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`DiagnoseClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

DiagnoseClusterAsync(DiagnoseClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> DiagnoseClusterAsync(DiagnoseClusterRequest request, CallOptions options)

Parameters
Name	Description
`request`	`DiagnoseClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

DiagnoseClusterAsync(DiagnoseClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> DiagnoseClusterAsync(DiagnoseClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`DiagnoseClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

GetCluster(GetClusterRequest, CallOptions)

public virtual Cluster GetCluster(GetClusterRequest request, CallOptions options)

Gets the resource representation for a cluster in a project.

Parameters
Name	Description
`request`	`GetClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Cluster`	The response received from the server.

GetCluster(GetClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Cluster GetCluster(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the resource representation for a cluster in a project.

Parameters
Name	Description
`request`	`GetClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Cluster`	The response received from the server.

GetClusterAsync(GetClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, CallOptions options)

Gets the resource representation for a cluster in a project.

Parameters
Name	Description
`request`	`GetClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Cluster>`	The call object.

GetClusterAsync(GetClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Cluster> GetClusterAsync(GetClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Gets the resource representation for a cluster in a project.

Parameters
Name	Description
`request`	`GetClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Cluster>`	The call object.

ListClusters(ListClustersRequest, CallOptions)

public virtual ListClustersResponse ListClusters(ListClustersRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`ListClustersRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`ListClustersResponse`	The response received from the server.

ListClusters(ListClustersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual ListClustersResponse ListClusters(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
`request`	`ListClustersRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`ListClustersResponse`	The response received from the server.

ListClustersAsync(ListClustersRequest, CallOptions)

public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, CallOptions options)

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

Parameters
Name	Description
`request`	`ListClustersRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<ListClustersResponse>`	The call object.

ListClustersAsync(ListClustersRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<ListClustersResponse> ListClustersAsync(ListClustersRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

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

Parameters
Name	Description
`request`	`ListClustersRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<ListClustersResponse>`	The call object.

NewInstance(ClientBase.ClientBaseConfiguration)

protected override ClusterController.ClusterControllerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
`configuration`	`ClientBase.ClientBaseConfiguration`

Returns
Type	Description
`ClusterController.ClusterControllerClient`

Overrides

Grpc.Core.ClientBase<Google.Cloud.Dataproc.V1.ClusterController.ClusterControllerClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

StartCluster(StartClusterRequest, CallOptions)

public virtual Operation StartCluster(StartClusterRequest request, CallOptions options)

Starts a cluster in a project.

Parameters
Name	Description
`request`	`StartClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

StartCluster(StartClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StartCluster(StartClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Starts a cluster in a project.

Parameters
Name	Description
`request`	`StartClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

StartClusterAsync(StartClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StartClusterAsync(StartClusterRequest request, CallOptions options)

Starts a cluster in a project.

Parameters
Name	Description
`request`	`StartClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

StartClusterAsync(StartClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StartClusterAsync(StartClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Starts a cluster in a project.

Parameters
Name	Description
`request`	`StartClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

StopCluster(StopClusterRequest, CallOptions)

public virtual Operation StopCluster(StopClusterRequest request, CallOptions options)

Stops a cluster in a project.

Parameters
Name	Description
`request`	`StopClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

StopCluster(StopClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation StopCluster(StopClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Stops a cluster in a project.

Parameters
Name	Description
`request`	`StopClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

StopClusterAsync(StopClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> StopClusterAsync(StopClusterRequest request, CallOptions options)

Stops a cluster in a project.

Parameters
Name	Description
`request`	`StopClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

StopClusterAsync(StopClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> StopClusterAsync(StopClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Stops a cluster in a project.

Parameters
Name	Description
`request`	`StopClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

UpdateCluster(UpdateClusterRequest, CallOptions)

public virtual Operation UpdateCluster(UpdateClusterRequest request, CallOptions options)

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 to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateCluster(UpdateClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual Operation UpdateCluster(UpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`UpdateClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`Operation`	The response received from the server.

UpdateClusterAsync(UpdateClusterRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(UpdateClusterRequest request, CallOptions options)

Parameters
Name	Description
`request`	`UpdateClusterRequest` The request to send to the server.
`options`	`CallOptions` The options for the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.

UpdateClusterAsync(UpdateClusterRequest, Metadata, Nullable<DateTime>, CancellationToken)

public virtual AsyncUnaryCall<Operation> UpdateClusterAsync(UpdateClusterRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default(CancellationToken))

Parameters
Name	Description
`request`	`UpdateClusterRequest` The request to send to the server.
`headers`	`Metadata` The initial metadata to send with the call. This parameter is optional.
`deadline`	`Nullable<DateTime>` An optional deadline for the call. The call will be cancelled if deadline is hit.
`cancellationToken`	`CancellationToken` An optional token for canceling the call.

Returns
Type	Description
`AsyncUnaryCall<Operation>`	The call object.