Google Cloud Dataproc v1 API - Class JobController.JobControllerClient (5.11.0)

Version latest

• 5.11.0 (latest)
• 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 class JobController.JobControllerClient : ClientBase<JobController.JobControllerClient>

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

Client for JobController

Inheritance

object > ClientBase > ClientBaseJobControllerJobControllerClient > JobController.JobControllerClient

Inherited Members

ClientBase<JobController.JobControllerClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dataproc.V1

Assembly

Google.Cloud.Dataproc.V1.dll

Constructors

JobControllerClient()

protected JobControllerClient()

Protected parameterless constructor to allow creation of test doubles.

JobControllerClient(CallInvoker)

public JobControllerClient(CallInvoker callInvoker)

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

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

JobControllerClient(ChannelBase)

public JobControllerClient(ChannelBase channel)

Creates a new client for JobController

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

JobControllerClient(ClientBaseConfiguration)

protected JobControllerClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CancelJob(CancelJobRequest, CallOptions)

public virtual Job CancelJob(CancelJobRequest request, CallOptions options)

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

Returns
Type	Description
Job	The response received from the server.

CancelJob(CancelJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Job CancelJob(CancelJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Job	The response received from the server.

CancelJobAsync(CancelJobRequest, CallOptions)

public virtual AsyncUnaryCall<Job> CancelJobAsync(CancelJobRequest request, CallOptions options)

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

Returns
Type	Description
AsyncUnaryCallJob	The call object.

CancelJobAsync(CancelJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Job> CancelJobAsync(CancelJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallJob	The call object.

CreateIAMPolicyClient()

public virtual IAMPolicy.IAMPolicyClient CreateIAMPolicyClient()

Creates a new instance of IAMPolicy.IAMPolicyClient using the same call invoker as this client.

Returns
Type	Description
IAMPolicyIAMPolicyClient	A new IAMPolicy.IAMPolicyClient for the same target as this client.

CreateOperationsClient()

public virtual Operations.OperationsClient CreateOperationsClient()

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

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

DeleteJob(DeleteJobRequest, CallOptions)

public virtual Empty DeleteJob(DeleteJobRequest request, CallOptions options)

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

Returns
Type	Description
Empty	The response received from the server.

DeleteJob(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Empty DeleteJob(DeleteJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Empty	The response received from the server.

DeleteJobAsync(DeleteJobRequest, CallOptions)

public virtual AsyncUnaryCall<Empty> DeleteJobAsync(DeleteJobRequest request, CallOptions options)

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

Returns
Type	Description
AsyncUnaryCallEmpty	The call object.

DeleteJobAsync(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Empty> DeleteJobAsync(DeleteJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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 to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallEmpty	The call object.

GetJob(GetJobRequest, CallOptions)

public virtual Job GetJob(GetJobRequest request, CallOptions options)

Gets the resource representation for a job in a project.

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

Returns
Type	Description
Job	The response received from the server.

GetJob(GetJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Job GetJob(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the resource representation for a job in a project.

Parameters
Name	Description
request	GetJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Job	The response received from the server.

GetJobAsync(GetJobRequest, CallOptions)

public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, CallOptions options)

Gets the resource representation for a job in a project.

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

Returns
Type	Description
AsyncUnaryCallJob	The call object.

GetJobAsync(GetJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Job> GetJobAsync(GetJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the resource representation for a job in a project.

Parameters
Name	Description
request	GetJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallJob	The call object.

ListJobs(ListJobsRequest, CallOptions)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, CallOptions options)

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

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

Returns
Type	Description
ListJobsResponse	The response received from the server.

ListJobs(ListJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual ListJobsResponse ListJobs(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListJobsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
ListJobsResponse	The response received from the server.

ListJobsAsync(ListJobsRequest, CallOptions)

public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, CallOptions options)

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

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

Returns
Type	Description
AsyncUnaryCallListJobsResponse	The call object.

ListJobsAsync(ListJobsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<ListJobsResponse> ListJobsAsync(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

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

Parameters
Name	Description
request	ListJobsRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallListJobsResponse	The call object.

NewInstance(ClientBaseConfiguration)

protected override JobController.JobControllerClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
JobControllerJobControllerClient

Overrides

ClientBase<JobController.JobControllerClient>.NewInstance(ClientBase.ClientBaseConfiguration)

SubmitJob(SubmitJobRequest, CallOptions)

public virtual Job SubmitJob(SubmitJobRequest request, CallOptions options)

Submits a job to a cluster.

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

Returns
Type	Description
Job	The response received from the server.

SubmitJob(SubmitJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Job SubmitJob(SubmitJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Submits a job to a cluster.

Parameters
Name	Description
request	SubmitJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Job	The response received from the server.

SubmitJobAsOperation(SubmitJobRequest, CallOptions)

public virtual Operation SubmitJobAsOperation(SubmitJobRequest request, CallOptions options)

Submits job to a cluster.

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

Returns
Type	Description
Operation	The response received from the server.

SubmitJobAsOperation(SubmitJobRequest, Metadata, DateTime?, CancellationToken)

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

Submits job to a cluster.

Parameters
Name	Description
request	SubmitJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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.

SubmitJobAsOperationAsync(SubmitJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> SubmitJobAsOperationAsync(SubmitJobRequest request, CallOptions options)

Submits job to a cluster.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

SubmitJobAsOperationAsync(SubmitJobRequest, Metadata, DateTime?, CancellationToken)

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

Submits job to a cluster.

Parameters
Name	Description
request	SubmitJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallOperation	The call object.

SubmitJobAsync(SubmitJobRequest, CallOptions)

public virtual AsyncUnaryCall<Job> SubmitJobAsync(SubmitJobRequest request, CallOptions options)

Submits a job to a cluster.

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

Returns
Type	Description
AsyncUnaryCallJob	The call object.

SubmitJobAsync(SubmitJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Job> SubmitJobAsync(SubmitJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Submits a job to a cluster.

Parameters
Name	Description
request	SubmitJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallJob	The call object.

UpdateJob(UpdateJobRequest, CallOptions)

public virtual Job UpdateJob(UpdateJobRequest request, CallOptions options)

Updates a job in a project.

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

Returns
Type	Description
Job	The response received from the server.

UpdateJob(UpdateJobRequest, Metadata, DateTime?, CancellationToken)

public virtual Job UpdateJob(UpdateJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a job in a project.

Parameters
Name	Description
request	UpdateJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
Job	The response received from the server.

UpdateJobAsync(UpdateJobRequest, CallOptions)

public virtual AsyncUnaryCall<Job> UpdateJobAsync(UpdateJobRequest request, CallOptions options)

Updates a job in a project.

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

Returns
Type	Description
AsyncUnaryCallJob	The call object.

UpdateJobAsync(UpdateJobRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Job> UpdateJobAsync(UpdateJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Updates a job in a project.

Parameters
Name	Description
request	UpdateJobRequest The request to send to the server.
headers	Metadata The initial metadata to send with the call. This parameter is optional.
deadline	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
AsyncUnaryCallJob	The call object.