Package uk.org.siri.www.siri

Class HeartbeatNotificationStructure

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
uk.org.siri.www.siri.HeartbeatNotificationStructure
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable, HeartbeatNotificationStructureOrBuilder
public final class HeartbeatNotificationStructure extends com.google.protobuf.GeneratedMessage implements HeartbeatNotificationStructureOrBuilder
 Type for Service Heartbeat Notification.  [siri/siri_common_services-v2.0.xsd at 840:57]
Protobuf type uk.org.siri.www.siri.HeartbeatNotificationStructure
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:

    • STATUS_FIELD_NUMBER

      public static final int STATUS_FIELD_NUMBER
      See Also:

    • DATA_READY_FIELD_NUMBER

      public static final int DATA_READY_FIELD_NUMBER
      See Also:

    • ERROR_CONDITION_FIELD_NUMBER

      public static final int ERROR_CONDITION_FIELD_NUMBER
      See Also:

    • VALID_UNTIL_FIELD_NUMBER

      public static final int VALID_UNTIL_FIELD_NUMBER
      See Also:

    • SHORTEST_POSSIBLE_CYCLE_FIELD_NUMBER

      public static final int SHORTEST_POSSIBLE_CYCLE_FIELD_NUMBER
      See Also:

    • SERVICE_STARTED_TIME_FIELD_NUMBER

      public static final int SERVICE_STARTED_TIME_FIELD_NUMBER
      See Also:

    • EXTENSIONS_FIELD_NUMBER

      public static final int EXTENSIONS_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 HeartbeatNotificationStructureOrBuilder
      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 HeartbeatNotificationStructureOrBuilder
      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 HeartbeatNotificationStructureOrBuilder

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

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

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

    • getStatus

      public boolean getStatus()
       Whether the request was processed successfully or not. Default is 'true'.  [siri/siri_requests-v2.0.xsd at 541:63]
      bool status = 181;
      Specified by:
      getStatus in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      The status.

    • getDataReady

      public boolean getDataReady()
       Whether data delivery is ready to be fetched SIRI v 2.0  [siri/siri_common_services-v2.0.xsd at 803:67]
      bool data_ready = 182;
      Specified by:
      getDataReady in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      The dataReady.

    • hasErrorCondition

      public boolean hasErrorCondition()
       Description of any error or warning condition that applies to the status check.  [siri/siri_common_services-v2.0.xsd at 808:53]
      .uk.org.siri.www.siri.HeartbeatNotificationStructure.ErrorConditionType error_condition = 183;
      Specified by:
      hasErrorCondition in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      Whether the errorCondition field is set.

    • getErrorCondition

      public HeartbeatNotificationStructure.ErrorConditionType getErrorCondition()
       Description of any error or warning condition that applies to the status check.  [siri/siri_common_services-v2.0.xsd at 808:53]
      .uk.org.siri.www.siri.HeartbeatNotificationStructure.ErrorConditionType error_condition = 183;
      Specified by:
      getErrorCondition in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      The errorCondition.

    • getErrorConditionOrBuilder

      public HeartbeatNotificationStructure.ErrorConditionTypeOrBuilder getErrorConditionOrBuilder()
       Description of any error or warning condition that applies to the status check.  [siri/siri_common_services-v2.0.xsd at 808:53]
      .uk.org.siri.www.siri.HeartbeatNotificationStructure.ErrorConditionType error_condition = 183;
      Specified by:
      getErrorConditionOrBuilder in interface HeartbeatNotificationStructureOrBuilder

    • hasValidUntil

      public boolean hasValidUntil()
       End of data horizon of the data producer.  [siri/siri_request_errorConditions-v2.0.xsd at 109:69]
      .google.protobuf.Timestamp valid_until = 184;
      Specified by:
      hasValidUntil in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      Whether the validUntil field is set.

    • getValidUntil

      public com.google.protobuf.Timestamp getValidUntil()
       End of data horizon of the data producer.  [siri/siri_request_errorConditions-v2.0.xsd at 109:69]
      .google.protobuf.Timestamp valid_until = 184;
      Specified by:
      getValidUntil in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      The validUntil.

    • getValidUntilOrBuilder

      public com.google.protobuf.TimestampOrBuilder getValidUntilOrBuilder()
       End of data horizon of the data producer.  [siri/siri_request_errorConditions-v2.0.xsd at 109:69]
      .google.protobuf.Timestamp valid_until = 184;
      Specified by:
      getValidUntilOrBuilder in interface HeartbeatNotificationStructureOrBuilder

    • hasShortestPossibleCycle

      public boolean hasShortestPossibleCycle()
       Minimum interval at which updates can be sent.  [siri/siri_request_errorConditions-v2.0.xsd at 114:88]
      .google.protobuf.Duration shortest_possible_cycle = 185;
      Specified by:
      hasShortestPossibleCycle in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      Whether the shortestPossibleCycle field is set.

    • getShortestPossibleCycle

      public com.google.protobuf.Duration getShortestPossibleCycle()
       Minimum interval at which updates can be sent.  [siri/siri_request_errorConditions-v2.0.xsd at 114:88]
      .google.protobuf.Duration shortest_possible_cycle = 185;
      Specified by:
      getShortestPossibleCycle in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      The shortestPossibleCycle.

    • getShortestPossibleCycleOrBuilder

      public com.google.protobuf.DurationOrBuilder getShortestPossibleCycleOrBuilder()
       Minimum interval at which updates can be sent.  [siri/siri_request_errorConditions-v2.0.xsd at 114:88]
      .google.protobuf.Duration shortest_possible_cycle = 185;
      Specified by:
      getShortestPossibleCycleOrBuilder in interface HeartbeatNotificationStructureOrBuilder

    • hasServiceStartedTime

      public boolean hasServiceStartedTime()
       Time at which current instantiation of service started.  [siri/siri_common_services-v2.0.xsd at 827:77]
      .google.protobuf.Timestamp service_started_time = 191;
      Specified by:
      hasServiceStartedTime in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      Whether the serviceStartedTime field is set.

    • getServiceStartedTime

      public com.google.protobuf.Timestamp getServiceStartedTime()
       Time at which current instantiation of service started.  [siri/siri_common_services-v2.0.xsd at 827:77]
      .google.protobuf.Timestamp service_started_time = 191;
      Specified by:
      getServiceStartedTime in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      The serviceStartedTime.

    • getServiceStartedTimeOrBuilder

      public com.google.protobuf.TimestampOrBuilder getServiceStartedTimeOrBuilder()
       Time at which current instantiation of service started.  [siri/siri_common_services-v2.0.xsd at 827:77]
      .google.protobuf.Timestamp service_started_time = 191;
      Specified by:
      getServiceStartedTimeOrBuilder in interface HeartbeatNotificationStructureOrBuilder

    • hasExtensions

      public boolean hasExtensions()
       Extensions to schema. (Wrapper tag used to avoid problems with handling of optional 'any' by some validators).  [siri_utility/siri_utility-v1.1.xsd at 64:60]
      .uk.org.siri.www.siri.ExtensionsStructure extensions = 201;
      Specified by:
      hasExtensions in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      Whether the extensions field is set.

    • getExtensions

      public ExtensionsStructure getExtensions()
       Extensions to schema. (Wrapper tag used to avoid problems with handling of optional 'any' by some validators).  [siri_utility/siri_utility-v1.1.xsd at 64:60]
      .uk.org.siri.www.siri.ExtensionsStructure extensions = 201;
      Specified by:
      getExtensions in interface HeartbeatNotificationStructureOrBuilder
      Returns:
      The extensions.

    • getExtensionsOrBuilder

      public ExtensionsStructureOrBuilder getExtensionsOrBuilder()
       Extensions to schema. (Wrapper tag used to avoid problems with handling of optional 'any' by some validators).  [siri_utility/siri_utility-v1.1.xsd at 64:60]
      .uk.org.siri.www.siri.ExtensionsStructure extensions = 201;
      Specified by:
      getExtensionsOrBuilder in interface HeartbeatNotificationStructureOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static HeartbeatNotificationStructure.Builder newBuilder()

    • newBuilder

      public static HeartbeatNotificationStructure.Builder newBuilder(HeartbeatNotificationStructure prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static HeartbeatNotificationStructure getDefaultInstance()

    • parser

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

    • getParserForType

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