Class UpdateJobRequest.Builder (0.52.0) 

public static final class UpdateJobRequest.Builder extends GeneratedMessageV3.Builder<UpdateJobRequest.Builder> implements UpdateJobRequestOrBuilder

UpdateJob Request.

Protobuf type google.cloud.batch.v1alpha.UpdateJobRequest

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > UpdateJobRequest.Builder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public UpdateJobRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateJobRequest.Builder
Overrides

build()

public UpdateJobRequest build()
Returns
Type Description
UpdateJobRequest

buildPartial()

public UpdateJobRequest buildPartial()
Returns
Type Description
UpdateJobRequest

clear()

public UpdateJobRequest.Builder clear()
Returns
Type Description
UpdateJobRequest.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public UpdateJobRequest.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
UpdateJobRequest.Builder
Overrides

clearJob()

public UpdateJobRequest.Builder clearJob()

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
UpdateJobRequest.Builder

clearOneof(Descriptors.OneofDescriptor oneof)

public UpdateJobRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
UpdateJobRequest.Builder
Overrides

clearRequestId()

public UpdateJobRequest.Builder clearRequestId()

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
UpdateJobRequest.Builder

This builder for chaining.

clearUpdateMask()

public UpdateJobRequest.Builder clearUpdateMask()

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
UpdateJobRequest.Builder

clone()

public UpdateJobRequest.Builder clone()
Returns
Type Description
UpdateJobRequest.Builder
Overrides

getDefaultInstanceForType()

public UpdateJobRequest getDefaultInstanceForType()
Returns
Type Description
UpdateJobRequest

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getJob()

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

getJobBuilder()

public Job.Builder getJobBuilder()

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

getJobOrBuilder()

public 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 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 ByteString getRequestIdBytes()

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
ByteString

The bytes for requestId.

getUpdateMask()

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

getUpdateMaskBuilder()

public FieldMask.Builder getUpdateMaskBuilder()

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
Builder

getUpdateMaskOrBuilder()

public FieldMaskOrBuilder getUpdateMaskOrBuilder()

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
FieldMaskOrBuilder

hasJob()

public 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 boolean hasUpdateMask()

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
boolean

Whether the updateMask field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(UpdateJobRequest other)

public UpdateJobRequest.Builder mergeFrom(UpdateJobRequest other)
Parameter
Name Description
other UpdateJobRequest
Returns
Type Description
UpdateJobRequest.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public UpdateJobRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateJobRequest.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public UpdateJobRequest.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
UpdateJobRequest.Builder
Overrides

mergeJob(Job value)

public UpdateJobRequest.Builder mergeJob(Job value)

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

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

Parameter
Name Description
value Job
Returns
Type Description
UpdateJobRequest.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final UpdateJobRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateJobRequest.Builder
Overrides

mergeUpdateMask(FieldMask value)

public UpdateJobRequest.Builder mergeUpdateMask(FieldMask value)

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];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateJobRequest.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public UpdateJobRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
UpdateJobRequest.Builder
Overrides

setJob(Job value)

public UpdateJobRequest.Builder setJob(Job value)

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

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

Parameter
Name Description
value Job
Returns
Type Description
UpdateJobRequest.Builder

setJob(Job.Builder builderForValue)

public UpdateJobRequest.Builder setJob(Job.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Job.Builder
Returns
Type Description
UpdateJobRequest.Builder

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public UpdateJobRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
UpdateJobRequest.Builder
Overrides

setRequestId(String value)

public UpdateJobRequest.Builder setRequestId(String value)

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) = { ... }

Parameter
Name Description
value String

The requestId to set.
Returns
Type Description
UpdateJobRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public UpdateJobRequest.Builder setRequestIdBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.
Returns
Type Description
UpdateJobRequest.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final UpdateJobRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
UpdateJobRequest.Builder
Overrides

setUpdateMask(FieldMask value)

public UpdateJobRequest.Builder setUpdateMask(FieldMask value)

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];

Parameter
Name Description
value FieldMask
Returns
Type Description
UpdateJobRequest.Builder

setUpdateMask(FieldMask.Builder builderForValue)

public UpdateJobRequest.Builder setUpdateMask(FieldMask.Builder builderForValue)

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];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
UpdateJobRequest.Builder