Package com.google.storage.v2

Class RestoreObjectRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.RestoreObjectRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, RestoreObjectRequestOrBuilder, Serializable
public final class RestoreObjectRequest extends com.google.protobuf.GeneratedMessageV3 implements RestoreObjectRequestOrBuilder
 Message for restoring an object.
 `bucket`, `object`, and `generation` **must** be set.
Protobuf type google.storage.v2.RestoreObjectRequest
See Also:

  • Field Details

    • BUCKET_FIELD_NUMBER

      public static final int BUCKET_FIELD_NUMBER
      See Also:

    • OBJECT_FIELD_NUMBER

      public static final int OBJECT_FIELD_NUMBER
      See Also:

    • GENERATION_FIELD_NUMBER

      public static final int GENERATION_FIELD_NUMBER
      See Also:

    • RESTORE_TOKEN_FIELD_NUMBER

      public static final int RESTORE_TOKEN_FIELD_NUMBER
      See Also:

    • IF_GENERATION_MATCH_FIELD_NUMBER

      public static final int IF_GENERATION_MATCH_FIELD_NUMBER
      See Also:

    • IF_GENERATION_NOT_MATCH_FIELD_NUMBER

      public static final int IF_GENERATION_NOT_MATCH_FIELD_NUMBER
      See Also:

    • IF_METAGENERATION_MATCH_FIELD_NUMBER

      public static final int IF_METAGENERATION_MATCH_FIELD_NUMBER
      See Also:

    • IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER

      public static final int IF_METAGENERATION_NOT_MATCH_FIELD_NUMBER
      See Also:

    • COPY_SOURCE_ACL_FIELD_NUMBER

      public static final int COPY_SOURCE_ACL_FIELD_NUMBER
      See Also:

    • COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER

      public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • 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) = { ... }
      Specified by:
      getBucket in interface RestoreObjectRequestOrBuilder
      Returns:
      The bucket.

    • getBucketBytes

      public com.google.protobuf.ByteString getBucketBytes()
       Required. Name of the bucket in which the object resides.
      string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getBucketBytes in interface RestoreObjectRequestOrBuilder
      Returns:
      The bytes for bucket.

    • getObject

      public String getObject()
       Required. The name of the object to restore.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getObject in interface RestoreObjectRequestOrBuilder
      Returns:
      The object.

    • getObjectBytes

      public com.google.protobuf.ByteString getObjectBytes()
       Required. The name of the object to restore.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getObjectBytes in interface RestoreObjectRequestOrBuilder
      Returns:
      The bytes for object.

    • getGeneration

      public long getGeneration()
       Required. The specific revision of the object to restore.
      int64 generation = 3 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getGeneration in interface RestoreObjectRequestOrBuilder
      Returns:
      The generation.

    • 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];
      Specified by:
      getRestoreToken in interface RestoreObjectRequestOrBuilder
      Returns:
      The restoreToken.

    • getRestoreTokenBytes

      public com.google.protobuf.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];
      Specified by:
      getRestoreTokenBytes in interface RestoreObjectRequestOrBuilder
      Returns:
      The bytes for restoreToken.

    • 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;
      Specified by:
      hasIfGenerationMatch in interface RestoreObjectRequestOrBuilder
      Returns:
      Whether the ifGenerationMatch field is set.

    • 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;
      Specified by:
      getIfGenerationMatch in interface RestoreObjectRequestOrBuilder
      Returns:
      The ifGenerationMatch.

    • 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;
      Specified by:
      hasIfGenerationNotMatch in interface RestoreObjectRequestOrBuilder
      Returns:
      Whether the ifGenerationNotMatch field is set.

    • 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;
      Specified by:
      getIfGenerationNotMatch in interface RestoreObjectRequestOrBuilder
      Returns:
      The ifGenerationNotMatch.

    • hasIfMetagenerationMatch

      public boolean hasIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 6;
      Specified by:
      hasIfMetagenerationMatch in interface RestoreObjectRequestOrBuilder
      Returns:
      Whether the ifMetagenerationMatch field is set.

    • getIfMetagenerationMatch

      public long getIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 6;
      Specified by:
      getIfMetagenerationMatch in interface RestoreObjectRequestOrBuilder
      Returns:
      The ifMetagenerationMatch.

    • 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 = 7;
      Specified by:
      hasIfMetagenerationNotMatch in interface RestoreObjectRequestOrBuilder
      Returns:
      Whether the ifMetagenerationNotMatch field is set.

    • 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 = 7;
      Specified by:
      getIfMetagenerationNotMatch in interface RestoreObjectRequestOrBuilder
      Returns:
      The ifMetagenerationNotMatch.

    • 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;
      Specified by:
      hasCopySourceAcl in interface RestoreObjectRequestOrBuilder
      Returns:
      Whether the copySourceAcl field is set.

    • 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;
      Specified by:
      getCopySourceAcl in interface RestoreObjectRequestOrBuilder
      Returns:
      The copySourceAcl.

    • 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];
      Specified by:
      hasCommonObjectRequestParams in interface RestoreObjectRequestOrBuilder
      Returns:
      Whether the commonObjectRequestParams field is set.

    • 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];
      Specified by:
      getCommonObjectRequestParams in interface RestoreObjectRequestOrBuilder
      Returns:
      The commonObjectRequestParams.

    • 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];
      Specified by:
      getCommonObjectRequestParamsOrBuilder in interface RestoreObjectRequestOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static RestoreObjectRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreObjectRequest parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreObjectRequest parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreObjectRequest parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreObjectRequest parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreObjectRequest parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static RestoreObjectRequest parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RestoreObjectRequest parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RestoreObjectRequest parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static RestoreObjectRequest parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RestoreObjectRequest parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static RestoreObjectRequest parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public RestoreObjectRequest.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static RestoreObjectRequest.Builder newBuilder()

    • newBuilder

      public static RestoreObjectRequest.Builder newBuilder(RestoreObjectRequest prototype)

    • toBuilder

      public RestoreObjectRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected RestoreObjectRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static RestoreObjectRequest getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<RestoreObjectRequest> parser()

    • getParserForType

      public com.google.protobuf.Parser<RestoreObjectRequest> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public RestoreObjectRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder