Package uk.org.siri.www.siri

Class SubscriptionRequestType

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
uk.org.siri.www.siri.SubscriptionRequestType
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, SubscriptionRequestTypeOrBuilder
public final class SubscriptionRequestType extends com.google.protobuf.GeneratedMessage implements SubscriptionRequestTypeOrBuilder
 Request from Subscriber to Producer for a subscription. Answered with a SubscriptionResponse.  [siri/siri_base-v2.0.xsd at 144:42]
Protobuf type uk.org.siri.www.siri.SubscriptionRequestType
See Also:

  • Field Details

    • REQUEST_TIMESTAMP_FIELD_NUMBER

      public static final int REQUEST_TIMESTAMP_FIELD_NUMBER
      See Also:

    • ACCOUNT_ID_FIELD_NUMBER

      public static final int ACCOUNT_ID_FIELD_NUMBER
      See Also:

    • ACCOUNT_KEY_FIELD_NUMBER

      public static final int ACCOUNT_KEY_FIELD_NUMBER
      See Also:

    • ADDRESS_FIELD_NUMBER

      public static final int ADDRESS_FIELD_NUMBER
      See Also:

    • REQUESTOR_REF_FIELD_NUMBER

      public static final int REQUESTOR_REF_FIELD_NUMBER
      See Also:

    • MESSAGE_IDENTIFIER_FIELD_NUMBER

      public static final int MESSAGE_IDENTIFIER_FIELD_NUMBER
      See Also:

    • DELEGATOR_ADDRESS_FIELD_NUMBER

      public static final int DELEGATOR_ADDRESS_FIELD_NUMBER
      See Also:

    • DELEGATOR_REF_FIELD_NUMBER

      public static final int DELEGATOR_REF_FIELD_NUMBER
      See Also:

    • CONSUMER_ADDRESS_FIELD_NUMBER

      public static final int CONSUMER_ADDRESS_FIELD_NUMBER
      See Also:

    • SUBSCRIPTION_FILTER_IDENTIFIER_FIELD_NUMBER

      public static final int SUBSCRIPTION_FILTER_IDENTIFIER_FIELD_NUMBER
      See Also:

    • SUBSCRIPTION_CONTEXT_FIELD_NUMBER

      public static final int SUBSCRIPTION_CONTEXT_FIELD_NUMBER
      See Also:

    • ABSTRACT_FUNCTIONAL_SERVICE_SUBSCRIPTION_REQUEST_FIELD_NUMBER

      public static final int ABSTRACT_FUNCTIONAL_SERVICE_SUBSCRIPTION_REQUEST_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • hasRequestTimestamp

      public boolean hasRequestTimestamp()
       Timestamp on request.  [siri/siri_request_support-v2.0.xsd at 105:59]
      .google.protobuf.Timestamp request_timestamp = 1;
      Specified by:
      hasRequestTimestamp in interface SubscriptionRequestTypeOrBuilder
      Returns:
      Whether the requestTimestamp field is set.

    • getRequestTimestamp

      public com.google.protobuf.Timestamp getRequestTimestamp()
       Timestamp on request.  [siri/siri_request_support-v2.0.xsd at 105:59]
      .google.protobuf.Timestamp request_timestamp = 1;
      Specified by:
      getRequestTimestamp in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The requestTimestamp.

    • getRequestTimestampOrBuilder

      public com.google.protobuf.TimestampOrBuilder getRequestTimestampOrBuilder()
       Timestamp on request.  [siri/siri_request_support-v2.0.xsd at 105:59]
      .google.protobuf.Timestamp request_timestamp = 1;
      Specified by:
      getRequestTimestampOrBuilder in interface SubscriptionRequestTypeOrBuilder

    • getAccountId

      public String getAccountId()
       Account Identifier. May be used to attribute requests to a particular application provider and authentication key. The account  may be common to all users of an application, or to an individual user. Note that to identify an individual user the  RequestorRef can be used with an anonymised token.  .     +SIRI v2.0  [siri/siri_requests-v2.0.xsd at 162:67]
      string account_id = 21;
      Specified by:
      getAccountId in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The accountId.

    • getAccountIdBytes

      public com.google.protobuf.ByteString getAccountIdBytes()
       Account Identifier. May be used to attribute requests to a particular application provider and authentication key. The account  may be common to all users of an application, or to an individual user. Note that to identify an individual user the  RequestorRef can be used with an anonymised token.  .     +SIRI v2.0  [siri/siri_requests-v2.0.xsd at 162:67]
      string account_id = 21;
      Specified by:
      getAccountIdBytes in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The bytes for accountId.

    • getAccountKey

      public String getAccountKey()
       Authentication key for request. May be used to authenticate requests from a particular account. +SIRI v2.0  [siri/siri_requests-v2.0.xsd at 167:77]
      string account_key = 22;
      Specified by:
      getAccountKey in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The accountKey.

    • getAccountKeyBytes

      public com.google.protobuf.ByteString getAccountKeyBytes()
       Authentication key for request. May be used to authenticate requests from a particular account. +SIRI v2.0  [siri/siri_requests-v2.0.xsd at 167:77]
      string account_key = 22;
      Specified by:
      getAccountKeyBytes in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The bytes for accountKey.

    • getAddress

      public String getAddress()
       Address to which response is to be sent. This may also be determined from RequestorRef and preconfigured data.  [siri/siri_requests-v2.0.xsd at 197:69]
      string address = 71;
      Specified by:
      getAddress in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The address.

    • getAddressBytes

      public com.google.protobuf.ByteString getAddressBytes()
       Address to which response is to be sent. This may also be determined from RequestorRef and preconfigured data.  [siri/siri_requests-v2.0.xsd at 197:69]
      string address = 71;
      Specified by:
      getAddressBytes in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The bytes for address.

    • hasRequestorRef

      public boolean hasRequestorRef()
       Reference to a requestor - Participant Code.  [siri/siri_request_support-v2.0.xsd at 110:66]
      .uk.org.siri.www.siri.ParticipantRefStructure requestor_ref = 72;
      Specified by:
      hasRequestorRef in interface SubscriptionRequestTypeOrBuilder
      Returns:
      Whether the requestorRef field is set.

    • getRequestorRef

      public ParticipantRefStructure getRequestorRef()
       Reference to a requestor - Participant Code.  [siri/siri_request_support-v2.0.xsd at 110:66]
      .uk.org.siri.www.siri.ParticipantRefStructure requestor_ref = 72;
      Specified by:
      getRequestorRef in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The requestorRef.

    • getRequestorRefOrBuilder

      public ParticipantRefStructureOrBuilder getRequestorRefOrBuilder()
       Reference to a requestor - Participant Code.  [siri/siri_request_support-v2.0.xsd at 110:66]
      .uk.org.siri.www.siri.ParticipantRefStructure requestor_ref = 72;
      Specified by:
      getRequestorRefOrBuilder in interface SubscriptionRequestTypeOrBuilder

    • hasMessageIdentifier

      public boolean hasMessageIdentifier()
       Arbitrary unique identifier that can be used to reference this message in subsequent interactions.  [siri/siri_requests-v2.0.xsd at 203:89]
      .uk.org.siri.www.siri.MessageQualifierStructure message_identifier = 73;
      Specified by:
      hasMessageIdentifier in interface SubscriptionRequestTypeOrBuilder
      Returns:
      Whether the messageIdentifier field is set.

    • getMessageIdentifier

      public MessageQualifierStructure getMessageIdentifier()
       Arbitrary unique identifier that can be used to reference this message in subsequent interactions.  [siri/siri_requests-v2.0.xsd at 203:89]
      .uk.org.siri.www.siri.MessageQualifierStructure message_identifier = 73;
      Specified by:
      getMessageIdentifier in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The messageIdentifier.

    • getMessageIdentifierOrBuilder

      public MessageQualifierStructureOrBuilder getMessageIdentifierOrBuilder()
       Arbitrary unique identifier that can be used to reference this message in subsequent interactions.  [siri/siri_requests-v2.0.xsd at 203:89]
      .uk.org.siri.www.siri.MessageQualifierStructure message_identifier = 73;
      Specified by:
      getMessageIdentifierOrBuilder in interface SubscriptionRequestTypeOrBuilder

    • getDelegatorAddress

      public String getDelegatorAddress()
       Address of original Consumer, i.e. requesting system to which delegating response is to be  returned. +SIRI 2.0  [siri/siri_requests-v2.0.xsd at 215:78]
      string delegator_address = 81;
      Specified by:
      getDelegatorAddress in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The delegatorAddress.

    • getDelegatorAddressBytes

      public com.google.protobuf.ByteString getDelegatorAddressBytes()
       Address of original Consumer, i.e. requesting system to which delegating response is to be  returned. +SIRI 2.0  [siri/siri_requests-v2.0.xsd at 215:78]
      string delegator_address = 81;
      Specified by:
      getDelegatorAddressBytes in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The bytes for delegatorAddress.

    • hasDelegatorRef

      public boolean hasDelegatorRef()
       Identifier of delegating system that originated message. +SIRI 2.0  [siri/siri_requests-v2.0.xsd at 220:82]
      .uk.org.siri.www.siri.ParticipantRefStructure delegator_ref = 82;
      Specified by:
      hasDelegatorRef in interface SubscriptionRequestTypeOrBuilder
      Returns:
      Whether the delegatorRef field is set.

    • getDelegatorRef

      public ParticipantRefStructure getDelegatorRef()
       Identifier of delegating system that originated message. +SIRI 2.0  [siri/siri_requests-v2.0.xsd at 220:82]
      .uk.org.siri.www.siri.ParticipantRefStructure delegator_ref = 82;
      Specified by:
      getDelegatorRef in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The delegatorRef.

    • getDelegatorRefOrBuilder

      public ParticipantRefStructureOrBuilder getDelegatorRefOrBuilder()
       Identifier of delegating system that originated message. +SIRI 2.0  [siri/siri_requests-v2.0.xsd at 220:82]
      .uk.org.siri.www.siri.ParticipantRefStructure delegator_ref = 82;
      Specified by:
      getDelegatorRefOrBuilder in interface SubscriptionRequestTypeOrBuilder

    • getConsumerAddress

      public String getConsumerAddress()
       Address to which data is to be sent, if different from Address. This may also be determined from RequestorRef and preconfigured data.  [siri/siri_requests-v2.0.xsd at 478:77]
      string consumer_address = 181;
      Specified by:
      getConsumerAddress in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The consumerAddress.

    • getConsumerAddressBytes

      public com.google.protobuf.ByteString getConsumerAddressBytes()
       Address to which data is to be sent, if different from Address. This may also be determined from RequestorRef and preconfigured data.  [siri/siri_requests-v2.0.xsd at 478:77]
      string consumer_address = 181;
      Specified by:
      getConsumerAddressBytes in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The bytes for consumerAddress.

    • getSubscriptionFilterIdentifier

      public String getSubscriptionFilterIdentifier()
       Reference to a Subscription Filter with which this subscription is to be aggregated for purposes of notification and delivery. If absent, use the default filter. If present, use any existing filter with that identifier, if none found, create a new one. Optional SIRI feature.  [siri/siri_requests-v2.0.xsd at 483:86]
      string subscription_filter_identifier = 182;
      Specified by:
      getSubscriptionFilterIdentifier in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The subscriptionFilterIdentifier.

    • getSubscriptionFilterIdentifierBytes

      public com.google.protobuf.ByteString getSubscriptionFilterIdentifierBytes()
       Reference to a Subscription Filter with which this subscription is to be aggregated for purposes of notification and delivery. If absent, use the default filter. If present, use any existing filter with that identifier, if none found, create a new one. Optional SIRI feature.  [siri/siri_requests-v2.0.xsd at 483:86]
      string subscription_filter_identifier = 182;
      Specified by:
      getSubscriptionFilterIdentifierBytes in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The bytes for subscriptionFilterIdentifier.

    • hasSubscriptionContext

      public boolean hasSubscriptionContext()
       General values that apply to subscription. Usually set by configuration.  [siri/siri_requests-v2.0.xsd at 336:96]
      .uk.org.siri.www.siri.SubscriptionContextStructure subscription_context = 191;
      Specified by:
      hasSubscriptionContext in interface SubscriptionRequestTypeOrBuilder
      Returns:
      Whether the subscriptionContext field is set.

    • getSubscriptionContext

      public SubscriptionContextStructure getSubscriptionContext()
       General values that apply to subscription. Usually set by configuration.  [siri/siri_requests-v2.0.xsd at 336:96]
      .uk.org.siri.www.siri.SubscriptionContextStructure subscription_context = 191;
      Specified by:
      getSubscriptionContext in interface SubscriptionRequestTypeOrBuilder
      Returns:
      The subscriptionContext.

    • getSubscriptionContextOrBuilder

      public SubscriptionContextStructureOrBuilder getSubscriptionContextOrBuilder()
       General values that apply to subscription. Usually set by configuration.  [siri/siri_requests-v2.0.xsd at 336:96]
      .uk.org.siri.www.siri.SubscriptionContextStructure subscription_context = 191;
      Specified by:
      getSubscriptionContextOrBuilder in interface SubscriptionRequestTypeOrBuilder

    • getAbstractFunctionalServiceSubscriptionRequestList

      public List<ChoiceWrapper_AbstractSubscriptionStructure> getAbstractFunctionalServiceSubscriptionRequestList()
       Subsititutable type for a SIRI Functional Service subscription request.  [siri/siri_requests-v2.0.xsd at 294:120]
      repeated .uk.org.siri.www.siri.ChoiceWrapper_AbstractSubscriptionStructure abstract_functional_service_subscription_request = 311;
      Specified by:
      getAbstractFunctionalServiceSubscriptionRequestList in interface SubscriptionRequestTypeOrBuilder

    • getAbstractFunctionalServiceSubscriptionRequestOrBuilderList

      public List<? extends ChoiceWrapper_AbstractSubscriptionStructureOrBuilder> getAbstractFunctionalServiceSubscriptionRequestOrBuilderList()
       Subsititutable type for a SIRI Functional Service subscription request.  [siri/siri_requests-v2.0.xsd at 294:120]
      repeated .uk.org.siri.www.siri.ChoiceWrapper_AbstractSubscriptionStructure abstract_functional_service_subscription_request = 311;
      Specified by:
      getAbstractFunctionalServiceSubscriptionRequestOrBuilderList in interface SubscriptionRequestTypeOrBuilder

    • getAbstractFunctionalServiceSubscriptionRequestCount

      public int getAbstractFunctionalServiceSubscriptionRequestCount()
       Subsititutable type for a SIRI Functional Service subscription request.  [siri/siri_requests-v2.0.xsd at 294:120]
      repeated .uk.org.siri.www.siri.ChoiceWrapper_AbstractSubscriptionStructure abstract_functional_service_subscription_request = 311;
      Specified by:
      getAbstractFunctionalServiceSubscriptionRequestCount in interface SubscriptionRequestTypeOrBuilder

    • getAbstractFunctionalServiceSubscriptionRequest

      public ChoiceWrapper_AbstractSubscriptionStructure getAbstractFunctionalServiceSubscriptionRequest(int index)
       Subsititutable type for a SIRI Functional Service subscription request.  [siri/siri_requests-v2.0.xsd at 294:120]
      repeated .uk.org.siri.www.siri.ChoiceWrapper_AbstractSubscriptionStructure abstract_functional_service_subscription_request = 311;
      Specified by:
      getAbstractFunctionalServiceSubscriptionRequest in interface SubscriptionRequestTypeOrBuilder

    • getAbstractFunctionalServiceSubscriptionRequestOrBuilder

      public ChoiceWrapper_AbstractSubscriptionStructureOrBuilder getAbstractFunctionalServiceSubscriptionRequestOrBuilder(int index)
       Subsititutable type for a SIRI Functional Service subscription request.  [siri/siri_requests-v2.0.xsd at 294:120]
      repeated .uk.org.siri.www.siri.ChoiceWrapper_AbstractSubscriptionStructure abstract_functional_service_subscription_request = 311;
      Specified by:
      getAbstractFunctionalServiceSubscriptionRequestOrBuilder in interface SubscriptionRequestTypeOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static SubscriptionRequestType.Builder newBuilder()

    • newBuilder

      public static SubscriptionRequestType.Builder newBuilder(SubscriptionRequestType prototype)

    • toBuilder

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

    • newBuilderForType

      protected SubscriptionRequestType.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static SubscriptionRequestType getDefaultInstance()

    • parser

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

    • getParserForType

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