public class JobsV1Beta3.JobsV1Beta3Client : ClientBase<JobsV1Beta3.JobsV1Beta3Client>
Reference documentation and code samples for the Dataflow v1beta3 API class JobsV1Beta3.JobsV1Beta3Client.
Client for JobsV1Beta3
Inheritance
object > ClientBase > ClientBaseJobsV1Beta3JobsV1Beta3Client > JobsV1Beta3.JobsV1Beta3ClientNamespace
Google.Cloud.Dataflow.V1Beta3Assembly
Google.Cloud.Dataflow.V1Beta3.dll
Constructors
JobsV1Beta3Client()
protected JobsV1Beta3Client()
Protected parameterless constructor to allow creation of test doubles.
JobsV1Beta3Client(CallInvoker)
public JobsV1Beta3Client(CallInvoker callInvoker)
Creates a new client for JobsV1Beta3 that uses a custom CallInvoker
.
Parameter | |
---|---|
Name | Description |
callInvoker |
CallInvoker The callInvoker to use to make remote calls. |
JobsV1Beta3Client(ChannelBase)
public JobsV1Beta3Client(ChannelBase channel)
Creates a new client for JobsV1Beta3
Parameter | |
---|---|
Name | Description |
channel |
ChannelBase The channel to use to make remote calls. |
JobsV1Beta3Client(ClientBaseConfiguration)
protected JobsV1Beta3Client(ClientBase.ClientBaseConfiguration configuration)
Protected constructor to allow creation of configured clients.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration The client configuration. |
Methods
AggregatedListJobs(ListJobsRequest, CallOptions)
public virtual ListJobsResponse AggregatedListJobs(ListJobsRequest request, CallOptions options)
List the jobs of a project across all regions.
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. |
AggregatedListJobs(ListJobsRequest, Metadata, DateTime?, CancellationToken)
public virtual ListJobsResponse AggregatedListJobs(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List the jobs of a project across all regions.
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. |
AggregatedListJobsAsync(ListJobsRequest, CallOptions)
public virtual AsyncUnaryCall<ListJobsResponse> AggregatedListJobsAsync(ListJobsRequest request, CallOptions options)
List the jobs of a project across all regions.
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. |
AggregatedListJobsAsync(ListJobsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<ListJobsResponse> AggregatedListJobsAsync(ListJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
List the jobs of a project across all regions.
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. |
CheckActiveJobs(CheckActiveJobsRequest, CallOptions)
public virtual CheckActiveJobsResponse CheckActiveJobs(CheckActiveJobsRequest request, CallOptions options)
Check for existence of active jobs in the given project across all regions.
Parameters | |
---|---|
Name | Description |
request |
CheckActiveJobsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
CheckActiveJobsResponse |
The response received from the server. |
CheckActiveJobs(CheckActiveJobsRequest, Metadata, DateTime?, CancellationToken)
public virtual CheckActiveJobsResponse CheckActiveJobs(CheckActiveJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Check for existence of active jobs in the given project across all regions.
Parameters | |
---|---|
Name | Description |
request |
CheckActiveJobsRequest 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 |
CheckActiveJobsResponse |
The response received from the server. |
CheckActiveJobsAsync(CheckActiveJobsRequest, CallOptions)
public virtual AsyncUnaryCall<CheckActiveJobsResponse> CheckActiveJobsAsync(CheckActiveJobsRequest request, CallOptions options)
Check for existence of active jobs in the given project across all regions.
Parameters | |
---|---|
Name | Description |
request |
CheckActiveJobsRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallCheckActiveJobsResponse |
The call object. |
CheckActiveJobsAsync(CheckActiveJobsRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<CheckActiveJobsResponse> CheckActiveJobsAsync(CheckActiveJobsRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Check for existence of active jobs in the given project across all regions.
Parameters | |
---|---|
Name | Description |
request |
CheckActiveJobsRequest 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 |
AsyncUnaryCallCheckActiveJobsResponse |
The call object. |
CreateJob(CreateJobRequest, CallOptions)
public virtual Job CreateJob(CreateJobRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Job |
The response received from the server. |
CreateJob(CreateJobRequest, Metadata, DateTime?, CancellationToken)
public virtual Job CreateJob(CreateJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 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. |
CreateJobAsync(CreateJobRequest, CallOptions)
public virtual AsyncUnaryCall<Job> CreateJobAsync(CreateJobRequest request, CallOptions options)
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 to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallJob |
The call object. |
CreateJobAsync(CreateJobRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Job> CreateJobAsync(CreateJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
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 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. |
GetJob(GetJobRequest, CallOptions)
public virtual Job GetJob(GetJobRequest request, CallOptions options)
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 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 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 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 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 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 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 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)
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 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)
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 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)
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 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)
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 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 JobsV1Beta3.JobsV1Beta3Client NewInstance(ClientBase.ClientBaseConfiguration configuration)
Creates a new instance of client from given ClientBaseConfiguration
.
Parameter | |
---|---|
Name | Description |
configuration |
ClientBaseClientBaseConfiguration |
Returns | |
---|---|
Type | Description |
JobsV1Beta3JobsV1Beta3Client |
SnapshotJob(SnapshotJobRequest, CallOptions)
public virtual Snapshot SnapshotJob(SnapshotJobRequest request, CallOptions options)
Snapshot the state of a streaming job.
Parameters | |
---|---|
Name | Description |
request |
SnapshotJobRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
Snapshot |
The response received from the server. |
SnapshotJob(SnapshotJobRequest, Metadata, DateTime?, CancellationToken)
public virtual Snapshot SnapshotJob(SnapshotJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Snapshot the state of a streaming job.
Parameters | |
---|---|
Name | Description |
request |
SnapshotJobRequest 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 |
Snapshot |
The response received from the server. |
SnapshotJobAsync(SnapshotJobRequest, CallOptions)
public virtual AsyncUnaryCall<Snapshot> SnapshotJobAsync(SnapshotJobRequest request, CallOptions options)
Snapshot the state of a streaming job.
Parameters | |
---|---|
Name | Description |
request |
SnapshotJobRequest The request to send to the server. |
options |
CallOptions The options for the call. |
Returns | |
---|---|
Type | Description |
AsyncUnaryCallSnapshot |
The call object. |
SnapshotJobAsync(SnapshotJobRequest, Metadata, DateTime?, CancellationToken)
public virtual AsyncUnaryCall<Snapshot> SnapshotJobAsync(SnapshotJobRequest request, Metadata headers = null, DateTime? deadline = null, CancellationToken cancellationToken = default)
Snapshot the state of a streaming job.
Parameters | |
---|---|
Name | Description |
request |
SnapshotJobRequest 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 |
AsyncUnaryCallSnapshot |
The call object. |
UpdateJob(UpdateJobRequest, CallOptions)
public virtual Job UpdateJob(UpdateJobRequest request, CallOptions options)
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 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 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 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 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 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 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 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. |