Class CancelJobRequest.Builder (0.16.0)
public static final class CancelJobRequest.Builder extends GeneratedMessageV3.Builder<CancelJobRequest.Builder> implements CancelJobRequestOrBuilder
Message for Job to Cancel
Protobuf type google.cloud.storagebatchoperations.v1.CancelJobRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public CancelJobRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
public CancelJobRequest build()
buildPartial()
public CancelJobRequest buildPartial()
clear()
public CancelJobRequest.Builder clear()
Overrides
clearField(Descriptors.FieldDescriptor field)
public CancelJobRequest.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearName()
public CancelJobRequest.Builder clearName()
Required. The name of the job to cancel.
Format: projects/{project_id}/locations/global/jobs/{job_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
clearOneof(Descriptors.OneofDescriptor oneof)
public CancelJobRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clearRequestId()
public CancelJobRequest.Builder clearRequestId()
Optional. An optional request ID to identify requests. Specify a unique
request ID in case you need to retry your request. Requests with same
request_id will be ignored for at least 60 minutes since the first
request. 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];
clone()
public CancelJobRequest.Builder clone()
Overrides
getDefaultInstanceForType()
public CancelJobRequest getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
getName()
Required. The name of the job to cancel.
Format: projects/{project_id}/locations/global/jobs/{job_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
String |
The name.
|
getNameBytes()
public ByteString getNameBytes()
Required. The name of the job to cancel.
Format: projects/{project_id}/locations/global/jobs/{job_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for name.
|
getRequestId()
public String getRequestId()
Optional. An optional request ID to identify requests. Specify a unique
request ID in case you need to retry your request. Requests with same
request_id will be ignored for at least 60 minutes since the first
request. 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];
| Returns |
| Type |
Description |
String |
The requestId.
|
getRequestIdBytes()
public ByteString getRequestIdBytes()
Optional. An optional request ID to identify requests. Specify a unique
request ID in case you need to retry your request. Requests with same
request_id will be ignored for at least 60 minutes since the first
request. 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];
| Returns |
| Type |
Description |
ByteString |
The bytes for requestId.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(CancelJobRequest other)
public CancelJobRequest.Builder mergeFrom(CancelJobRequest other)
public CancelJobRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public CancelJobRequest.Builder mergeFrom(Message other)
| Parameter |
| Name |
Description |
other |
Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final CancelJobRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public CancelJobRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setName(String value)
public CancelJobRequest.Builder setName(String value)
Required. The name of the job to cancel.
Format: projects/{project_id}/locations/global/jobs/{job_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
String
The name to set.
|
setNameBytes(ByteString value)
public CancelJobRequest.Builder setNameBytes(ByteString value)
Required. The name of the job to cancel.
Format: projects/{project_id}/locations/global/jobs/{job_id}.
string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public CancelJobRequest.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setRequestId(String value)
public CancelJobRequest.Builder setRequestId(String value)
Optional. An optional request ID to identify requests. Specify a unique
request ID in case you need to retry your request. Requests with same
request_id will be ignored for at least 60 minutes since the first
request. 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];
| Parameter |
| Name |
Description |
value |
String
The requestId to set.
|
setRequestIdBytes(ByteString value)
public CancelJobRequest.Builder setRequestIdBytes(ByteString value)
Optional. An optional request ID to identify requests. Specify a unique
request ID in case you need to retry your request. Requests with same
request_id will be ignored for at least 60 minutes since the first
request. 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];
| Parameter |
| Name |
Description |
value |
ByteString
The bytes for requestId to set.
|
setUnknownFields(UnknownFieldSet unknownFields)
public final CancelJobRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-11 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-11 UTC."],[],[]]
