public sealed class JobsV1Beta3ClientImpl : JobsV1Beta3Client
Reference documentation and code samples for the Dataflow v1beta3 API class JobsV1Beta3ClientImpl.
JobsV1Beta3 client wrapper implementation, for convenient use.
Namespace
Google.Cloud.Dataflow.V1Beta3Assembly
Google.Cloud.Dataflow.V1Beta3.dll
Remarks
Provides a method to create and modify Google Cloud Dataflow jobs. A Job is a multi-stage computation graph run by the Cloud Dataflow service.
Constructors
JobsV1Beta3ClientImpl(JobsV1Beta3Client, JobsV1Beta3Settings, ILogger)
public JobsV1Beta3ClientImpl(JobsV1Beta3.JobsV1Beta3Client grpcClient, JobsV1Beta3Settings settings, ILogger logger)
Constructs a client wrapper for the JobsV1Beta3 service, with the specified gRPC client and settings.
Parameters | |
---|---|
Name | Description |
grpcClient |
JobsV1Beta3JobsV1Beta3Client The underlying gRPC client. |
settings |
JobsV1Beta3Settings The base JobsV1Beta3Settings used within this client. |
logger |
ILogger Optional ILogger to use within this client. |
Properties
GrpcClient
public override JobsV1Beta3.JobsV1Beta3Client GrpcClient { get; }
The underlying gRPC JobsV1Beta3 client
Property Value | |
---|---|
Type | Description |
JobsV1Beta3JobsV1Beta3Client |
Methods
AggregatedListJobs(ListJobsRequest, CallSettings)
public override PagedEnumerable<ListJobsResponse, Job> AggregatedListJobs(ListJobsRequest request, CallSettings callSettings = null)
List the jobs of a project across all regions.
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. |
AggregatedListJobsAsync(ListJobsRequest, CallSettings)
public override PagedAsyncEnumerable<ListJobsResponse, Job> AggregatedListJobsAsync(ListJobsRequest request, CallSettings callSettings = null)
List the jobs of a project across all regions.
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. |
CheckActiveJobs(CheckActiveJobsRequest, CallSettings)
public override CheckActiveJobsResponse CheckActiveJobs(CheckActiveJobsRequest request, CallSettings callSettings = null)
Check for existence of active jobs in the given project across all regions.
Parameters | |
---|---|
Name | Description |
request |
CheckActiveJobsRequest 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 |
CheckActiveJobsResponse |
The RPC response. |
CheckActiveJobsAsync(CheckActiveJobsRequest, CallSettings)
public override Task<CheckActiveJobsResponse> CheckActiveJobsAsync(CheckActiveJobsRequest request, CallSettings callSettings = null)
Check for existence of active jobs in the given project across all regions.
Parameters | |
---|---|
Name | Description |
request |
CheckActiveJobsRequest 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 |
TaskCheckActiveJobsResponse |
A Task containing the RPC response. |
CreateJob(CreateJobRequest, CallSettings)
public override Job CreateJob(CreateJobRequest request, CallSettings callSettings = null)
Creates a Cloud Dataflow job.
To create a job, we recommend using projects.locations.jobs.create
with a
regional endpoint. Using
projects.jobs.create
is not recommended, as your job will always start
in us-central1
.
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 |
Job |
The RPC response. |
CreateJobAsync(CreateJobRequest, CallSettings)
public override Task<Job> CreateJobAsync(CreateJobRequest request, CallSettings callSettings = null)
Creates a Cloud Dataflow job.
To create a job, we recommend using projects.locations.jobs.create
with a
regional endpoint. Using
projects.jobs.create
is not recommended, as your job will always start
in us-central1
.
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 |
TaskJob |
A Task containing the RPC response. |
GetJob(GetJobRequest, CallSettings)
public override Job GetJob(GetJobRequest request, CallSettings callSettings = null)
Gets the state of the specified Cloud Dataflow job.
To get the state of a job, we recommend using projects.locations.jobs.get
with a regional endpoint. Using
projects.jobs.get
is not recommended, as you can only get the state of
jobs that are running in us-central1
.
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. |
GetJobAsync(GetJobRequest, CallSettings)
public override Task<Job> GetJobAsync(GetJobRequest request, CallSettings callSettings = null)
Gets the state of the specified Cloud Dataflow job.
To get the state of a job, we recommend using projects.locations.jobs.get
with a regional endpoint. Using
projects.jobs.get
is not recommended, as you can only get the state of
jobs that are running in us-central1
.
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. |
ListJobs(ListJobsRequest, CallSettings)
public override PagedEnumerable<ListJobsResponse, Job> ListJobs(ListJobsRequest request, CallSettings callSettings = null)
List the jobs of a project.
To list the jobs of a project in a region, we recommend using
projects.locations.jobs.list
with a regional endpoint. To
list the all jobs across all regions, use projects.jobs.aggregated
. Using
projects.jobs.list
is not recommended, as you can only get the list of
jobs that are running in us-central1
.
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. |
ListJobsAsync(ListJobsRequest, CallSettings)
public override PagedAsyncEnumerable<ListJobsResponse, Job> ListJobsAsync(ListJobsRequest request, CallSettings callSettings = null)
List the jobs of a project.
To list the jobs of a project in a region, we recommend using
projects.locations.jobs.list
with a regional endpoint. To
list the all jobs across all regions, use projects.jobs.aggregated
. Using
projects.jobs.list
is not recommended, as you can only get the list of
jobs that are running in us-central1
.
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. |
SnapshotJob(SnapshotJobRequest, CallSettings)
public override Snapshot SnapshotJob(SnapshotJobRequest request, CallSettings callSettings = null)
Snapshot the state of a streaming job.
Parameters | |
---|---|
Name | Description |
request |
SnapshotJobRequest 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 |
Snapshot |
The RPC response. |
SnapshotJobAsync(SnapshotJobRequest, CallSettings)
public override Task<Snapshot> SnapshotJobAsync(SnapshotJobRequest request, CallSettings callSettings = null)
Snapshot the state of a streaming job.
Parameters | |
---|---|
Name | Description |
request |
SnapshotJobRequest 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 |
TaskSnapshot |
A Task containing the RPC response. |
UpdateJob(UpdateJobRequest, CallSettings)
public override Job UpdateJob(UpdateJobRequest request, CallSettings callSettings = null)
Updates the state of an existing Cloud Dataflow job.
To update the state of an existing job, we recommend using
projects.locations.jobs.update
with a regional endpoint. Using
projects.jobs.update
is not recommended, as you can only update the state
of jobs that are running in us-central1
.
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. |
UpdateJobAsync(UpdateJobRequest, CallSettings)
public override Task<Job> UpdateJobAsync(UpdateJobRequest request, CallSettings callSettings = null)
Updates the state of an existing Cloud Dataflow job.
To update the state of an existing job, we recommend using
projects.locations.jobs.update
with a regional endpoint. Using
projects.jobs.update
is not recommended, as you can only update the state
of jobs that are running in us-central1
.
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 |
TaskJob |
A Task containing the RPC response. |