Package com.google.storage.v2

Class RestoreObjectRequest.Builder

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

  • Method Details

    • 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.Builder<RestoreObjectRequest.Builder>

    • clear

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

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreObjectRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

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

    • setField

      public RestoreObjectRequest.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      setField in interface com.google.protobuf.Message.Builder
      Overrides:
      setField in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreObjectRequest.Builder>

    • clearField

      public RestoreObjectRequest.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
      Specified by:
      clearField in interface com.google.protobuf.Message.Builder
      Overrides:
      clearField in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreObjectRequest.Builder>

    • clearOneof

      public RestoreObjectRequest.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
      Specified by:
      clearOneof in interface com.google.protobuf.Message.Builder
      Overrides:
      clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreObjectRequest.Builder>

    • setRepeatedField

      public RestoreObjectRequest.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)
      Specified by:
      setRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreObjectRequest.Builder>

    • addRepeatedField

      public RestoreObjectRequest.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)
      Specified by:
      addRepeatedField in interface com.google.protobuf.Message.Builder
      Overrides:
      addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreObjectRequest.Builder>

    • mergeFrom

      public RestoreObjectRequest.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RestoreObjectRequest.Builder>

    • mergeFrom

      public RestoreObjectRequest.Builder mergeFrom(RestoreObjectRequest other)

    • isInitialized

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

    • mergeFrom

      public RestoreObjectRequest.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<RestoreObjectRequest.Builder>
      Throws:
      IOException

    • 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.

    • setBucket

      public RestoreObjectRequest.Builder setBucket(String value)
       Required. Name of the bucket in which the object resides.
      string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bucket to set.
      Returns:
      This builder for chaining.

    • clearBucket

      public RestoreObjectRequest.Builder clearBucket()
       Required. Name of the bucket in which the object resides.
      string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Returns:
      This builder for chaining.

    • setBucketBytes

      public RestoreObjectRequest.Builder setBucketBytes(com.google.protobuf.ByteString value)
       Required. Name of the bucket in which the object resides.
      string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Parameters:
      value - The bytes for bucket to set.
      Returns:
      This builder for chaining.

    • 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.

    • setObject

      public RestoreObjectRequest.Builder setObject(String value)
       Required. The name of the object to restore.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The object to set.
      Returns:
      This builder for chaining.

    • clearObject

      public RestoreObjectRequest.Builder clearObject()
       Required. The name of the object to restore.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setObjectBytes

      public RestoreObjectRequest.Builder setObjectBytes(com.google.protobuf.ByteString value)
       Required. The name of the object to restore.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The bytes for object to set.
      Returns:
      This builder for chaining.

    • 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.

    • setGeneration

      public RestoreObjectRequest.Builder setGeneration(long value)
       Required. The specific revision of the object to restore.
      int64 generation = 3 [(.google.api.field_behavior) = REQUIRED];
      Parameters:
      value - The generation to set.
      Returns:
      This builder for chaining.

    • clearGeneration

      public RestoreObjectRequest.Builder clearGeneration()
       Required. The specific revision of the object to restore.
      int64 generation = 3 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • 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.

    • setRestoreToken

      public RestoreObjectRequest.Builder setRestoreToken(String value)
       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];
      Parameters:
      value - The restoreToken to set.
      Returns:
      This builder for chaining.

    • clearRestoreToken

      public RestoreObjectRequest.Builder clearRestoreToken()
       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:
      This builder for chaining.

    • setRestoreTokenBytes

      public RestoreObjectRequest.Builder setRestoreTokenBytes(com.google.protobuf.ByteString value)
       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];
      Parameters:
      value - The bytes for restoreToken to set.
      Returns:
      This builder for chaining.

    • 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.

    • setIfGenerationMatch

      public RestoreObjectRequest.Builder setIfGenerationMatch(long value)
       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;
      Parameters:
      value - The ifGenerationMatch to set.
      Returns:
      This builder for chaining.

    • clearIfGenerationMatch

      public RestoreObjectRequest.Builder clearIfGenerationMatch()
       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:
      This builder for chaining.

    • 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.

    • setIfGenerationNotMatch

      public RestoreObjectRequest.Builder setIfGenerationNotMatch(long value)
       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;
      Parameters:
      value - The ifGenerationNotMatch to set.
      Returns:
      This builder for chaining.

    • clearIfGenerationNotMatch

      public RestoreObjectRequest.Builder clearIfGenerationNotMatch()
       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:
      This builder for chaining.

    • 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.

    • setIfMetagenerationMatch

      public RestoreObjectRequest.Builder setIfMetagenerationMatch(long value)
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 6;
      Parameters:
      value - The ifMetagenerationMatch to set.
      Returns:
      This builder for chaining.

    • clearIfMetagenerationMatch

      public RestoreObjectRequest.Builder clearIfMetagenerationMatch()
       Makes the operation conditional on whether the object's current
 metageneration matches the given value.
      optional int64 if_metageneration_match = 6;
      Returns:
      This builder for chaining.

    • 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.

    • setIfMetagenerationNotMatch

      public RestoreObjectRequest.Builder setIfMetagenerationNotMatch(long value)
       Makes the operation conditional on whether the object's current
 metageneration does not match the given value.
      optional int64 if_metageneration_not_match = 7;
      Parameters:
      value - The ifMetagenerationNotMatch to set.
      Returns:
      This builder for chaining.

    • clearIfMetagenerationNotMatch

      public RestoreObjectRequest.Builder clearIfMetagenerationNotMatch()
       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:
      This builder for chaining.

    • 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.

    • setCopySourceAcl

      public RestoreObjectRequest.Builder setCopySourceAcl(boolean value)
       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;
      Parameters:
      value - The copySourceAcl to set.
      Returns:
      This builder for chaining.

    • clearCopySourceAcl

      public RestoreObjectRequest.Builder clearCopySourceAcl()
       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:
      This builder for chaining.

    • hasCommonObjectRequestParams

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

    • getCommonObjectRequestParams

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

    • setCommonObjectRequestParams

      public RestoreObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams value)
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

    • setCommonObjectRequestParams

      public RestoreObjectRequest.Builder setCommonObjectRequestParams(CommonObjectRequestParams.Builder builderForValue)
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

    • mergeCommonObjectRequestParams

      public RestoreObjectRequest.Builder mergeCommonObjectRequestParams(CommonObjectRequestParams value)
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

    • clearCommonObjectRequestParams

      public RestoreObjectRequest.Builder clearCommonObjectRequestParams()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;

    • getCommonObjectRequestParamsBuilder

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

    • getCommonObjectRequestParamsOrBuilder

      public CommonObjectRequestParamsOrBuilder getCommonObjectRequestParamsOrBuilder()
       A set of parameters common to Storage API requests concerning an object.
      .google.storage.v2.CommonObjectRequestParams common_object_request_params = 8;
      Specified by:
      getCommonObjectRequestParamsOrBuilder in interface RestoreObjectRequestOrBuilder

    • setUnknownFields

      public final RestoreObjectRequest.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      setUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreObjectRequest.Builder>

    • mergeUnknownFields

      public final RestoreObjectRequest.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
      Specified by:
      mergeUnknownFields in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<RestoreObjectRequest.Builder>