Google Cloud Dataproc v1 API - Class JobControllerClientImpl (5.10.0)

public sealed class JobControllerClientImpl : JobControllerClient

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

JobController client wrapper implementation, for convenient use.

Inheritance

object > JobControllerClient > JobControllerClientImpl

Inherited Members

JobControllerClient.DefaultEndpoint

JobControllerClient.DefaultScopes

JobControllerClient.ServiceMetadata

JobControllerClient.CreateAsync(CancellationToken)

JobControllerClient.Create()

JobControllerClient.ShutdownDefaultChannelsAsync()

JobControllerClient.SubmitJobAsync(SubmitJobRequest, CancellationToken)

JobControllerClient.SubmitJob(string, string, Job, CallSettings)

JobControllerClient.SubmitJobAsync(string, string, Job, CallSettings)

JobControllerClient.SubmitJobAsync(string, string, Job, CancellationToken)

JobControllerClient.SubmitJobAsOperationAsync(SubmitJobRequest, CancellationToken)

JobControllerClient.PollOnceSubmitJobAsOperation(string, CallSettings)

JobControllerClient.PollOnceSubmitJobAsOperationAsync(string, CallSettings)

JobControllerClient.SubmitJobAsOperation(string, string, Job, CallSettings)

JobControllerClient.SubmitJobAsOperationAsync(string, string, Job, CallSettings)

JobControllerClient.SubmitJobAsOperationAsync(string, string, Job, CancellationToken)

JobControllerClient.GetJobAsync(GetJobRequest, CancellationToken)

JobControllerClient.GetJob(string, string, string, CallSettings)

JobControllerClient.GetJobAsync(string, string, string, CallSettings)

JobControllerClient.GetJobAsync(string, string, string, CancellationToken)

JobControllerClient.ListJobs(string, string, string, int?, CallSettings)

JobControllerClient.ListJobsAsync(string, string, string, int?, CallSettings)

JobControllerClient.ListJobs(string, string, string, string, int?, CallSettings)

JobControllerClient.ListJobsAsync(string, string, string, string, int?, CallSettings)

JobControllerClient.UpdateJobAsync(UpdateJobRequest, CancellationToken)

JobControllerClient.CancelJobAsync(CancelJobRequest, CancellationToken)

JobControllerClient.CancelJob(string, string, string, CallSettings)

JobControllerClient.CancelJobAsync(string, string, string, CallSettings)

JobControllerClient.CancelJobAsync(string, string, string, CancellationToken)

JobControllerClient.DeleteJobAsync(DeleteJobRequest, CancellationToken)

JobControllerClient.DeleteJob(string, string, string, CallSettings)

JobControllerClient.DeleteJobAsync(string, string, string, CallSettings)

JobControllerClient.DeleteJobAsync(string, string, string, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Remarks

The JobController provides methods to manage jobs.

Constructors

JobControllerClientImpl(JobControllerClient, JobControllerSettings, ILogger)

public JobControllerClientImpl(JobController.JobControllerClient grpcClient, JobControllerSettings settings, ILogger logger)

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

Parameters
Name	Description
`grpcClient`	`JobControllerJobControllerClient` The underlying gRPC client.
`settings`	`JobControllerSettings` The base JobControllerSettings used within this client.
`logger`	`ILogger` Optional ILogger to use within this client.

Properties

GrpcClient

public override JobController.JobControllerClient GrpcClient { get; }

The underlying gRPC JobController client

Property Value
Type	Description
`JobControllerJobControllerClient`

Overrides

JobControllerClient.GrpcClient

IAMPolicyClient

public override IAMPolicyClient IAMPolicyClient { get; }

The IAMPolicyClient associated with this client.

Property Value
Type	Description
`IAMPolicyClient`

Overrides

JobControllerClient.IAMPolicyClient

SubmitJobAsOperationOperationsClient

public override OperationsClient SubmitJobAsOperationOperationsClient { get; }

The long-running operations client for SubmitJobAsOperation.

Property Value
Type	Description
`OperationsClient`

Overrides

JobControllerClient.SubmitJobAsOperationOperationsClient

Methods

CancelJob(CancelJobRequest, CallSettings)

public override Job CancelJob(CancelJobRequest request, CallSettings callSettings = null)

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

Parameters
Name	Description
`request`	`CancelJobRequest` 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
`Job`	The RPC response.

Overrides

JobControllerClient.CancelJob(CancelJobRequest, CallSettings)

CancelJobAsync(CancelJobRequest, CallSettings)

public override Task<Job> CancelJobAsync(CancelJobRequest request, CallSettings callSettings = null)

Starts a job cancellation request. To access the job resource after cancellation, call regions/{region}/jobs.list or regions/{region}/jobs.get.

Parameters
Name	Description
`request`	`CancelJobRequest` 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
`TaskJob`	A Task containing the RPC response.

Overrides

JobControllerClient.CancelJobAsync(CancelJobRequest, CallSettings)

DeleteJob(DeleteJobRequest, CallSettings)

public override void DeleteJob(DeleteJobRequest request, CallSettings callSettings = null)

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Parameters
Name	Description
`request`	`DeleteJobRequest` The request object containing all of the parameters for the API call.
`callSettings`	`CallSettings` If not null, applies overrides to this RPC call.

Overrides

JobControllerClient.DeleteJob(DeleteJobRequest, CallSettings)

DeleteJobAsync(DeleteJobRequest, CallSettings)

public override Task DeleteJobAsync(DeleteJobRequest request, CallSettings callSettings = null)

Deletes the job from the project. If the job is active, the delete fails, and the response returns FAILED_PRECONDITION.

Parameters
Name	Description
`request`	`DeleteJobRequest` 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

JobControllerClient.DeleteJobAsync(DeleteJobRequest, CallSettings)

GetJob(GetJobRequest, CallSettings)

public override Job GetJob(GetJobRequest request, CallSettings callSettings = null)

Gets the resource representation for a job in a project.

Parameters
Name	Description
`request`	`GetJobRequest` 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
`Job`	The RPC response.

Overrides

JobControllerClient.GetJob(GetJobRequest, CallSettings)

GetJobAsync(GetJobRequest, CallSettings)

public override Task<Job> GetJobAsync(GetJobRequest request, CallSettings callSettings = null)

Gets the resource representation for a job in a project.

Parameters
Name	Description
`request`	`GetJobRequest` 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
`TaskJob`	A Task containing the RPC response.

Overrides

JobControllerClient.GetJobAsync(GetJobRequest, CallSettings)

ListJobs(ListJobsRequest, CallSettings)

public override PagedEnumerable<ListJobsResponse, Job> ListJobs(ListJobsRequest request, CallSettings callSettings = null)

Lists regions/{region}/jobs in a project.

Parameters
Name	Description
`request`	`ListJobsRequest` 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
`PagedEnumerableListJobsResponseJob`	A pageable sequence of Job resources.

Overrides

JobControllerClient.ListJobs(ListJobsRequest, CallSettings)

ListJobsAsync(ListJobsRequest, CallSettings)

public override PagedAsyncEnumerable<ListJobsResponse, Job> ListJobsAsync(ListJobsRequest request, CallSettings callSettings = null)

Lists regions/{region}/jobs in a project.

Parameters
Name	Description
`request`	`ListJobsRequest` 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
`PagedAsyncEnumerableListJobsResponseJob`	A pageable asynchronous sequence of Job resources.

Overrides

JobControllerClient.ListJobsAsync(ListJobsRequest, CallSettings)

SubmitJob(SubmitJobRequest, CallSettings)

public override Job SubmitJob(SubmitJobRequest request, CallSettings callSettings = null)

Submits a job to a cluster.

Parameters
Name	Description
`request`	`SubmitJobRequest` 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
`Job`	The RPC response.

Overrides

JobControllerClient.SubmitJob(SubmitJobRequest, CallSettings)

SubmitJobAsOperation(SubmitJobRequest, CallSettings)

public override Operation<Job, JobMetadata> SubmitJobAsOperation(SubmitJobRequest request, CallSettings callSettings = null)

Submits job to a cluster.

Parameters
Name	Description
`request`	`SubmitJobRequest` 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
`OperationJobJobMetadata`	The RPC response.

Overrides

JobControllerClient.SubmitJobAsOperation(SubmitJobRequest, CallSettings)

SubmitJobAsOperationAsync(SubmitJobRequest, CallSettings)

public override Task<Operation<Job, JobMetadata>> SubmitJobAsOperationAsync(SubmitJobRequest request, CallSettings callSettings = null)

Submits job to a cluster.

Parameters
Name	Description
`request`	`SubmitJobRequest` 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
`TaskOperationJobJobMetadata`	A Task containing the RPC response.

Overrides

JobControllerClient.SubmitJobAsOperationAsync(SubmitJobRequest, CallSettings)

SubmitJobAsync(SubmitJobRequest, CallSettings)

public override Task<Job> SubmitJobAsync(SubmitJobRequest request, CallSettings callSettings = null)

Submits a job to a cluster.

Parameters
Name	Description
`request`	`SubmitJobRequest` 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
`TaskJob`	A Task containing the RPC response.

Overrides

JobControllerClient.SubmitJobAsync(SubmitJobRequest, CallSettings)

UpdateJob(UpdateJobRequest, CallSettings)

public override Job UpdateJob(UpdateJobRequest request, CallSettings callSettings = null)

Updates a job in a project.

Parameters
Name	Description
`request`	`UpdateJobRequest` 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
`Job`	The RPC response.

Overrides

JobControllerClient.UpdateJob(UpdateJobRequest, CallSettings)

UpdateJobAsync(UpdateJobRequest, CallSettings)

public override Task<Job> UpdateJobAsync(UpdateJobRequest request, CallSettings callSettings = null)

Updates a job in a project.

Parameters
Name	Description
`request`	`UpdateJobRequest` 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
`TaskJob`	A Task containing the RPC response.

Overrides

JobControllerClient.UpdateJobAsync(UpdateJobRequest, CallSettings)