Batch v1alpha API - Class UpdateJobRequest (1.0.0-alpha29)

public sealed class UpdateJobRequest : IMessage<UpdateJobRequest>, IEquatable<UpdateJobRequest>, IDeepCloneable<UpdateJobRequest>, IBufferMessage, IMessage

Reference documentation and code samples for the Batch v1alpha API class UpdateJobRequest.

UpdateJob Request.

Inheritance

object > UpdateJobRequest

Implements

IMessage UpdateJobRequest, IEquatable UpdateJobRequest, IDeepCloneable UpdateJobRequest, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Batch.V1Alpha

Assembly

Google.Cloud.Batch.V1Alpha.dll

Constructors

UpdateJobRequest()

public UpdateJobRequest()

UpdateJobRequest(UpdateJobRequest)

public UpdateJobRequest(UpdateJobRequest other)

Parameter
Name	Description
`other`	`UpdateJobRequest`

Properties

Job

public Job Job { get; set; }

Required. The Job to update. Only fields specified in updateMask are updated.

Property Value
Type	Description
`Job`

RequestId

public string RequestId { get; set; }

Optional. An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

Property Value
Type	Description
`string`

UpdateMask

public FieldMask UpdateMask { get; set; }

Required. Mask of fields to update.

The jobs.patch method can only be used while a job is in the QUEUED, SCHEDULED, or RUNNING state and currently only supports increasing the value of the first taskCount field in the job's taskGroups field. Therefore, you must set the value of updateMask to taskGroups. Any other job fields in the update request will be ignored.

For example, to update a job's taskCount to 2, set updateMask to taskGroups and use the following request body:

{
  "taskGroups":[{
    "taskCount": 2
  }]
}

Property Value
Type	Description
`FieldMask`