Class RestoreObjectRequest (2.50.0)

publicfinalclassRestoreObjectRequestextendsGeneratedMessageV3implementsRestoreObjectRequestOrBuilder

Message for restoring an object. bucket, object, and generationmust be set.

Protobuf type google.storage.v2.RestoreObjectRequest

Static Fields

BUCKET_FIELD_NUMBER

publicstaticfinalintBUCKET_FIELD_NUMBER
Field Value
TypeDescription
int

COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER

publicstaticfinalintCOMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

COPY_SOURCE_ACL_FIELD_NUMBER

publicstaticfinalintCOPY_SOURCE_ACL_FIELD_NUMBER
Field Value
TypeDescription
int

GENERATION_FIELD_NUMBER

publicstaticfinalintGENERATION_FIELD_NUMBER
Field Value
TypeDescription
int

IF_GENERATION_MATCH_FIELD_NUMBER

publicstaticfinalintIF_GENERATION_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

IF_GENERATION_NOT_MATCH_FIELD_NUMBER

publicstaticfinalintIF_GENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

IF_METAGENERATION_MATCH_FIELD_NUMBER

publicstaticfinalintIF_METAGENERATION_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

publicstaticfinalintIF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
Field Value
TypeDescription
int

OBJECT_FIELD_NUMBER

publicstaticfinalintOBJECT_FIELD_NUMBER
Field Value
TypeDescription
int

RESTORE_TOKEN_FIELD_NUMBER

publicstaticfinalintRESTORE_TOKEN_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

publicstaticRestoreObjectRequestgetDefaultInstance()
Returns
TypeDescription
RestoreObjectRequest

getDescriptor()

publicstaticfinalDescriptors.DescriptorgetDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

publicstaticRestoreObjectRequest.BuildernewBuilder()
Returns
TypeDescription
RestoreObjectRequest.Builder

newBuilder(RestoreObjectRequest prototype)

publicstaticRestoreObjectRequest.BuildernewBuilder(RestoreObjectRequestprototype)
Parameter
NameDescription
prototypeRestoreObjectRequest
Returns
TypeDescription
RestoreObjectRequest.Builder

parseDelimitedFrom(InputStream input)

publicstaticRestoreObjectRequestparseDelimitedFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreObjectRequestparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

publicstaticRestoreObjectRequestparseFrom(byte[]data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreObjectRequestparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

publicstaticRestoreObjectRequestparseFrom(ByteStringdata)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreObjectRequestparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

publicstaticRestoreObjectRequestparseFrom(CodedInputStreaminput)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreObjectRequestparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

publicstaticRestoreObjectRequestparseFrom(InputStreaminput)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreObjectRequestparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

publicstaticRestoreObjectRequestparseFrom(ByteBufferdata)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

publicstaticRestoreObjectRequestparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
RestoreObjectRequest
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

publicstaticParser<RestoreObjectRequest>parser()
Returns
TypeDescription
Parser<RestoreObjectRequest>

Methods

equals(Object obj)

publicbooleanequals(Objectobj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getBucket()

publicStringgetBucket()

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

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

Returns
TypeDescription
String

The bucket.

getBucketBytes()

publicByteStringgetBucketBytes()

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

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

Returns
TypeDescription
ByteString

The bytes for bucket.

getCommonObjectRequestParams()

publicCommonObjectRequestParamsgetCommonObjectRequestParams()

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

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

Returns
TypeDescription
CommonObjectRequestParams

The commonObjectRequestParams.

getCommonObjectRequestParamsOrBuilder()

publicCommonObjectRequestParamsOrBuildergetCommonObjectRequestParamsOrBuilder()

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

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

Returns
TypeDescription
CommonObjectRequestParamsOrBuilder

getCopySourceAcl()

publicbooleangetCopySourceAcl()

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
TypeDescription
boolean

The copySourceAcl.

getDefaultInstanceForType()

publicRestoreObjectRequestgetDefaultInstanceForType()
Returns
TypeDescription
RestoreObjectRequest

getGeneration()

publiclonggetGeneration()

Required. The specific revision of the object to restore.

int64 generation = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
long

The generation.

getIfGenerationMatch()

publiclonggetIfGenerationMatch()

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
TypeDescription
long

The ifGenerationMatch.

getIfGenerationNotMatch()

publiclonggetIfGenerationNotMatch()

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
TypeDescription
long

The ifGenerationNotMatch.

getIfMetagenerationMatch()

publiclonggetIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 6;

Returns
TypeDescription
long

The ifMetagenerationMatch.

getIfMetagenerationNotMatch()

publiclonggetIfMetagenerationNotMatch()

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
TypeDescription
long

The ifMetagenerationNotMatch.

getObject()

publicStringgetObject()

Required. The name of the object to restore.

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

Returns
TypeDescription
String

The object.

getObjectBytes()

publicByteStringgetObjectBytes()

Required. The name of the object to restore.

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

Returns
TypeDescription
ByteString

The bytes for object.

getParserForType()

publicParser<RestoreObjectRequest>getParserForType()
Returns
TypeDescription
Parser<RestoreObjectRequest>
Overrides

getRestoreToken()

publicStringgetRestoreToken()

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
TypeDescription
String

The restoreToken.

getRestoreTokenBytes()

publicByteStringgetRestoreTokenBytes()

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
TypeDescription
ByteString

The bytes for restoreToken.

getSerializedSize()

publicintgetSerializedSize()
Returns
TypeDescription
int
Overrides

hasCommonObjectRequestParams()

publicbooleanhasCommonObjectRequestParams()

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

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

Returns
TypeDescription
boolean

Whether the commonObjectRequestParams field is set.

hasCopySourceAcl()

publicbooleanhasCopySourceAcl()

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
TypeDescription
boolean

Whether the copySourceAcl field is set.

hasIfGenerationMatch()

publicbooleanhasIfGenerationMatch()

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
TypeDescription
boolean

Whether the ifGenerationMatch field is set.

hasIfGenerationNotMatch()

publicbooleanhasIfGenerationNotMatch()

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
TypeDescription
boolean

Whether the ifGenerationNotMatch field is set.

hasIfMetagenerationMatch()

publicbooleanhasIfMetagenerationMatch()

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

optional int64 if_metageneration_match = 6;

Returns
TypeDescription
boolean

Whether the ifMetagenerationMatch field is set.

hasIfMetagenerationNotMatch()

publicbooleanhasIfMetagenerationNotMatch()

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
TypeDescription
boolean

Whether the ifMetagenerationNotMatch field is set.

hashCode()

publicinthashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

publicfinalbooleanisInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

publicRestoreObjectRequest.BuildernewBuilderForType()
Returns
TypeDescription
RestoreObjectRequest.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protectedRestoreObjectRequest.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
RestoreObjectRequest.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

publicRestoreObjectRequest.BuildertoBuilder()
Returns
TypeDescription
RestoreObjectRequest.Builder

writeTo(CodedOutputStream output)

publicvoidwriteTo(CodedOutputStreamoutput)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException