Package com.google.storage.v2

Interface RestoreObjectRequestOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
RestoreObjectRequest, RestoreObjectRequest.Builder
public interface RestoreObjectRequestOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getBucket()
    Required.
    com.google.protobuf.ByteString
    getBucketBytes()
    Required.
    CommonObjectRequestParams
    getCommonObjectRequestParams()
    A set of parameters common to Storage API requests concerning an object.
    CommonObjectRequestParamsOrBuilder
    getCommonObjectRequestParamsOrBuilder()
    A set of parameters common to Storage API requests concerning an object.
    boolean
    getCopySourceAcl()
    If false or unset, the bucket's default object ACL will be used.
    long
    getGeneration()
    Required.
    long
    getIfGenerationMatch()
    Makes the operation conditional on whether the object's current generation matches the given value.
    long
    getIfGenerationNotMatch()
    Makes the operation conditional on whether the object's live generation does not match the given value.
    long
    getIfMetagenerationMatch()
    Makes the operation conditional on whether the object's current metageneration matches the given value.
    long
    getIfMetagenerationNotMatch()
    Makes the operation conditional on whether the object's current metageneration does not match the given value.
    String
    getObject()
    Required.
    com.google.protobuf.ByteString
    getObjectBytes()
    Required.
    String
    getRestoreToken()
    Optional.
    com.google.protobuf.ByteString
    getRestoreTokenBytes()
    Optional.
    boolean
    hasCommonObjectRequestParams()
    A set of parameters common to Storage API requests concerning an object.
    boolean
    hasCopySourceAcl()
    If false or unset, the bucket's default object ACL will be used.
    boolean
    hasIfGenerationMatch()
    Makes the operation conditional on whether the object's current generation matches the given value.
    boolean
    hasIfGenerationNotMatch()
    Makes the operation conditional on whether the object's live generation does not match the given value.
    boolean
    hasIfMetagenerationMatch()
    Makes the operation conditional on whether the object's current metageneration matches the given value.
    boolean
    hasIfMetagenerationNotMatch()
    Makes the operation conditional on whether the object's current metageneration does not match the given value.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getBucket

      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:
      The bucket.

    • getBucketBytes

      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) = { ... }
      Returns:
      The bytes for bucket.

    • getObject

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

    • getObjectBytes

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

    • getGeneration

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

    • getRestoreToken

      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:
      The restoreToken.

    • getRestoreTokenBytes

      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];
      Returns:
      The bytes for restoreToken.

    • hasIfGenerationMatch

      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:
      Whether the ifGenerationMatch field is set.

    • getIfGenerationMatch

      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:
      The ifGenerationMatch.

    • hasIfGenerationNotMatch

      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:
      Whether the ifGenerationNotMatch field is set.

    • getIfGenerationNotMatch

      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:
      The ifGenerationNotMatch.

    • hasIfMetagenerationMatch

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

    • getIfMetagenerationMatch

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

    • hasIfMetagenerationNotMatch

      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:
      Whether the ifMetagenerationNotMatch field is set.

    • getIfMetagenerationNotMatch

      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:
      The ifMetagenerationNotMatch.

    • hasCopySourceAcl

      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:
      Whether the copySourceAcl field is set.

    • getCopySourceAcl

      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:
      The copySourceAcl.

    • hasCommonObjectRequestParams

      boolean hasCommonObjectRequestParams()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
      Returns:
      Whether the commonObjectRequestParams field is set.

    • getCommonObjectRequestParams

      CommonObjectRequestParams getCommonObjectRequestParams()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
      Returns:
      The commonObjectRequestParams.

    • getCommonObjectRequestParamsOrBuilder

      CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;