public final class DeleteObjectRequest extends GeneratedMessageV3 implements DeleteObjectRequestOrBuilder
Message for deleting an object.
Either bucket and object or upload_id must be set (but not both).
Protobuf type google.storage.v2.DeleteObjectRequest
Static Fields
BUCKET_FIELD_NUMBER
public static final int BUCKET_FIELD_NUMBER
Field Value
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Field Value
GENERATION_FIELD_NUMBER
public static final int GENERATION_FIELD_NUMBER
Field Value
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
Field Value
IF_GENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
OBJECT_FIELD_NUMBER
public static final int OBJECT_FIELD_NUMBER
Field Value
UPLOAD_ID_FIELD_NUMBER
public static final int UPLOAD_ID_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static DeleteObjectRequest getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static DeleteObjectRequest.Builder newBuilder()
Returns
newBuilder(DeleteObjectRequest prototype)
public static DeleteObjectRequest.Builder newBuilder(DeleteObjectRequest prototype)
Parameter
Returns
public static DeleteObjectRequest parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static DeleteObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static DeleteObjectRequest parseFrom(byte[] data)
Parameter
| Name | Description |
| data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static DeleteObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static DeleteObjectRequest parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static DeleteObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeleteObjectRequest parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static DeleteObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static DeleteObjectRequest parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static DeleteObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static DeleteObjectRequest parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static DeleteObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<DeleteObjectRequest> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
getBucket()
public String getBucket()
Required. Name of the bucket in which the object resides.
string bucket = 1 [(.google.api.field_behavior) = REQUIRED];
| 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];
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;
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;
getDefaultInstanceForType()
public DeleteObjectRequest getDefaultInstanceForType()
Returns
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;
| 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;
| Type | Description |
| long | The ifGenerationMatch.
|
getIfGenerationNotMatch()
public long getIfGenerationNotMatch()
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;
| Type | Description |
| long | The ifGenerationNotMatch.
|
public long getIfMetagenerationMatch()
Makes the operation conditional on whether the object's current
metageneration matches the given value.
optional int64 if_metageneration_match = 7;
| Type | Description |
| long | The ifMetagenerationMatch.
|
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;
| Type | Description |
| long | The ifMetagenerationNotMatch.
|
getObject()
public String getObject()
Required. The name of the object to delete (when not using a resumable write).
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Type | Description |
| String | The object.
|
getObjectBytes()
public ByteString getObjectBytes()
Required. The name of the object to delete (when not using a resumable write).
string object = 2 [(.google.api.field_behavior) = REQUIRED];
getParserForType()
public Parser<DeleteObjectRequest> getParserForType()
Returns
Overrides
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
getUploadId()
public String getUploadId()
The resumable upload_id of the object to delete (when deleting an
in-progress resumable write). This should be copied from the upload_id
field of StartResumableWriteResponse.
string upload_id = 3;
| Type | Description |
| String | The uploadId.
|
getUploadIdBytes()
public ByteString getUploadIdBytes()
The resumable upload_id of the object to delete (when deleting an
in-progress resumable write). This should be copied from the upload_id
field of StartResumableWriteResponse.
string upload_id = 3;
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;
| 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;
| Type | Description |
| boolean | Whether the ifGenerationMatch field is set.
|
hasIfGenerationNotMatch()
public boolean hasIfGenerationNotMatch()
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;
| Type | Description |
| boolean | Whether the ifGenerationNotMatch field is set.
|
public boolean hasIfMetagenerationMatch()
Makes the operation conditional on whether the object's current
metageneration matches the given value.
optional int64 if_metageneration_match = 7;
| Type | Description |
| boolean | Whether the ifMetagenerationMatch field is set.
|
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;
| Type | Description |
| boolean | Whether the ifMetagenerationNotMatch field is set.
|
hashCode()
Returns
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public DeleteObjectRequest.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected DeleteObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public DeleteObjectRequest.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions
