Package com.google.storage.v2

Class BidiReadObjectSpec

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.google.storage.v2.BidiReadObjectSpec
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, BidiReadObjectSpecOrBuilder, Serializable
public final class BidiReadObjectSpec extends com.google.protobuf.GeneratedMessageV3 implements BidiReadObjectSpecOrBuilder
 Describes the object to read in a BidiReadObject request.
Protobuf type google.storage.v2.BidiReadObjectSpec
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:

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

    • READ_HANDLE_FIELD_NUMBER

      public static final int READ_HANDLE_FIELD_NUMBER
      See Also:

    • ROUTING_TOKEN_FIELD_NUMBER

      public static final int ROUTING_TOKEN_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. The name of the bucket containing the object to read.
      string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getBucket in interface BidiReadObjectSpecOrBuilder
      Returns:
      The bucket.

    • getBucketBytes

      public com.google.protobuf.ByteString getBucketBytes()
       Required. The name of the bucket containing the object to read.
      string bucket = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }
      Specified by:
      getBucketBytes in interface BidiReadObjectSpecOrBuilder
      Returns:
      The bytes for bucket.

    • getObject

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

    • getObjectBytes

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

    • getGeneration

      public long getGeneration()
       Optional. If present, selects a specific revision of this object (as
 opposed to the latest version, the default).
      int64 generation = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGeneration in interface BidiReadObjectSpecOrBuilder
      Returns:
      The generation.

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

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

    • hasReadMask

      @Deprecated public boolean hasReadMask()
      Deprecated.
      google.storage.v2.BidiReadObjectSpec.read_mask is deprecated. See google/storage/v2/storage.proto;l=1027
       Mask specifying which fields to read.
 The checksummed_data field and its children will always be present.
 If no mask is specified, will default to all fields except metadata.owner
 and metadata.acl.
 * may be used to mean "all fields".
 As per https://google.aip.dev/161, this field is deprecated.
 As an alternative, grpc metadata can be used:
 https://cloud.google.com/apis/docs/system-parameters#definitions
      optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];
      Specified by:
      hasReadMask in interface BidiReadObjectSpecOrBuilder
      Returns:
      Whether the readMask field is set.

    • getReadMask

      @Deprecated public com.google.protobuf.FieldMask getReadMask()
      Deprecated.
      google.storage.v2.BidiReadObjectSpec.read_mask is deprecated. See google/storage/v2/storage.proto;l=1027
       Mask specifying which fields to read.
 The checksummed_data field and its children will always be present.
 If no mask is specified, will default to all fields except metadata.owner
 and metadata.acl.
 * may be used to mean "all fields".
 As per https://google.aip.dev/161, this field is deprecated.
 As an alternative, grpc metadata can be used:
 https://cloud.google.com/apis/docs/system-parameters#definitions
      optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];
      Specified by:
      getReadMask in interface BidiReadObjectSpecOrBuilder
      Returns:
      The readMask.

    • getReadMaskOrBuilder

      @Deprecated public com.google.protobuf.FieldMaskOrBuilder getReadMaskOrBuilder()
      Deprecated.
       Mask specifying which fields to read.
 The checksummed_data field and its children will always be present.
 If no mask is specified, will default to all fields except metadata.owner
 and metadata.acl.
 * may be used to mean "all fields".
 As per https://google.aip.dev/161, this field is deprecated.
 As an alternative, grpc metadata can be used:
 https://cloud.google.com/apis/docs/system-parameters#definitions
      optional .google.protobuf.FieldMask read_mask = 12 [deprecated = true];
      Specified by:
      getReadMaskOrBuilder in interface BidiReadObjectSpecOrBuilder

    • hasReadHandle

      public boolean hasReadHandle()
       The client can optionally set this field. The read handle is an optimized
 way of creating new streams. Read handles are generated and periodically
 refreshed from prior reads.
      optional .google.storage.v2.BidiReadHandle read_handle = 13;
      Specified by:
      hasReadHandle in interface BidiReadObjectSpecOrBuilder
      Returns:
      Whether the readHandle field is set.

    • getReadHandle

      public BidiReadHandle getReadHandle()
       The client can optionally set this field. The read handle is an optimized
 way of creating new streams. Read handles are generated and periodically
 refreshed from prior reads.
      optional .google.storage.v2.BidiReadHandle read_handle = 13;
      Specified by:
      getReadHandle in interface BidiReadObjectSpecOrBuilder
      Returns:
      The readHandle.

    • getReadHandleOrBuilder

      public BidiReadHandleOrBuilder getReadHandleOrBuilder()
       The client can optionally set this field. The read handle is an optimized
 way of creating new streams. Read handles are generated and periodically
 refreshed from prior reads.
      optional .google.storage.v2.BidiReadHandle read_handle = 13;
      Specified by:
      getReadHandleOrBuilder in interface BidiReadObjectSpecOrBuilder

    • hasRoutingToken

      public boolean hasRoutingToken()
       The routing token that influences request routing for the stream. Must be
 provided if a BidiReadObjectRedirectedError is returned.
      optional string routing_token = 14;
      Specified by:
      hasRoutingToken in interface BidiReadObjectSpecOrBuilder
      Returns:
      Whether the routingToken field is set.

    • getRoutingToken

      public String getRoutingToken()
       The routing token that influences request routing for the stream. Must be
 provided if a BidiReadObjectRedirectedError is returned.
      optional string routing_token = 14;
      Specified by:
      getRoutingToken in interface BidiReadObjectSpecOrBuilder
      Returns:
      The routingToken.

    • getRoutingTokenBytes

      public com.google.protobuf.ByteString getRoutingTokenBytes()
       The routing token that influences request routing for the stream. Must be
 provided if a BidiReadObjectRedirectedError is returned.
      optional string routing_token = 14;
      Specified by:
      getRoutingTokenBytes in interface BidiReadObjectSpecOrBuilder
      Returns:
      The bytes for routingToken.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static BidiReadObjectSpec.Builder newBuilder()

    • newBuilder

      public static BidiReadObjectSpec.Builder newBuilder(BidiReadObjectSpec prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static BidiReadObjectSpec getDefaultInstance()

    • parser

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

    • getParserForType

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