Class UpdateJobRequest (0.48.0)

public final class UpdateJobRequest extends GeneratedMessageV3 implements UpdateJobRequestOrBuilder

UpdateJob Request.

Protobuf type google.cloud.batch.v1alpha.UpdateJobRequest

Static Fields

JOB_FIELD_NUMBER

public static final int JOB_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_ID_FIELD_NUMBER

public static final int REQUEST_ID_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_MASK_FIELD_NUMBER

public static final int UPDATE_MASK_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static UpdateJobRequest getDefaultInstance()
Returns
Type Description
UpdateJobRequest

getDescriptor()

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

newBuilder()

public static UpdateJobRequest.Builder newBuilder()
Returns
Type Description
UpdateJobRequest.Builder

newBuilder(UpdateJobRequest prototype)

public static UpdateJobRequest.Builder newBuilder(UpdateJobRequest prototype)
Parameter
Name Description
prototype UpdateJobRequest
Returns
Type Description
UpdateJobRequest.Builder

parseDelimitedFrom(InputStream input)

public static UpdateJobRequest parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateJobRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static UpdateJobRequest parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static UpdateJobRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static UpdateJobRequest parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static UpdateJobRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static UpdateJobRequest parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateJobRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static UpdateJobRequest parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static UpdateJobRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static UpdateJobRequest parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static UpdateJobRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
UpdateJobRequest
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<UpdateJobRequest> parser()
Returns
Type Description
Parser<UpdateJobRequest>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public UpdateJobRequest getDefaultInstanceForType()
Returns
Type Description
UpdateJobRequest

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.

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

getParserForType()

public Parser<UpdateJobRequest> getParserForType()
Returns
Type Description
Parser<UpdateJobRequest>
Overrides

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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public UpdateJobRequest.Builder newBuilderForType()
Returns
Type Description
UpdateJobRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected UpdateJobRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
UpdateJobRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public UpdateJobRequest.Builder toBuilder()
Returns
Type Description
UpdateJobRequest.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException