Dataflow v1beta3 API - Class JobsV1Beta3.JobsV1Beta3Base (2.0.0-beta09)

[BindServiceMethod(typeof(JobsV1Beta3), "BindService")]
public abstract class JobsV1Beta3.JobsV1Beta3Base

Reference documentation and code samples for the Dataflow v1beta3 API class JobsV1Beta3.JobsV1Beta3Base.

Base class for server-side implementations of JobsV1Beta3

Inheritance

object > JobsV1Beta3.JobsV1Beta3Base

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Dataflow.V1Beta3

Assembly

Google.Cloud.Dataflow.V1Beta3.dll

Methods

AggregatedListJobs(ListJobsRequest, ServerCallContext)

public virtual Task<ListJobsResponse> AggregatedListJobs(ListJobsRequest request, ServerCallContext context)

List the jobs of a project across all regions.

Note: This method doesn't support filtering the list of jobs by name.

Parameters
Name	Description
`request`	`ListJobsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListJobsResponse`	The response to send back to the client (wrapped by a task).

CheckActiveJobs(CheckActiveJobsRequest, ServerCallContext)

public virtual Task<CheckActiveJobsResponse> CheckActiveJobs(CheckActiveJobsRequest request, ServerCallContext context)

Check for existence of active jobs in the given project across all regions.

Parameters
Name	Description
`request`	`CheckActiveJobsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskCheckActiveJobsResponse`	The response to send back to the client (wrapped by a task).

CreateJob(CreateJobRequest, ServerCallContext)

public virtual Task<Job> CreateJob(CreateJobRequest request, ServerCallContext context)

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.

Do not enter confidential information when you supply string values using the API.

Parameters
Name	Description
`request`	`CreateJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskJob`	The response to send back to the client (wrapped by a task).

GetJob(GetJobRequest, ServerCallContext)

public virtual Task<Job> GetJob(GetJobRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskJob`	The response to send back to the client (wrapped by a task).

ListJobs(ListJobsRequest, ServerCallContext)

public virtual Task<ListJobsResponse> ListJobs(ListJobsRequest request, ServerCallContext context)

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, because you can only get the list of jobs that are running in us-central1.

projects.locations.jobs.list and projects.jobs.list support filtering the list of jobs by name. Filtering by name isn't supported by projects.jobs.aggregated.

Parameters
Name	Description
`request`	`ListJobsRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskListJobsResponse`	The response to send back to the client (wrapped by a task).

SnapshotJob(SnapshotJobRequest, ServerCallContext)

public virtual Task<Snapshot> SnapshotJob(SnapshotJobRequest request, ServerCallContext context)

Snapshot the state of a streaming job.

Parameters
Name	Description
`request`	`SnapshotJobRequest` The request received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskSnapshot`	The response to send back to the client (wrapped by a task).

UpdateJob(UpdateJobRequest, ServerCallContext)

public virtual Task<Job> UpdateJob(UpdateJobRequest request, ServerCallContext context)

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 received from the client.
`context`	`ServerCallContext` The context of the server-side call handler being invoked.

Returns
Type	Description
`TaskJob`	The response to send back to the client (wrapped by a task).

Dataflow v1beta3 API - Class JobsV1Beta3.JobsV1Beta3Base (2.0.0-beta09) Stay organized with collections Save and categorize content based on your preferences.