Class ProjectsResource.LocationsResource.JobsResource.UpdateRequest

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.

Inheritance
object
ClientServiceRequest
ClientServiceRequest<Job>
DataflowBaseServiceRequest<Job>
ProjectsResource.LocationsResource.JobsResource.UpdateRequest
Implements
Inherited Members
Namespace: Google.Apis.Dataflow.v1b3
Assembly: Google.Apis.Dataflow.v1b3.dll
Syntax
public class ProjectsResource.LocationsResource.JobsResource.UpdateRequest : DataflowBaseServiceRequest<Job>, IClientServiceRequest<Job>, IClientServiceRequest

Constructors

UpdateRequest(IClientService, Job, string, string, string)

Constructs a new Update request.

Declaration
public UpdateRequest(IClientService service, Job body, string projectId, string location, string jobId)
Parameters
Type Name Description
IClientService service
Job body
string projectId
string location
string jobId

Properties

HttpMethod

Gets the HTTP method.

Declaration
public override string HttpMethod { get; }
Property Value
Type Description
string
Overrides

JobId

The job ID.

Declaration
[RequestParameter("jobId", RequestParameterType.Path)]
public virtual string JobId { get; }
Property Value
Type Description
string

Location

The [regional endpoint] (https://cloud.google.com/dataflow/docs/concepts/regional-endpoints) that contains this job.

Declaration
[RequestParameter("location", RequestParameterType.Path)]
public virtual string Location { get; }
Property Value
Type Description
string

MethodName

Gets the method name.

Declaration
public override string MethodName { get; }
Property Value
Type Description
string
Overrides

ProjectId

The ID of the Cloud Platform project that the job belongs to.

Declaration
[RequestParameter("projectId", RequestParameterType.Path)]
public virtual string ProjectId { get; }
Property Value
Type Description
string

RestPath

Gets the REST path.

Declaration
public override string RestPath { get; }
Property Value
Type Description
string
Overrides

UpdateMask

The list of fields to update relative to Job. If empty, only RequestedJobState will be considered for update. If the FieldMask is not empty and RequestedJobState is none/empty, The fields specified in the update mask will be the only ones considered for update. If both RequestedJobState and update_mask are specified, an error will be returned as we cannot update both state and mask.

Declaration
[RequestParameter("updateMask", RequestParameterType.Query)]
public virtual object UpdateMask { get; set; }
Property Value
Type Description
object

Methods

GetBody()

Returns the body of the request.

Declaration
protected override object GetBody()
Returns
Type Description
object
Overrides

InitParameters()

Initializes Update parameter list.

Declaration
protected override void InitParameters()
Overrides

Implements