public final class RestoreObjectRequest extends GeneratedMessageV3 implements RestoreObjectRequestOrBuilder
Message for restoring an object.
bucket, object, and generation must be set.
Protobuf type google.storage.v2.RestoreObjectRequest
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
BUCKET_FIELD_NUMBER
public static final int BUCKET_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
COPY_SOURCE_ACL_FIELD_NUMBER
public static final int COPY_SOURCE_ACL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
GENERATION_FIELD_NUMBER
public static final int GENERATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IF_GENERATION_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
IF_GENERATION_NOT_MATCH_FIELD_NUMBER
public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
OBJECT_FIELD_NUMBER
public static final int OBJECT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
RESTORE_TOKEN_FIELD_NUMBER
public static final int RESTORE_TOKEN_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static RestoreObjectRequest getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static RestoreObjectRequest.Builder newBuilder()
newBuilder(RestoreObjectRequest prototype)
public static RestoreObjectRequest.Builder newBuilder(RestoreObjectRequest prototype)
public static RestoreObjectRequest parseDelimitedFrom(InputStream input)
public static RestoreObjectRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static RestoreObjectRequest parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static RestoreObjectRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static RestoreObjectRequest parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreObjectRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static RestoreObjectRequest parseFrom(CodedInputStream input)
public static RestoreObjectRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static RestoreObjectRequest parseFrom(InputStream input)
public static RestoreObjectRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static RestoreObjectRequest parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static RestoreObjectRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<RestoreObjectRequest> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
getCommonObjectRequestParamsOrBuilder()
public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
getCopySourceAcl()
public boolean getCopySourceAcl()
If false or unset, the bucket's default object ACL will be used.
If true, copy the source object's access controls.
Return an error if bucket has UBLA enabled.
optional bool copy_source_acl = 9;
| Returns |
| Type |
Description |
boolean |
The copySourceAcl.
|
getDefaultInstanceForType()
public RestoreObjectRequest getDefaultInstanceForType()
getGeneration()
public long getGeneration()
Required. The specific revision of the object to restore.
int64 generation = 3 [(.google.api.field_behavior) = REQUIRED];
| 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 = 4;
| Returns |
| 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 = 5;
| Returns |
| 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 = 6;
| Returns |
| 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 = 7;
| Returns |
| Type |
Description |
long |
The ifMetagenerationNotMatch.
|
getObject()
public String getObject()
Required. The name of the object to restore.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
String |
The object.
|
getObjectBytes()
public ByteString getObjectBytes()
Required. The name of the object to restore.
string object = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns |
| Type |
Description |
ByteString |
The bytes for object.
|
getParserForType()
public Parser<RestoreObjectRequest> getParserForType()
Overrides
getRestoreToken()
public String getRestoreToken()
Optional. Restore token used to differentiate soft-deleted objects with the
same name and generation. Only applicable for hierarchical namespace
buckets. This parameter is optional, and is only required in the rare case
when there are multiple soft-deleted objects with the same name and
generation.
string restore_token = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
String |
The restoreToken.
|
getRestoreTokenBytes()
public ByteString getRestoreTokenBytes()
Optional. Restore token used to differentiate soft-deleted objects with the
same name and generation. Only applicable for hierarchical namespace
buckets. This parameter is optional, and is only required in the rare case
when there are multiple soft-deleted objects with the same name and
generation.
string restore_token = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
ByteString |
The bytes for restoreToken.
|
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hasCommonObjectRequestParams()
public boolean hasCommonObjectRequestParams()
Optional. A set of parameters common to Storage API requests concerning an
object.
.google.storage.v2.CommonObjectRequestParams common_object_request_params = 8 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the commonObjectRequestParams field is set.
|
hasCopySourceAcl()
public boolean hasCopySourceAcl()
If false or unset, the bucket's default object ACL will be used.
If true, copy the source object's access controls.
Return an error if bucket has UBLA enabled.
optional bool copy_source_acl = 9;
| Returns |
| Type |
Description |
boolean |
Whether the copySourceAcl 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 = 4;
| Returns |
| 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 = 5;
| Returns |
| 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 = 6;
| Returns |
| 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 = 7;
| Returns |
| Type |
Description |
boolean |
Whether the ifMetagenerationNotMatch field is set.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public RestoreObjectRequest.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected RestoreObjectRequest.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public RestoreObjectRequest.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
