Package uk.org.siri.www.siri

Interface HeartbeatNotificationStructureOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
HeartbeatNotificationStructure, HeartbeatNotificationStructure.Builder
public interface HeartbeatNotificationStructureOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasRequestTimestamp

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

    • getRequestTimestamp

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

    • getRequestTimestampOrBuilder

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

    • getAccountId

      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;
      Returns:
      The accountId.

    • getAccountIdBytes

      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;
      Returns:
      The bytes for accountId.

    • getAccountKey

      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;
      Returns:
      The accountKey.

    • getAccountKeyBytes

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

    • getAddress

      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;
      Returns:
      The address.

    • getAddressBytes

      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;
      Returns:
      The bytes for address.

    • hasProducerRef

      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;
      Returns:
      Whether the producerRef field is set.

    • getProducerRef

      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;
      Returns:
      The producerRef.

    • getProducerRefOrBuilder

      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;

    • hasMessageIdentifier

      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;
      Returns:
      Whether the messageIdentifier field is set.

    • getMessageIdentifier

      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;
      Returns:
      The messageIdentifier.

    • getMessageIdentifierOrBuilder

      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;

    • getDelegatorAddress

      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;
      Returns:
      The delegatorAddress.

    • getDelegatorAddressBytes

      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;
      Returns:
      The bytes for delegatorAddress.

    • hasDelegatorRef

      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;
      Returns:
      Whether the delegatorRef field is set.

    • getDelegatorRef

      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;
      Returns:
      The delegatorRef.

    • getDelegatorRefOrBuilder

      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;

    • getStatus

      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;
      Returns:
      The status.

    • getDataReady

      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;
      Returns:
      The dataReady.

    • hasErrorCondition

      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;
      Returns:
      Whether the errorCondition field is set.

    • getErrorCondition

      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;
      Returns:
      The errorCondition.

    • getErrorConditionOrBuilder

      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;

    • hasValidUntil

      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;
      Returns:
      Whether the validUntil field is set.

    • getValidUntil

      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;
      Returns:
      The validUntil.

    • getValidUntilOrBuilder

      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;

    • hasShortestPossibleCycle

      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;
      Returns:
      Whether the shortestPossibleCycle field is set.

    • getShortestPossibleCycle

      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;
      Returns:
      The shortestPossibleCycle.

    • getShortestPossibleCycleOrBuilder

      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;

    • hasServiceStartedTime

      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;
      Returns:
      Whether the serviceStartedTime field is set.

    • getServiceStartedTime

      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;
      Returns:
      The serviceStartedTime.

    • getServiceStartedTimeOrBuilder

      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;

    • hasExtensions

      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;
      Returns:
      Whether the extensions field is set.

    • getExtensions

      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;
      Returns:
      The extensions.

    • getExtensionsOrBuilder

      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;