Interface UpdateJobRequestOrBuilder (0.51.0)

public interface UpdateJobRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getJob()

public abstract Job getJob()

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

.google.cloud.batch.v1alpha.Job job = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`Job`	The job.

getJobOrBuilder()

public abstract JobOrBuilder getJobOrBuilder()

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

.google.cloud.batch.v1alpha.Job job = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`JobOrBuilder`

getRequestId()

public abstract String getRequestId()

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).

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type	Description
`String`	The requestId.

getRequestIdBytes()

public abstract ByteString getRequestIdBytes()

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

string request_id = 3 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type	Description
`ByteString`	The bytes for requestId.

getUpdateMask()

public abstract FieldMask getUpdateMask()

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: <code><code> { "taskGroups":[{ "taskCount": 2 }] } </code></code>

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`FieldMask`	The updateMask.

getUpdateMaskOrBuilder()

public abstract FieldMaskOrBuilder getUpdateMaskOrBuilder()

Required. Mask of fields to update.

For example, to update a job's taskCount to 2, set updateMask to taskGroups and use the following request body: <code><code> { "taskGroups":[{ "taskCount": 2 }] } </code></code>

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`FieldMaskOrBuilder`

hasJob()

public abstract boolean hasJob()

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

.google.cloud.batch.v1alpha.Job job = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the job field is set.

hasUpdateMask()

public abstract boolean hasUpdateMask()

Required. Mask of fields to update.

For example, to update a job's taskCount to 2, set updateMask to taskGroups and use the following request body: <code><code> { "taskGroups":[{ "taskCount": 2 }] } </code></code>

.google.protobuf.FieldMask update_mask = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`boolean`	Whether the updateMask field is set.