Class GetStateTemplateResponse

    • Method Detail

      • name

        public final String name()

        The name of the state template.

        Returns:
        The name of the state template.
      • arn

        public final String arn()

        The Amazon Resource Name (ARN) of the state template.

        Returns:
        The Amazon Resource Name (ARN) of the state template.
      • description

        public final String description()

        A brief description of the state template.

        Returns:
        A brief description of the state template.
      • signalCatalogArn

        public final String signalCatalogArn()

        The ARN of the signal catalog associated with the state template.

        Returns:
        The ARN of the signal catalog associated with the state template.
      • hasStateTemplateProperties

        public final boolean hasStateTemplateProperties()
        For responses, this returns true if the service returned a value for the StateTemplateProperties property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • stateTemplateProperties

        public final List<String> stateTemplateProperties()

        A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStateTemplateProperties() method.

        Returns:
        A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
      • hasDataExtraDimensions

        public final boolean hasDataExtraDimensions()
        For responses, this returns true if the service returned a value for the DataExtraDimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • dataExtraDimensions

        public final List<String> dataExtraDimensions()

        A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

        Default: An empty array

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasDataExtraDimensions() method.

        Returns:
        A list of vehicle attributes associated with the payload published on the state template's MQTT topic.

        Default: An empty array

      • hasMetadataExtraDimensions

        public final boolean hasMetadataExtraDimensions()
        For responses, this returns true if the service returned a value for the MetadataExtraDimensions property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
      • metadataExtraDimensions

        public final List<String> metadataExtraDimensions()

        A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.

        Default: An empty array

        Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

        This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasMetadataExtraDimensions() method.

        Returns:
        A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.

        Default: An empty array

      • creationTime

        public final Instant creationTime()

        The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).

        Returns:
        The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).
      • lastModificationTime

        public final Instant lastModificationTime()

        The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).

        Returns:
        The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).
      • id

        public final String id()

        The unique ID of the state template.

        Returns:
        The unique ID of the state template.
      • toString

        public final String toString()
        Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
        Overrides:
        toString in class Object