Interface CreateStateTemplateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateStateTemplateRequest.Builder,CreateStateTemplateRequest>, IoTFleetWiseRequest.Builder, SdkBuilder<CreateStateTemplateRequest.Builder,CreateStateTemplateRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateStateTemplateRequest
@Mutable @NotThreadSafe public static interface CreateStateTemplateRequest.Builder extends IoTFleetWiseRequest.Builder, SdkPojo, CopyableBuilder<CreateStateTemplateRequest.Builder,CreateStateTemplateRequest>

  • Method Details

    • name

      CreateStateTemplateRequest.Builder name(String name)

      The name of the state template.

      Parameters:
      name - The name of the state template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateStateTemplateRequest.Builder description(String description)

      A brief description of the state template.

      Parameters:
      description - A brief description of the state template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • signalCatalogArn

      CreateStateTemplateRequest.Builder signalCatalogArn(String signalCatalogArn)

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

      Parameters:
      signalCatalogArn - The ARN of the signal catalog associated with the state template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateTemplateProperties

      CreateStateTemplateRequest.Builder stateTemplateProperties(Collection<String> stateTemplateProperties)

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

      Parameters:
      stateTemplateProperties - A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • stateTemplateProperties

      CreateStateTemplateRequest.Builder stateTemplateProperties(String... stateTemplateProperties)

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

      Parameters:
      stateTemplateProperties - A list of signals from which data is collected. The state template properties contain the fully qualified names of the signals.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataExtraDimensions

      CreateStateTemplateRequest.Builder dataExtraDimensions(Collection<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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dataExtraDimensions

      CreateStateTemplateRequest.Builder dataExtraDimensions(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.

      Parameters:
      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.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataExtraDimensions

      CreateStateTemplateRequest.Builder metadataExtraDimensions(Collection<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.

      Default: An empty array

      Parameters:
      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.

      Default: An empty array

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metadataExtraDimensions

      CreateStateTemplateRequest.Builder metadataExtraDimensions(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.

      Default: An empty array

      Parameters:
      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.

      Default: An empty array

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateStateTemplateRequest.Builder tags(Collection<Tag> tags)

      Metadata that can be used to manage the state template.

      Parameters:
      tags - Metadata that can be used to manage the state template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateStateTemplateRequest.Builder tags(Tag... tags)

      Metadata that can be used to manage the state template.

      Parameters:
      tags - Metadata that can be used to manage the state template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      CreateStateTemplateRequest.Builder tags(Consumer<Tag.Builder>... tags)

      Metadata that can be used to manage the state template.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

      CreateStateTemplateRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateStateTemplateRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.