Cloud Run Admin v2 API - Class JobsClientImpl (2.9.0)

public sealed class JobsClientImpl : JobsClient

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

Jobs client wrapper implementation, for convenient use.

Inheritance

object > JobsClient > JobsClientImpl

Namespace

Google.Cloud.Run.V2

Assembly

Google.Cloud.Run.V2.dll

Remarks

Cloud Run Job Control Plane API.

Constructors

JobsClientImpl(JobsClient, JobsSettings, ILogger)

public JobsClientImpl(Jobs.JobsClient grpcClient, JobsSettings settings, ILogger logger)

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

Parameters
Name Description
grpcClient JobsJobsClient

The underlying gRPC client.

settings JobsSettings

The base JobsSettings used within this client.

logger ILogger

Optional ILogger to use within this client.

Properties

CreateJobOperationsClient

public override OperationsClient CreateJobOperationsClient { get; }

The long-running operations client for CreateJob.

Property Value
Type Description
OperationsClient
Overrides

DeleteJobOperationsClient

public override OperationsClient DeleteJobOperationsClient { get; }

The long-running operations client for DeleteJob.

Property Value
Type Description
OperationsClient
Overrides

GrpcClient

public override Jobs.JobsClient GrpcClient { get; }

The underlying gRPC Jobs client

Property Value
Type Description
JobsJobsClient
Overrides

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type Description
LocationsClient
Overrides

RunJobOperationsClient

public override OperationsClient RunJobOperationsClient { get; }

The long-running operations client for RunJob.

Property Value
Type Description
OperationsClient
Overrides

UpdateJobOperationsClient

public override OperationsClient UpdateJobOperationsClient { get; }

The long-running operations client for UpdateJob.

Property Value
Type Description
OperationsClient
Overrides

Methods

CreateJob(CreateJobRequest, CallSettings)

public override Operation<Job, Job> CreateJob(CreateJobRequest request, CallSettings callSettings = null)

Creates a Job.

Parameters
Name Description
request CreateJobRequest

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
OperationJobJob

The RPC response.

Overrides

CreateJobAsync(CreateJobRequest, CallSettings)

public override Task<Operation<Job, Job>> CreateJobAsync(CreateJobRequest request, CallSettings callSettings = null)

Creates a Job.

Parameters
Name Description
request CreateJobRequest

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
TaskOperationJobJob

A Task containing the RPC response.

Overrides

DeleteJob(DeleteJobRequest, CallSettings)

public override Operation<Job, Job> DeleteJob(DeleteJobRequest request, CallSettings callSettings = null)

Deletes a Job.

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
OperationJobJob

The RPC response.

Overrides

DeleteJobAsync(DeleteJobRequest, CallSettings)

public override Task<Operation<Job, Job>> DeleteJobAsync(DeleteJobRequest request, CallSettings callSettings = null)

Deletes a Job.

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
TaskOperationJobJob

A Task containing the RPC response.

Overrides

GetIamPolicy(GetIamPolicyRequest, CallSettings)

public override Policy GetIamPolicy(GetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
Policy

The RPC response.

Overrides

GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

public override Task<Policy> GetIamPolicyAsync(GetIamPolicyRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskPolicy

A Task containing the RPC response.

Overrides

GetJob(GetJobRequest, CallSettings)

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

Gets information about a Job.

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

GetJobAsync(GetJobRequest, CallSettings)

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

Gets information about a Job.

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

ListJobs(ListJobsRequest, CallSettings)

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

Lists Jobs. Results are sorted by creation time, descending.

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

ListJobsAsync(ListJobsRequest, CallSettings)

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

Lists Jobs. Results are sorted by creation time, descending.

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

RunJob(RunJobRequest, CallSettings)

public override Operation<Execution, Execution> RunJob(RunJobRequest request, CallSettings callSettings = null)

Triggers creation of a new Execution of this Job.

Parameters
Name Description
request RunJobRequest

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
OperationExecutionExecution

The RPC response.

Overrides

RunJobAsync(RunJobRequest, CallSettings)

public override Task<Operation<Execution, Execution>> RunJobAsync(RunJobRequest request, CallSettings callSettings = null)

Triggers creation of a new Execution of this Job.

Parameters
Name Description
request RunJobRequest

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
TaskOperationExecutionExecution

A Task containing the RPC response.

Overrides

SetIamPolicy(SetIamPolicyRequest, CallSettings)

public override Policy SetIamPolicy(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetIamPolicyRequest

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
Policy

The RPC response.

Overrides

SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

public override Task<Policy> SetIamPolicyAsync(SetIamPolicyRequest request, CallSettings callSettings = null)

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

Parameters
Name Description
request SetIamPolicyRequest

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
TaskPolicy

A Task containing the RPC response.

Overrides

TestIamPermissions(TestIamPermissionsRequest, CallSettings)

public override TestIamPermissionsResponse TestIamPermissions(TestIamPermissionsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TestIamPermissionsResponse

The RPC response.

Overrides

TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

public override Task<TestIamPermissionsResponse> TestIamPermissionsAsync(TestIamPermissionsRequest request, CallSettings callSettings = null)

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 object containing all of the parameters for the API call.

callSettings CallSettings

If not null, applies overrides to this RPC call.

Returns
Type Description
TaskTestIamPermissionsResponse

A Task containing the RPC response.

Overrides

UpdateJob(UpdateJobRequest, CallSettings)

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

Updates a Job.

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
OperationJobJob

The RPC response.

Overrides

UpdateJobAsync(UpdateJobRequest, CallSettings)

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

Updates a Job.

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
TaskOperationJobJob

A Task containing the RPC response.

Overrides