Cloud Run Admin v2 API - Class Jobs.JobsClient (2.11.0)

Version latest

• 2.11.0 (latest)
• 2.10.0
• 2.9.0
• 2.8.0
• 2.7.0
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0-beta02

public class Jobs.JobsClient : ClientBase<Jobs.JobsClient>

Reference documentation and code samples for the Cloud Run Admin v2 API class Jobs.JobsClient.

Client for Jobs

Inheritance

object > ClientBase > ClientBaseJobsJobsClient > Jobs.JobsClient

Inherited Members

ClientBase<Jobs.JobsClient>.WithHost(string)

ClientBase.CallInvoker

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Constructors

JobsClient()

protected JobsClient()

Protected parameterless constructor to allow creation of test doubles.

JobsClient(CallInvoker)

public JobsClient(CallInvoker callInvoker)

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

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

JobsClient(ChannelBase)

public JobsClient(ChannelBase channel)

Creates a new client for Jobs

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

JobsClient(ClientBaseConfiguration)

protected JobsClient(ClientBase.ClientBaseConfiguration configuration)

Protected constructor to allow creation of configured clients.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration The client configuration.

Methods

CreateJob(CreateJobRequest, CallOptions)

public virtual Operation CreateJob(CreateJobRequest request, CallOptions options)

Creates a Job.

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

Returns
Type	Description
Operation	The response received from the server.

CreateJob(CreateJobRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Job.

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

CreateJobAsync(CreateJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> CreateJobAsync(CreateJobRequest request, CallOptions options)

Creates a Job.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

CreateJobAsync(CreateJobRequest, Metadata, DateTime?, CancellationToken)

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

Creates a Job.

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

CreateLocationsClient()

public virtual Locations.LocationsClient CreateLocationsClient()

Creates a new instance of Locations.LocationsClient using the same call invoker as this client.

Returns
Type	Description
LocationsLocationsClient	A new Locations.LocationsClient 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 Operation DeleteJob(DeleteJobRequest request, CallOptions options)

Deletes a Job.

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

Returns
Type	Description
Operation	The response received from the server.

DeleteJob(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a Job.

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	System.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.

DeleteJobAsync(DeleteJobRequest, CallOptions)

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

Deletes a Job.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

DeleteJobAsync(DeleteJobRequest, Metadata, DateTime?, CancellationToken)

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

Deletes a Job.

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	System.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.

GetIamPolicy(GetIamPolicyRequest, CallOptions)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, CallOptions options)

Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.

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

Returns
Type	Description
Policy	The response received from the server.

GetIamPolicy(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy GetIamPolicy(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.

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

GetIamPolicyAsync(GetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallOptions options)

Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.

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

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

GetIamPolicyAsync(GetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Gets the IAM Access Control policy currently in effect for the given Job. This result does not include any inherited policies.

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

GetJob(GetJobRequest, CallOptions)

public virtual Job GetJob(GetJobRequest request, CallOptions options)

Gets information about a Job.

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 information about a Job.

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	System.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 information about a Job.

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 information about a Job.

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	System.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 Jobs. Results are sorted by creation time, descending.

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 Jobs. Results are sorted by creation time, descending.

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	System.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 Jobs. Results are sorted by creation time, descending.

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 Jobs. Results are sorted by creation time, descending.

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	System.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 Jobs.JobsClient NewInstance(ClientBase.ClientBaseConfiguration configuration)

Creates a new instance of client from given ClientBaseConfiguration.

Parameter
Name	Description
configuration	ClientBaseClientBaseConfiguration

Returns
Type	Description
JobsJobsClient

Overrides

Grpc.Core.ClientBase<Google.Cloud.Run.V2.Jobs.JobsClient>.NewInstance(Grpc.Core.ClientBase.ClientBaseConfiguration)

RunJob(RunJobRequest, CallOptions)

public virtual Operation RunJob(RunJobRequest request, CallOptions options)

Triggers creation of a new Execution of this Job.

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

Returns
Type	Description
Operation	The response received from the server.

RunJob(RunJobRequest, Metadata, DateTime?, CancellationToken)

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

Triggers creation of a new Execution of this Job.

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

RunJobAsync(RunJobRequest, CallOptions)

public virtual AsyncUnaryCall<Operation> RunJobAsync(RunJobRequest request, CallOptions options)

Triggers creation of a new Execution of this Job.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

RunJobAsync(RunJobRequest, Metadata, DateTime?, CancellationToken)

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

Triggers creation of a new Execution of this Job.

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

SetIamPolicy(SetIamPolicyRequest, CallOptions)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, CallOptions options)

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.

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

Returns
Type	Description
Policy	The response received from the server.

SetIamPolicy(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual Policy SetIamPolicy(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.

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

SetIamPolicyAsync(SetIamPolicyRequest, CallOptions)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallOptions options)

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.

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

Returns
Type	Description
AsyncUnaryCallPolicy	The call object.

SetIamPolicyAsync(SetIamPolicyRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Sets the IAM Access control policy for the specified Job. Overwrites any existing policy.

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

TestIamPermissions(TestIamPermissionsRequest, CallOptions)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallOptions options)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

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

Returns
Type	Description
TestIamPermissionsResponse	The response received from the server.

TestIamPermissions(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

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

TestIamPermissionsAsync(TestIamPermissionsRequest, CallOptions)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallOptions options)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

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

Returns
Type	Description
AsyncUnaryCallTestIamPermissionsResponse	The call object.

TestIamPermissionsAsync(TestIamPermissionsRequest, Metadata, DateTime?, CancellationToken)

public virtual AsyncUnaryCall<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)

Returns permissions that a caller has on the specified Project.

There are no permissions required for making this API call.

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

UpdateJob(UpdateJobRequest, CallOptions)

public virtual Operation UpdateJob(UpdateJobRequest request, CallOptions options)

Updates a Job.

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

Returns
Type	Description
Operation	The response received from the server.

UpdateJob(UpdateJobRequest, Metadata, DateTime?, CancellationToken)

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

Updates a Job.

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	System.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.

UpdateJobAsync(UpdateJobRequest, CallOptions)

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

Updates a Job.

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

Returns
Type	Description
AsyncUnaryCallOperation	The call object.

UpdateJobAsync(UpdateJobRequest, Metadata, DateTime?, CancellationToken)

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

Updates a Job.

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	System.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.