Google Cloud Dataproc v1 API - Class JobControllerClientImpl (5.2.0)

Version 5.2.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 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, Nullable<Int32>, CallSettings)

JobControllerClient.ListJobsAsync(String, String, String, Nullable<Int32>, CallSettings)

JobControllerClient.ListJobs(String, String, String, String, Nullable<Int32>, CallSettings)

JobControllerClient.ListJobsAsync(String, String, String, String, Nullable<Int32>, 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.MemberwiseClone()

Object.ToString()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Remarks

The JobController provides methods to manage jobs.

Constructors

JobControllerClientImpl(JobController.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	JobController.JobControllerClient 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
JobController.JobControllerClient

Overrides

JobControllerClient.GrpcClient

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
Task<Job>	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
Task<Job>	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
PagedEnumerable<ListJobsResponse, Job>	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
PagedAsyncEnumerable<ListJobsResponse, Job>	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
Operation<Job, JobMetadata>	The RPC response.

Overrides

JobControllerClient.SubmitJobAsOperation(SubmitJobRequest, CallSettings)

SubmitJobAsOperationAsync(SubmitJobRequest, CallSettings)

public override async 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
Task<Operation<Job, JobMetadata>>	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
Task<Job>	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
Task<Job>	A Task containing the RPC response.

Overrides

JobControllerClient.UpdateJobAsync(UpdateJobRequest, CallSettings)