Package software.amazon.awssdk.services.iot.model

Interface CreateDimensionRequest.Builder

    • Method Detail

      • name

        CreateDimensionRequest.Builder name​(String name)

        A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.

        Parameters:
        name - A unique identifier for the dimension. Choose something that describes the type and value to make it easy to remember what it does.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • type

        CreateDimensionRequest.Builder type​(String type)

        Specifies the type of dimension. Supported types: TOPIC_FILTER.

        Parameters:
        type - Specifies the type of dimension. Supported types: TOPIC_FILTER.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        DimensionType, DimensionType

      • stringValues

        CreateDimensionRequest.Builder stringValues​(Collection<String> stringValues)

        Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

        Parameters:
        stringValues - Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • stringValues

        CreateDimensionRequest.Builder stringValues​(String... stringValues)

        Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").

        Parameters:
        stringValues - Specifies the value or list of values for the dimension. For TOPIC_FILTER dimensions, this is a pattern used to match the MQTT topic (for example, "admin/#").
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tags

        CreateDimensionRequest.Builder tags​(Collection<Tag> tags)

        Metadata that can be used to manage the dimension.

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

      • tags

        CreateDimensionRequest.Builder tags​(Tag... tags)

        Metadata that can be used to manage the dimension.

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

      • tags

        CreateDimensionRequest.Builder tags​(Consumer<Tag.Builder>... tags)

        Metadata that can be used to manage the dimension.

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

        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:
        #tags(java.util.Collection)

      • clientRequestToken

        CreateDimensionRequest.Builder clientRequestToken​(String clientRequestToken)

        Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.

        Parameters:
        clientRequestToken - Each dimension must have a unique client request token. If you try to create a new dimension with the same token as a dimension that already exists, an exception occurs. If you omit this value, Amazon Web Services SDKs will automatically generate a unique client request.
        Returns:
        Returns a reference to this object so that method calls can be chained together.