Package com.google.storage.v2

Class GetObjectRequest.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder>
com.google.storage.v2.GetObjectRequest.Builder
All Implemented Interfaces:
com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GetObjectRequestOrBuilder, Cloneable
Enclosing class:
GetObjectRequest
public static final class GetObjectRequest.Builder extends com.google.protobuf.GeneratedMessageV3.Builder<GetObjectRequest.Builder> implements GetObjectRequestOrBuilder
 Request message for GetObject.
Protobuf type google.storage.v2.GetObjectRequest

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

    • clear

      public GetObjectRequest.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<GetObjectRequest.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<GetObjectRequest.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • clone

      public GetObjectRequest.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<GetObjectRequest.Builder>

    • setField

      public GetObjectRequest.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<GetObjectRequest.Builder>

    • clearField

      public GetObjectRequest.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<GetObjectRequest.Builder>

    • clearOneof

      public GetObjectRequest.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<GetObjectRequest.Builder>

    • setRepeatedField

      public GetObjectRequest.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<GetObjectRequest.Builder>

    • addRepeatedField

      public GetObjectRequest.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<GetObjectRequest.Builder>

    • mergeFrom

      public GetObjectRequest.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<GetObjectRequest.Builder>

    • mergeFrom

      public GetObjectRequest.Builder mergeFrom(GetObjectRequest other)

    • isInitialized

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

    • mergeFrom

      public GetObjectRequest.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<GetObjectRequest.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 GetObjectRequestOrBuilder
      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 GetObjectRequestOrBuilder
      Returns:
      The bytes for bucket.

    • setBucket

      public GetObjectRequest.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 GetObjectRequest.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 GetObjectRequest.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. Name of the object.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getObject in interface GetObjectRequestOrBuilder
      Returns:
      The object.

    • getObjectBytes

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

    • setObject

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

    • clearObject

      public GetObjectRequest.Builder clearObject()
       Required. Name of the object.
      string object = 2 [(.google.api.field_behavior) = REQUIRED];
      Returns:
      This builder for chaining.

    • setObjectBytes

      public GetObjectRequest.Builder setObjectBytes(com.google.protobuf.ByteString value)
       Required. Name of the object.
      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()
       If present, selects a specific revision of this object (as opposed to the
 latest version, the default).
      int64 generation = 3;
      Specified by:
      getGeneration in interface GetObjectRequestOrBuilder
      Returns:
      The generation.

    • setGeneration

      public GetObjectRequest.Builder setGeneration(long value)
       If present, selects a specific revision of this object (as opposed to the
 latest version, the default).
      int64 generation = 3;
      Parameters:
      value - The generation to set.
      Returns:
      This builder for chaining.

    • clearGeneration

      public GetObjectRequest.Builder clearGeneration()
       If present, selects a specific revision of this object (as opposed to the
 latest version, the default).
      int64 generation = 3;
      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 GetObjectRequestOrBuilder
      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 GetObjectRequestOrBuilder
      Returns:
      The ifGenerationMatch.

    • setIfGenerationMatch

      public GetObjectRequest.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 GetObjectRequest.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 GetObjectRequestOrBuilder
      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 GetObjectRequestOrBuilder
      Returns:
      The ifGenerationNotMatch.

    • setIfGenerationNotMatch

      public GetObjectRequest.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 GetObjectRequest.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 GetObjectRequestOrBuilder
      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 GetObjectRequestOrBuilder
      Returns:
      The ifMetagenerationMatch.

    • setIfMetagenerationMatch

      public GetObjectRequest.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 GetObjectRequest.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 GetObjectRequestOrBuilder
      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 GetObjectRequestOrBuilder
      Returns:
      The ifMetagenerationNotMatch.

    • setIfMetagenerationNotMatch

      public GetObjectRequest.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 GetObjectRequest.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.

    • 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 GetObjectRequestOrBuilder
      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 GetObjectRequestOrBuilder
      Returns:
      The commonObjectRequestParams.

    • setCommonObjectRequestParams

      public GetObjectRequest.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 GetObjectRequest.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 GetObjectRequest.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 GetObjectRequest.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 GetObjectRequestOrBuilder

    • hasReadMask

      public boolean hasReadMask()
       Mask specifying which fields to read.
 If no mask is specified, will default to all fields except metadata.acl and
 metadata.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 10;
      Specified by:
      hasReadMask in interface GetObjectRequestOrBuilder
      Returns:
      Whether the readMask field is set.

    • getReadMask

      public com.google.protobuf.FieldMask getReadMask()
       Mask specifying which fields to read.
 If no mask is specified, will default to all fields except metadata.acl and
 metadata.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 10;
      Specified by:
      getReadMask in interface GetObjectRequestOrBuilder
      Returns:
      The readMask.

    • setReadMask

      public GetObjectRequest.Builder setReadMask(com.google.protobuf.FieldMask value)
       Mask specifying which fields to read.
 If no mask is specified, will default to all fields except metadata.acl and
 metadata.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 10;

    • setReadMask

      public GetObjectRequest.Builder setReadMask(com.google.protobuf.FieldMask.Builder builderForValue)
       Mask specifying which fields to read.
 If no mask is specified, will default to all fields except metadata.acl and
 metadata.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 10;

    • mergeReadMask

      public GetObjectRequest.Builder mergeReadMask(com.google.protobuf.FieldMask value)
       Mask specifying which fields to read.
 If no mask is specified, will default to all fields except metadata.acl and
 metadata.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 10;

    • clearReadMask

      public GetObjectRequest.Builder clearReadMask()
       Mask specifying which fields to read.
 If no mask is specified, will default to all fields except metadata.acl and
 metadata.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 10;

    • getReadMaskBuilder

      public com.google.protobuf.FieldMask.Builder getReadMaskBuilder()
       Mask specifying which fields to read.
 If no mask is specified, will default to all fields except metadata.acl and
 metadata.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 10;

    • getReadMaskOrBuilder

      public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
       Mask specifying which fields to read.
 If no mask is specified, will default to all fields except metadata.acl and
 metadata.owner.
 * may be used to mean "all fields".
      optional .google.protobuf.FieldMask read_mask = 10;
      Specified by:
      getReadMaskOrBuilder in interface GetObjectRequestOrBuilder

    • setUnknownFields

      public final GetObjectRequest.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<GetObjectRequest.Builder>

    • mergeUnknownFields

      public final GetObjectRequest.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<GetObjectRequest.Builder>