Cloud Run Admin v2 API - Class JobsClientImpl (2.8.0)

Version latest

• 2.8.0 (latest)
• 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 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

Inherited Members

JobsClient.DefaultEndpoint

JobsClient.DefaultScopes

JobsClient.ServiceMetadata

JobsClient.CreateAsync(CancellationToken)

JobsClient.Create()

JobsClient.ShutdownDefaultChannelsAsync()

JobsClient.CreateJobAsync(CreateJobRequest, CancellationToken)

JobsClient.PollOnceCreateJob(string, CallSettings)

JobsClient.PollOnceCreateJobAsync(string, CallSettings)

JobsClient.CreateJob(string, Job, string, CallSettings)

JobsClient.CreateJobAsync(string, Job, string, CallSettings)

JobsClient.CreateJobAsync(string, Job, string, CancellationToken)

JobsClient.CreateJob(LocationName, Job, string, CallSettings)

JobsClient.CreateJobAsync(LocationName, Job, string, CallSettings)

JobsClient.CreateJobAsync(LocationName, Job, string, CancellationToken)

JobsClient.GetJobAsync(GetJobRequest, CancellationToken)

JobsClient.GetJob(string, CallSettings)

JobsClient.GetJobAsync(string, CallSettings)

JobsClient.GetJobAsync(string, CancellationToken)

JobsClient.GetJob(JobName, CallSettings)

JobsClient.GetJobAsync(JobName, CallSettings)

JobsClient.GetJobAsync(JobName, CancellationToken)

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

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

JobsClient.ListJobs(LocationName, string, int?, CallSettings)

JobsClient.ListJobsAsync(LocationName, string, int?, CallSettings)

JobsClient.UpdateJobAsync(UpdateJobRequest, CancellationToken)

JobsClient.PollOnceUpdateJob(string, CallSettings)

JobsClient.PollOnceUpdateJobAsync(string, CallSettings)

JobsClient.UpdateJob(Job, CallSettings)

JobsClient.UpdateJobAsync(Job, CallSettings)

JobsClient.UpdateJobAsync(Job, CancellationToken)

JobsClient.DeleteJobAsync(DeleteJobRequest, CancellationToken)

JobsClient.PollOnceDeleteJob(string, CallSettings)

JobsClient.PollOnceDeleteJobAsync(string, CallSettings)

JobsClient.DeleteJob(string, CallSettings)

JobsClient.DeleteJobAsync(string, CallSettings)

JobsClient.DeleteJobAsync(string, CancellationToken)

JobsClient.DeleteJob(JobName, CallSettings)

JobsClient.DeleteJobAsync(JobName, CallSettings)

JobsClient.DeleteJobAsync(JobName, CancellationToken)

JobsClient.RunJobAsync(RunJobRequest, CancellationToken)

JobsClient.PollOnceRunJob(string, CallSettings)

JobsClient.PollOnceRunJobAsync(string, CallSettings)

JobsClient.RunJob(string, CallSettings)

JobsClient.RunJobAsync(string, CallSettings)

JobsClient.RunJobAsync(string, CancellationToken)

JobsClient.RunJob(JobName, CallSettings)

JobsClient.RunJobAsync(JobName, CallSettings)

JobsClient.RunJobAsync(JobName, CancellationToken)

JobsClient.GetIamPolicyAsync(GetIamPolicyRequest, CancellationToken)

JobsClient.SetIamPolicyAsync(SetIamPolicyRequest, CancellationToken)

JobsClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CancellationToken)

object.GetHashCode()

object.GetType()

object.ToString()

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

JobsClient.CreateJobOperationsClient

DeleteJobOperationsClient

public override OperationsClient DeleteJobOperationsClient { get; }

The long-running operations client for DeleteJob.

Property Value
Type	Description
OperationsClient

Overrides

JobsClient.DeleteJobOperationsClient

GrpcClient

public override Jobs.JobsClient GrpcClient { get; }

The underlying gRPC Jobs client

Property Value
Type	Description
JobsJobsClient

Overrides

JobsClient.GrpcClient

LocationsClient

public override LocationsClient LocationsClient { get; }

The LocationsClient associated with this client.

Property Value
Type	Description
LocationsClient

Overrides

JobsClient.LocationsClient

RunJobOperationsClient

public override OperationsClient RunJobOperationsClient { get; }

The long-running operations client for RunJob.

Property Value
Type	Description
OperationsClient

Overrides

JobsClient.RunJobOperationsClient

UpdateJobOperationsClient

public override OperationsClient UpdateJobOperationsClient { get; }

The long-running operations client for UpdateJob.

Property Value
Type	Description
OperationsClient

Overrides

JobsClient.UpdateJobOperationsClient

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

JobsClient.CreateJob(CreateJobRequest, CallSettings)

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

JobsClient.CreateJobAsync(CreateJobRequest, CallSettings)

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

JobsClient.DeleteJob(DeleteJobRequest, CallSettings)

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

JobsClient.DeleteJobAsync(DeleteJobRequest, CallSettings)

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

JobsClient.GetIamPolicy(GetIamPolicyRequest, CallSettings)

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

JobsClient.GetIamPolicyAsync(GetIamPolicyRequest, CallSettings)

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

JobsClient.GetJob(GetJobRequest, CallSettings)

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

JobsClient.GetJobAsync(GetJobRequest, CallSettings)

ListJobs(ListJobsRequest, CallSettings)

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

Lists Jobs.

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

JobsClient.ListJobs(ListJobsRequest, CallSettings)

ListJobsAsync(ListJobsRequest, CallSettings)

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

Lists Jobs.

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

JobsClient.ListJobsAsync(ListJobsRequest, CallSettings)

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

JobsClient.RunJob(RunJobRequest, CallSettings)

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

JobsClient.RunJobAsync(RunJobRequest, CallSettings)

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

JobsClient.SetIamPolicy(SetIamPolicyRequest, CallSettings)

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

JobsClient.SetIamPolicyAsync(SetIamPolicyRequest, CallSettings)

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

JobsClient.TestIamPermissions(TestIamPermissionsRequest, CallSettings)

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

JobsClient.TestIamPermissionsAsync(TestIamPermissionsRequest, CallSettings)

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

JobsClient.UpdateJob(UpdateJobRequest, CallSettings)

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

JobsClient.UpdateJobAsync(UpdateJobRequest, CallSettings)