Class SubscriptionQueryRequest

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

    @Generated
    public final class SubscriptionQueryRequest
    extends com.google.protobuf.GeneratedMessage
    implements SubscriptionQueryRequestOrBuilder
     Message describing possible interactions for a Subscription Query 
     
    Protobuf type io.axoniq.axonserver.grpc.query.SubscriptionQueryRequest
    See Also:
    Serialized Form
    • Field Detail

      • UNSUBSCRIBE_FIELD_NUMBER

        public static final int UNSUBSCRIBE_FIELD_NUMBER
        See Also:
        Constant Field Values
      • GET_INITIAL_RESULT_FIELD_NUMBER

        public static final int GET_INITIAL_RESULT_FIELD_NUMBER
        See Also:
        Constant Field Values
      • FLOW_CONTROL_FIELD_NUMBER

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

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
      • getDescriptorForType

        public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
        Specified by:
        getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
        Overrides:
        getDescriptorForType in class com.google.protobuf.GeneratedMessage
      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
      • hasSubscribe

        public boolean hasSubscribe()
         Start a Subscription Query with the given details. 
         
        .io.axoniq.axonserver.grpc.query.SubscriptionQuery subscribe = 1;
        Specified by:
        hasSubscribe in interface SubscriptionQueryRequestOrBuilder
        Returns:
        Whether the subscribe field is set.
      • hasUnsubscribe

        public boolean hasUnsubscribe()
         Ends a previously started Subscription Query with the given details 
         
        .io.axoniq.axonserver.grpc.query.SubscriptionQuery unsubscribe = 2;
        Specified by:
        hasUnsubscribe in interface SubscriptionQueryRequestOrBuilder
        Returns:
        Whether the unsubscribe field is set.
      • hasGetInitialResult

        @Deprecated
        public boolean hasGetInitialResult()
        Deprecated.
        io.axoniq.axonserver.grpc.query.SubscriptionQueryRequest.get_initial_result is deprecated. See query.proto;l=251
         Requests the initial result of a subscription query to be sent. This should always be done after opening the
         subscription query itself, to remove concurrency conflicts with Update messages.
        
         Note that this request is deprecated. It is recommended to retrieve the initial request using a regular query.
         
        .io.axoniq.axonserver.grpc.query.SubscriptionQuery get_initial_result = 3 [deprecated = true];
        Specified by:
        hasGetInitialResult in interface SubscriptionQueryRequestOrBuilder
        Returns:
        Whether the getInitialResult field is set.
      • getGetInitialResult

        @Deprecated
        public SubscriptionQuery getGetInitialResult()
        Deprecated.
        io.axoniq.axonserver.grpc.query.SubscriptionQueryRequest.get_initial_result is deprecated. See query.proto;l=251
         Requests the initial result of a subscription query to be sent. This should always be done after opening the
         subscription query itself, to remove concurrency conflicts with Update messages.
        
         Note that this request is deprecated. It is recommended to retrieve the initial request using a regular query.
         
        .io.axoniq.axonserver.grpc.query.SubscriptionQuery get_initial_result = 3 [deprecated = true];
        Specified by:
        getGetInitialResult in interface SubscriptionQueryRequestOrBuilder
        Returns:
        The getInitialResult.
      • getGetInitialResultOrBuilder

        @Deprecated
        public SubscriptionQueryOrBuilder getGetInitialResultOrBuilder()
        Deprecated.
         Requests the initial result of a subscription query to be sent. This should always be done after opening the
         subscription query itself, to remove concurrency conflicts with Update messages.
        
         Note that this request is deprecated. It is recommended to retrieve the initial request using a regular query.
         
        .io.axoniq.axonserver.grpc.query.SubscriptionQuery get_initial_result = 3 [deprecated = true];
        Specified by:
        getGetInitialResultOrBuilder in interface SubscriptionQueryRequestOrBuilder
      • hasFlowControl

        public boolean hasFlowControl()
         Allows the Server to provide additional Updates to be sent. Only the `number_of_permits` field needs to be
         set on this message.
         
        .io.axoniq.axonserver.grpc.query.SubscriptionQuery flow_control = 4;
        Specified by:
        hasFlowControl in interface SubscriptionQueryRequestOrBuilder
        Returns:
        Whether the flowControl field is set.
      • getFlowControl

        public SubscriptionQuery getFlowControl()
         Allows the Server to provide additional Updates to be sent. Only the `number_of_permits` field needs to be
         set on this message.
         
        .io.axoniq.axonserver.grpc.query.SubscriptionQuery flow_control = 4;
        Specified by:
        getFlowControl in interface SubscriptionQueryRequestOrBuilder
        Returns:
        The flowControl.
      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessage
      • 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.GeneratedMessage
        Throws:
        IOException
      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessage
      • 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 SubscriptionQueryRequest parseFrom​(ByteBuffer data)
                                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException
      • parseFrom

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

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

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

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

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

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

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

        protected SubscriptionQueryRequest.Builder newBuilderForType​(com.google.protobuf.AbstractMessage.BuilderParent parent)
        Overrides:
        newBuilderForType in class com.google.protobuf.AbstractMessage
      • getParserForType

        public com.google.protobuf.Parser<SubscriptionQueryRequest> 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.GeneratedMessage
      • getDefaultInstanceForType

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