Class DeleteObject.Builder (0.23.0)

public static final class DeleteObject.Builder extends GeneratedMessage.Builder<DeleteObject.Builder> implements DeleteObjectOrBuilder

Describes options to delete an object.

Protobuf type google.cloud.storagebatchoperations.v1.DeleteObject

Static Methods

getDescriptor()

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

Methods

build()

public DeleteObject build()
Returns
Type Description
DeleteObject

buildPartial()

public DeleteObject buildPartial()
Returns
Type Description
DeleteObject

clear()

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

clearPermanentObjectDeletionEnabled()

public DeleteObject.Builder clearPermanentObjectDeletionEnabled()

Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation.

bool permanent_object_deletion_enabled = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
DeleteObject.Builder

This builder for chaining.

getDefaultInstanceForType()

public DeleteObject getDefaultInstanceForType()
Returns
Type Description
DeleteObject

getDescriptorForType()

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

getPermanentObjectDeletionEnabled()

public boolean getPermanentObjectDeletionEnabled()

Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation.

bool permanent_object_deletion_enabled = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

The permanentObjectDeletionEnabled.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(DeleteObject other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

setPermanentObjectDeletionEnabled(boolean value)

public DeleteObject.Builder setPermanentObjectDeletionEnabled(boolean value)

Required. Controls deletion behavior when versioning is enabled for the object's bucket. If true both live and noncurrent objects will be permanently deleted. Otherwise live objects in versioned buckets will become noncurrent and objects that were already noncurrent will be skipped. This setting doesn't have any impact on the Soft Delete feature. All objects deleted by this service can be be restored for the duration of the Soft Delete retention duration if enabled. If enabled and the manifest doesn't specify an object's generation, a GetObjectMetadata call (a Class B operation) will be made to determine the live object generation.

bool permanent_object_deletion_enabled = 1 [(.google.api.field_behavior) = REQUIRED];

Parameter
Name Description
value boolean

The permanentObjectDeletionEnabled to set.

Returns
Type Description
DeleteObject.Builder

This builder for chaining.