Class GetStateTemplateResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseResponse
software.amazon.awssdk.services.iotfleetwise.model.GetStateTemplateResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetStateTemplateResponse.Builder,GetStateTemplateResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetStateTemplateResponse extends IoTFleetWiseResponse implements ToCopyableBuilder<GetStateTemplateResponse.Builder,GetStateTemplateResponse>

  • Method Details

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

    • toBuilder

      public GetStateTemplateResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<GetStateTemplateResponse.Builder,GetStateTemplateResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetStateTemplateResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetStateTemplateResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.