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>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceGetStateTemplateResponse.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Stringarn()The Amazon Resource Name (ARN) of the state template.static GetStateTemplateResponse.Builderbuilder()InstantcreationTime()The time the state template was created in seconds since epoch (January 1, 1970 at midnight UTC time).List<String>dataExtraDimensions()A list of vehicle attributes associated with the payload published on the state template's MQTT topic.Stringdescription()A brief description of the state template.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasDataExtraDimensions()For responses, this returns true if the service returned a value for the DataExtraDimensions property.inthashCode()booleanhasMetadataExtraDimensions()For responses, this returns true if the service returned a value for the MetadataExtraDimensions property.booleanhasStateTemplateProperties()For responses, this returns true if the service returned a value for the StateTemplateProperties property.Stringid()The unique ID of the state template.InstantlastModificationTime()The time the state template was last updated in seconds since epoch (January 1, 1970 at midnight UTC time).List<String>metadataExtraDimensions()A list of vehicle attributes to associate with user properties of the messages published on the state template's MQTT topic.Stringname()The name of the state template.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends GetStateTemplateResponse.Builder>serializableBuilderClass()StringsignalCatalogArn()The ARN of the signal catalog associated with the state template.List<String>stateTemplateProperties()A list of signals from which data is collected.GetStateTemplateResponse.BuildertoBuilder()StringtoString()Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.services.iotfleetwise.model.IoTFleetWiseResponse
responseMetadata
-
Methods inherited from class software.amazon.awssdk.core.SdkResponse
sdkHttpResponse
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
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 theisEmpty()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 theisEmpty()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 theisEmpty()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()
- Specified by:
toBuilderin interfaceToCopyableBuilder<GetStateTemplateResponse.Builder,GetStateTemplateResponse>- Specified by:
toBuilderin classAwsResponse
-
builder
public static GetStateTemplateResponse.Builder builder()
-
serializableBuilderClass
public static Class<? extends GetStateTemplateResponse.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCodein classAwsResponse
-
equals
public final boolean equals(Object obj)
- Overrides:
equalsin classAwsResponse
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForFieldin classSdkResponse
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-