Class ProjectsResource.JobsResource

The "jobs" collection of methods.

Inheritance

object

ProjectsResource.JobsResource

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Dataflow.v1b3

Assembly: Google.Apis.Dataflow.v1b3.dll

Syntax

public class ProjectsResource.JobsResource

Constructors

JobsResource(IClientService)

Constructs a new resource.

Declaration

public JobsResource(IClientService service)

Parameters

Type	Name	Description
IClientService	service

Properties

Debug

Gets the Debug resource.

Declaration

public virtual ProjectsResource.JobsResource.DebugResource Debug { get; }

Property Value

Type	Description
ProjectsResource.JobsResource.DebugResource

Messages

Gets the Messages resource.

Declaration

public virtual ProjectsResource.JobsResource.MessagesResource Messages { get; }

Property Value

Type	Description
ProjectsResource.JobsResource.MessagesResource

WorkItems

Gets the WorkItems resource.

Declaration

public virtual ProjectsResource.JobsResource.WorkItemsResource WorkItems { get; }

Property Value

Type	Description
ProjectsResource.JobsResource.WorkItemsResource

Methods

Aggregated(string)

List the jobs of a project across all regions. Note: This method doesn't support filtering the list of jobs by name. # IAM Permissions Requires the dataflow.jobs.list permission on the project.

Declaration

public virtual ProjectsResource.JobsResource.AggregatedRequest Aggregated(string projectId)

Parameters

Type	Name	Description
string	projectId	The project which owns the jobs.

Returns

Type	Description
ProjectsResource.JobsResource.AggregatedRequest

Create(Job, string)

Creates a Dataflow job. To create a job, we recommend using projects.locations.jobs.create with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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. # IAM Permissions 1. Requires the dataflow.jobs.create permission on the project. 2. resourcemanager.projects.get (Specifically required for regional endpoints to resolve regional resource metadata)

Declaration

public virtual ProjectsResource.JobsResource.CreateRequest Create(Job body, string projectId)

Parameters

Type	Name	Description
Job	body	The body of the request.
string	projectId	The ID of the Cloud Platform project that the job belongs to.

Returns

Type	Description
ProjectsResource.JobsResource.CreateRequest

Get(string, string)

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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.get is not recommended, as you can only get the state of jobs that are running in us-central1. # IAM Permissions Requires the dataflow.jobs.get permission on the job.

Declaration

public virtual ProjectsResource.JobsResource.GetRequest Get(string projectId, string jobId)

Parameters

Type	Name	Description
string	projectId	The ID of the Cloud Platform project that the job belongs to.
string	jobId	The job ID.

Returns

Type	Description
ProjectsResource.JobsResource.GetRequest

GetMetrics(string, string)

Request the job status. To request the status of a job, we recommend using projects.locations.jobs.getMetrics with a [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.getMetrics is not recommended, as you can only request the status of jobs that are running in us-central1. # IAM Permissions Requires the dataflow.metrics.get permission on the job.

Declaration

public virtual ProjectsResource.JobsResource.GetMetricsRequest GetMetrics(string projectId, string jobId)

Parameters

Type	Name	Description
string	projectId	A project id.
string	jobId	The job to get metrics for.

Returns

Type	Description
ProjectsResource.JobsResource.GetMetricsRequest

List(string)

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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). 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. # IAM Permissions Requires the dataflow.jobs.list permission on the project.

Declaration

public virtual ProjectsResource.JobsResource.ListRequest List(string projectId)

Parameters

Type	Name	Description
string	projectId	The project which owns the jobs.

Returns

Type	Description
ProjectsResource.JobsResource.ListRequest

Snapshot(SnapshotJobRequest, string, string)

Snapshot the state of a streaming job. # IAM Permissions Requires the dataflow.jobs.snapshot permission on the job.

Declaration

public virtual ProjectsResource.JobsResource.SnapshotRequest Snapshot(SnapshotJobRequest body, string projectId, string jobId)

Parameters

Type	Name	Description
SnapshotJobRequest	body	The body of the request.
string	projectId	The project which owns the job to be snapshotted.
string	jobId	The job to be snapshotted.

Returns

Type	Description
ProjectsResource.JobsResource.SnapshotRequest

Update(Job, string, string)

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] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints). Using projects.jobs.update is not recommended, as you can only update the state of jobs that are running in us-central1. # IAM Permissions 1. Requires the dataflow.jobs.cancel permission to cancel a job. 2. Requires the dataflow.jobs.updateContents permission to update runtime parameters.

Declaration

public virtual ProjectsResource.JobsResource.UpdateRequest Update(Job body, string projectId, string jobId)

Parameters

Type	Name	Description
Job	body	The body of the request.
string	projectId	The ID of the Cloud Platform project that the job belongs to.
string	jobId	The job ID.

Returns

Type	Description
ProjectsResource.JobsResource.UpdateRequest