Package uk.org.siri.www.siri

Class DataReadyRequestStructure

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
uk.org.siri.www.siri.DataReadyRequestStructure
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, DataReadyRequestStructureOrBuilder
public final class DataReadyRequestStructure extends com.google.protobuf.GeneratedMessage implements DataReadyRequestStructureOrBuilder
 Type for Request from Producer to Consumer to notify that data update is ready to fetch. Answered with a DataReadyResponse.  [siri/siri_common_services-v2.0.xsd at 614:52]
Protobuf type uk.org.siri.www.siri.DataReadyRequestStructure
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:

    • PRODUCER_REF_FIELD_NUMBER

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

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

    • 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 DataReadyRequestStructureOrBuilder
      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 DataReadyRequestStructureOrBuilder
      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 DataReadyRequestStructureOrBuilder
      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 DataReadyRequestStructureOrBuilder
      Returns:
      The bytes for accountKey.

    • getAddress

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

    • getAddressBytes

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

    • hasProducerRef

      public boolean hasProducerRef()
       Unique identifier of Producer - Participant reference.  [siri/siri_requests-v2.0.xsd at 649:81]
      .uk.org.siri.www.siri.ParticipantRefStructure producer_ref = 72;
      Specified by:
      hasProducerRef in interface DataReadyRequestStructureOrBuilder
      Returns:
      Whether the producerRef field is set.

    • getProducerRef

      public ParticipantRefStructure getProducerRef()
       Unique identifier of Producer - Participant reference.  [siri/siri_requests-v2.0.xsd at 649:81]
      .uk.org.siri.www.siri.ParticipantRefStructure producer_ref = 72;
      Specified by:
      getProducerRef in interface DataReadyRequestStructureOrBuilder
      Returns:
      The producerRef.

    • getProducerRefOrBuilder

      public ParticipantRefStructureOrBuilder getProducerRefOrBuilder()
       Unique identifier of Producer - Participant reference.  [siri/siri_requests-v2.0.xsd at 649:81]
      .uk.org.siri.www.siri.ParticipantRefStructure producer_ref = 72;
      Specified by:
      getProducerRefOrBuilder in interface DataReadyRequestStructureOrBuilder

    • hasMessageIdentifier

      public boolean hasMessageIdentifier()
       Arbitrary unique reference to this message. Some systems may use just timestamp for this. Where there are multiple SubscriptionFilters, this can be used to distinguish between different notifications for different filters.  [siri/siri_requests-v2.0.xsd at 654:89]
      .uk.org.siri.www.siri.MessageQualifierStructure message_identifier = 73;
      Specified by:
      hasMessageIdentifier in interface DataReadyRequestStructureOrBuilder
      Returns:
      Whether the messageIdentifier field is set.

    • getMessageIdentifier

      public MessageQualifierStructure getMessageIdentifier()
       Arbitrary unique reference to this message. Some systems may use just timestamp for this. Where there are multiple SubscriptionFilters, this can be used to distinguish between different notifications for different filters.  [siri/siri_requests-v2.0.xsd at 654:89]
      .uk.org.siri.www.siri.MessageQualifierStructure message_identifier = 73;
      Specified by:
      getMessageIdentifier in interface DataReadyRequestStructureOrBuilder
      Returns:
      The messageIdentifier.

    • getMessageIdentifierOrBuilder

      public MessageQualifierStructureOrBuilder getMessageIdentifierOrBuilder()
       Arbitrary unique reference to this message. Some systems may use just timestamp for this. Where there are multiple SubscriptionFilters, this can be used to distinguish between different notifications for different filters.  [siri/siri_requests-v2.0.xsd at 654:89]
      .uk.org.siri.www.siri.MessageQualifierStructure message_identifier = 73;
      Specified by:
      getMessageIdentifierOrBuilder in interface DataReadyRequestStructureOrBuilder

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

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static DataReadyRequestStructure.Builder newBuilder()

    • newBuilder

      public static DataReadyRequestStructure.Builder newBuilder(DataReadyRequestStructure prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static DataReadyRequestStructure getDefaultInstance()

    • parser

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

    • getParserForType

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