Class DeleteObjectRequest.Builder (2.27.1)

public static final class DeleteObjectRequest.Builder extends GeneratedMessageV3.Builder<DeleteObjectRequest.Builder> implements DeleteObjectRequestOrBuilder

Message for deleting an object. bucket and object must be set.

Protobuf type google.storage.v2.DeleteObjectRequest

Inheritance

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

Implements

DeleteObjectRequestOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DeleteObjectRequest.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public DeleteObjectRequest build()

Returns
Type	Description
`DeleteObjectRequest`

buildPartial()

public DeleteObjectRequest buildPartial()

Returns
Type	Description
`DeleteObjectRequest`

clear()

public DeleteObjectRequest.Builder clear()

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearBucket()

public DeleteObjectRequest.Builder clearBucket()

Required. Name of the bucket in which the object resides.

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

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

clearCommonObjectRequestParams()

public DeleteObjectRequest.Builder clearCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Returns
Type	Description
`DeleteObjectRequest.Builder`

clearField(Descriptors.FieldDescriptor field)

public DeleteObjectRequest.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
`field`	`FieldDescriptor`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearGeneration()

public DeleteObjectRequest.Builder clearGeneration()

If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).

int64 generation = 4;

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

clearIfGenerationMatch()

public DeleteObjectRequest.Builder clearIfGenerationMatch()

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

optional int64 if_generation_match = 5;

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

clearIfGenerationNotMatch()

public DeleteObjectRequest.Builder clearIfGenerationNotMatch()

Makes the operation conditional on whether the object's live generation does not match the given value. If no live object exists, the precondition fails. Setting to 0 makes the operation succeed only if there is a live version of the object.

optional int64 if_generation_not_match = 6;

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

clearIfMetagenerationMatch()

public DeleteObjectRequest.Builder clearIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 7;

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

clearIfMetagenerationNotMatch()

public DeleteObjectRequest.Builder clearIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 8;

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

clearObject()

public DeleteObjectRequest.Builder clearObject()

Required. The name of the finalized object to delete. Note: If you want to delete an unfinalized resumable upload please use CancelResumableWrite.

string object = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DeleteObjectRequest.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
`oneof`	`OneofDescriptor`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clone()

public DeleteObjectRequest.Builder clone()

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getBucket()

public String getBucket()

Required. Name of the bucket in which the object resides.

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

Returns
Type	Description
`String`	The bucket.

getBucketBytes()

public ByteString getBucketBytes()

Required. Name of the bucket in which the object resides.

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

Returns
Type	Description
`ByteString`	The bytes for bucket.

getCommonObjectRequestParams()

public CommonObjectRequestParams getCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Returns
Type	Description
`CommonObjectRequestParams`	The commonObjectRequestParams.

getCommonObjectRequestParamsBuilder()

public CommonObjectRequestParams.Builder getCommonObjectRequestParamsBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Returns
Type	Description
`CommonObjectRequestParams.Builder`

getCommonObjectRequestParamsOrBuilder()

public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Returns
Type	Description
`CommonObjectRequestParamsOrBuilder`

getDefaultInstanceForType()

public DeleteObjectRequest getDefaultInstanceForType()

Returns
Type	Description
`DeleteObjectRequest`

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
`Descriptor`

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getGeneration()

public long getGeneration()

If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).

int64 generation = 4;

Returns
Type	Description
`long`	The generation.

getIfGenerationMatch()

public long getIfGenerationMatch()

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

optional int64 if_generation_match = 5;

Returns
Type	Description
`long`	The ifGenerationMatch.

getIfGenerationNotMatch()

public long getIfGenerationNotMatch()

optional int64 if_generation_not_match = 6;

Returns
Type	Description
`long`	The ifGenerationNotMatch.

getIfMetagenerationMatch()

public long getIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 7;

Returns
Type	Description
`long`	The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

public long getIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 8;

Returns
Type	Description
`long`	The ifMetagenerationNotMatch.

getObject()

public String getObject()

Required. The name of the finalized object to delete. Note: If you want to delete an unfinalized resumable upload please use CancelResumableWrite.

string object = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`String`	The object.

getObjectBytes()

public ByteString getObjectBytes()

Required. The name of the finalized object to delete. Note: If you want to delete an unfinalized resumable upload please use CancelResumableWrite.

string object = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type	Description
`ByteString`	The bytes for object.

hasCommonObjectRequestParams()

public boolean hasCommonObjectRequestParams()

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

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

hasIfGenerationMatch()

public boolean hasIfGenerationMatch()

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

optional int64 if_generation_match = 5;

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

hasIfGenerationNotMatch()

public boolean hasIfGenerationNotMatch()

optional int64 if_generation_not_match = 6;

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

hasIfMetagenerationMatch()

public boolean hasIfMetagenerationMatch()

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 7;

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

hasIfMetagenerationNotMatch()

public boolean hasIfMetagenerationNotMatch()

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 8;

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

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCommonObjectRequestParams(CommonObjectRequestParams value)

public DeleteObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Parameter
Name	Description
`value`	`CommonObjectRequestParams`

Returns
Type	Description
`DeleteObjectRequest.Builder`

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DeleteObjectRequest.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
`IOException`

mergeFrom(Message other)

public DeleteObjectRequest.Builder mergeFrom(Message other)

Parameter
Name	Description
`other`	`Message`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeFrom(DeleteObjectRequest other)

public DeleteObjectRequest.Builder mergeFrom(DeleteObjectRequest other)

Parameter
Name	Description
`other`	`DeleteObjectRequest`

Returns
Type	Description
`DeleteObjectRequest.Builder`

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DeleteObjectRequest.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setBucket(String value)

public DeleteObjectRequest.Builder setBucket(String value)

Required. Name of the bucket in which the object resides.

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

Parameter
Name	Description
`value`	`String` The bucket to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

setBucketBytes(ByteString value)

public DeleteObjectRequest.Builder setBucketBytes(ByteString value)

Required. Name of the bucket in which the object resides.

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

Parameter
Name	Description
`value`	`ByteString` The bytes for bucket to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

setCommonObjectRequestParams(CommonObjectRequestParams value)

public DeleteObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Parameter
Name	Description
`value`	`CommonObjectRequestParams`

Returns
Type	Description
`DeleteObjectRequest.Builder`

setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

public DeleteObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)

A set of parameters common to Storage API requests concerning an object.

.google.storage.v2.CommonObjectRequestParams common_object_request_params = 10;

Parameter
Name	Description
`builderForValue`	`CommonObjectRequestParams.Builder`

Returns
Type	Description
`DeleteObjectRequest.Builder`

setField(Descriptors.FieldDescriptor field, Object value)

public DeleteObjectRequest.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
`field`	`FieldDescriptor`
`value`	`Object`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setGeneration(long value)

public DeleteObjectRequest.Builder setGeneration(long value)

If present, permanently deletes a specific revision of this object (as opposed to the latest version, the default).

int64 generation = 4;

Parameter
Name	Description
`value`	`long` The generation to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

setIfGenerationMatch(long value)

public DeleteObjectRequest.Builder setIfGenerationMatch(long value)

Makes the operation conditional on whether the object's current generation matches the given value. Setting to 0 makes the operation succeed only if there are no live versions of the object.

optional int64 if_generation_match = 5;

Parameter
Name	Description
`value`	`long` The ifGenerationMatch to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

setIfGenerationNotMatch(long value)

public DeleteObjectRequest.Builder setIfGenerationNotMatch(long value)

optional int64 if_generation_not_match = 6;

Parameter
Name	Description
`value`	`long` The ifGenerationNotMatch to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

setIfMetagenerationMatch(long value)

public DeleteObjectRequest.Builder setIfMetagenerationMatch(long value)

Makes the operation conditional on whether the object's current metageneration matches the given value.

optional int64 if_metageneration_match = 7;

Parameter
Name	Description
`value`	`long` The ifMetagenerationMatch to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

setIfMetagenerationNotMatch(long value)

public DeleteObjectRequest.Builder setIfMetagenerationNotMatch(long value)

Makes the operation conditional on whether the object's current metageneration does not match the given value.

optional int64 if_metageneration_not_match = 8;

Parameter
Name	Description
`value`	`long` The ifMetagenerationNotMatch to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

setObject(String value)

public DeleteObjectRequest.Builder setObject(String value)

Required. The name of the finalized object to delete. Note: If you want to delete an unfinalized resumable upload please use CancelResumableWrite.

string object = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`String` The object to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

setObjectBytes(ByteString value)

public DeleteObjectRequest.Builder setObjectBytes(ByteString value)

Required. The name of the finalized object to delete. Note: If you want to delete an unfinalized resumable upload please use CancelResumableWrite.

string object = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name	Description
`value`	`ByteString` The bytes for object to set.

Returns
Type	Description
`DeleteObjectRequest.Builder`	This builder for chaining.

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

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

Parameters
Name	Description
`field`	`FieldDescriptor`
`index`	`int`
`value`	`Object`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setUnknownFields(UnknownFieldSet unknownFields)

public final DeleteObjectRequest.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
`unknownFields`	`UnknownFieldSet`

Returns
Type	Description
`DeleteObjectRequest.Builder`

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)