Class DeleteJobRequest.Builder (0.25.0)

public static final class DeleteJobRequest.Builder extends GeneratedMessage.Builder<DeleteJobRequest.Builder> implements DeleteJobRequestOrBuilder

Message for deleting a Job

Protobuf type google.cloud.storagebatchoperations.v1.DeleteJobRequest

Static Methods

getDescriptor()

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

Methods

build()

public DeleteJobRequest build()
Returns
Type Description
DeleteJobRequest

buildPartial()

public DeleteJobRequest buildPartial()
Returns
Type Description
DeleteJobRequest

clear()

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

clearForce()

public DeleteJobRequest.Builder clearForce()

Optional. If set to true, any child bucket operations of the job will also be deleted. Highly recommended to be set to true by all clients. Users cannot mutate bucket operations directly, so only the jobs.delete permission is required to delete a job (and its child bucket operations).

bool force = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
DeleteJobRequest.Builder

This builder for chaining.

clearName()

public DeleteJobRequest.Builder clearName()

Required. The name of the job to delete. Format: projects/{project_id}/locations/global/jobs/{job_id} .

string name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
DeleteJobRequest.Builder

This builder for chaining.

clearRequestId()

public DeleteJobRequest.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 = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
DeleteJobRequest.Builder

This builder for chaining.

getDefaultInstanceForType()

public DeleteJobRequest getDefaultInstanceForType()
Returns
Type Description
DeleteJobRequest

getDescriptorForType()

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

getForce()

public boolean getForce()

Optional. If set to true, any child bucket operations of the job will also be deleted. Highly recommended to be set to true by all clients. Users cannot mutate bucket operations directly, so only the jobs.delete permission is required to delete a job (and its child bucket operations).

bool force = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The force.

getName()

public String getName()

Required. The name of the job to delete. 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 delete. 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 = 2 [(.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 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 = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Returns
Type Description
ByteString

The bytes for requestId.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DeleteJobRequest other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setForce(boolean value)

public DeleteJobRequest.Builder setForce(boolean value)

Optional. If set to true, any child bucket operations of the job will also be deleted. Highly recommended to be set to true by all clients. Users cannot mutate bucket operations directly, so only the jobs.delete permission is required to delete a job (and its child bucket operations).

bool force = 3 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value boolean

The force to set.

Returns
Type Description
DeleteJobRequest.Builder

This builder for chaining.

setName(String value)

public DeleteJobRequest.Builder setName(String value)

Required. The name of the job to delete. 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.

Returns
Type Description
DeleteJobRequest.Builder

This builder for chaining.

setNameBytes(ByteString value)

public DeleteJobRequest.Builder setNameBytes(ByteString value)

Required. The name of the job to delete. 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.

Returns
Type Description
DeleteJobRequest.Builder

This builder for chaining.

setRequestId(String value)

public DeleteJobRequest.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 = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value String

The requestId to set.

Returns
Type Description
DeleteJobRequest.Builder

This builder for chaining.

setRequestIdBytes(ByteString value)

public DeleteJobRequest.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 = 2 [(.google.api.field_behavior) = OPTIONAL, (.google.api.field_info) = { ... }

Parameter
Name Description
value ByteString

The bytes for requestId to set.

Returns
Type Description
DeleteJobRequest.Builder

This builder for chaining.