Package software.amazon.awssdk.services.iotfleetwise.model

Class UpdateStateTemplateRequest

    • Method Detail

      • identifier

        public final String identifier()

        A unique, service-generated identifier.

        Returns:
        A unique, service-generated identifier.

      • description

        public final String description()

        A brief description of the state template.

        Returns:
        A brief description of the state template.

      • hasStateTemplatePropertiesToAdd

        public final boolean hasStateTemplatePropertiesToAdd()
        For responses, this returns true if the service returned a value for the StateTemplatePropertiesToAdd 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.

      • stateTemplatePropertiesToAdd

        public final List<String> stateTemplatePropertiesToAdd()

        Add signals from which data is collected as part of the state template.

        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 hasStateTemplatePropertiesToAdd() method.

        Returns:
        Add signals from which data is collected as part of the state template.

      • hasStateTemplatePropertiesToRemove

        public final boolean hasStateTemplatePropertiesToRemove()
        For responses, this returns true if the service returned a value for the StateTemplatePropertiesToRemove 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.

      • stateTemplatePropertiesToRemove

        public final List<String> stateTemplatePropertiesToRemove()

        Remove signals from which data is collected as part of the state template.

        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 hasStateTemplatePropertiesToRemove() method.

        Returns:
        Remove signals from which data is collected as part of the state template.

      • 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 to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.

        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 to associate with the payload published on the state template's MQTT topic. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will enrich the protobuf encoded payload with those attributes in the extraDimensions field.

        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. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.

        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. (See Processing last known state vehicle data using MQTT messaging). For example, if you add Vehicle.Attributes.Make and Vehicle.Attributes.Model attributes, Amazon Web Services IoT FleetWise will include these attributes as User Properties with the MQTT message.

      • 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