Class InitialSubscribeRequest

  • All Implemented Interfaces:
    InitialSubscribeRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

    public final class InitialSubscribeRequest
    extends com.google.protobuf.GeneratedMessageV3
    implements InitialSubscribeRequestOrBuilder
     The first request that must be sent on a newly-opened stream. The client must
     wait for the response before sending subsequent requests on the stream.
     
    Protobuf type google.cloud.pubsublite.v1.InitialSubscribeRequest
    See Also:
    Serialized Form
    • Field Detail

      • SUBSCRIPTION_FIELD_NUMBER

        public static final int SUBSCRIPTION_FIELD_NUMBER
        See Also:
        Constant Field Values
      • INITIAL_LOCATION_FIELD_NUMBER

        public static final int INITIAL_LOCATION_FIELD_NUMBER
        See Also:
        Constant Field Values
    • Method Detail

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

        public com.google.protobuf.ByteString getSubscriptionBytes()
         The subscription from which to receive messages.
         
        string subscription = 1;
        Specified by:
        getSubscriptionBytes in interface InitialSubscribeRequestOrBuilder
        Returns:
        The bytes for subscription.
      • getPartition

        public long getPartition()
         The partition from which to receive messages. Partitions are zero indexed,
         so `partition` must be in the range [0, topic.num_partitions).
         
        int64 partition = 2;
        Specified by:
        getPartition in interface InitialSubscribeRequestOrBuilder
        Returns:
        The partition.
      • hasInitialLocation

        public boolean hasInitialLocation()
         Optional. Initial target location within the message backlog. If not set,
         messages will be delivered from the commit cursor for the given
         subscription and partition.
         
        .google.cloud.pubsublite.v1.SeekRequest initial_location = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        hasInitialLocation in interface InitialSubscribeRequestOrBuilder
        Returns:
        Whether the initialLocation field is set.
      • getInitialLocation

        public SeekRequest getInitialLocation()
         Optional. Initial target location within the message backlog. If not set,
         messages will be delivered from the commit cursor for the given
         subscription and partition.
         
        .google.cloud.pubsublite.v1.SeekRequest initial_location = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getInitialLocation in interface InitialSubscribeRequestOrBuilder
        Returns:
        The initialLocation.
      • getInitialLocationOrBuilder

        public SeekRequestOrBuilder getInitialLocationOrBuilder()
         Optional. Initial target location within the message backlog. If not set,
         messages will be delivered from the commit cursor for the given
         subscription and partition.
         
        .google.cloud.pubsublite.v1.SeekRequest initial_location = 4 [(.google.api.field_behavior) = OPTIONAL];
        Specified by:
        getInitialLocationOrBuilder in interface InitialSubscribeRequestOrBuilder
      • 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 InitialSubscribeRequest parseFrom​(ByteBuffer data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

        public static InitialSubscribeRequest parseFrom​(com.google.protobuf.ByteString data)
                                                 throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

        protected InitialSubscribeRequest.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3
      • getParserForType

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