Package com.google.storage.v2

Class GetObjectRequest

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.GetObjectRequest
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, GetObjectRequestOrBuilder, Serializable
public final class GetObjectRequest extends com.google.protobuf.GeneratedMessageV3 implements GetObjectRequestOrBuilder
 Request message for GetObject.
Protobuf type google.storage.v2.GetObjectRequest
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:

    • SOFT_DELETED_FIELD_NUMBER

      public static final int SOFT_DELETED_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:

    • COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER

      public static final int COMMON_OBJECT_REQUEST_PARAMS_FIELD_NUMBER
      See Also:

    • READ_MASK_FIELD_NUMBER

      public static final int READ_MASK_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 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.

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

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

    • hasSoftDeleted

      public boolean hasSoftDeleted()
       If true, return the soft-deleted version of this object.
      optional bool soft_deleted = 11;
      Specified by:
      hasSoftDeleted in interface GetObjectRequestOrBuilder
      Returns:
      Whether the softDeleted field is set.

    • getSoftDeleted

      public boolean getSoftDeleted()
       If true, return the soft-deleted version of this object.
      optional bool soft_deleted = 11;
      Specified by:
      getSoftDeleted in interface GetObjectRequestOrBuilder
      Returns:
      The softDeleted.

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

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

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

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

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

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

    • 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

    • 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 GetObjectRequest parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GetObjectRequest.Builder newBuilder()

    • newBuilder

      public static GetObjectRequest.Builder newBuilder(GetObjectRequest prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GetObjectRequest getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<GetObjectRequest> 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 GetObjectRequest getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder