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

Interface CreateCustomMetricRequest.Builder

    • Method Detail

      • metricName

        CreateCustomMetricRequest.Builder metricName​(String metricName)

        The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.

        Parameters:
        metricName - The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with aws:. You can't change the name after you define it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • displayName

        CreateCustomMetricRequest.Builder displayName​(String displayName)

        The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.

        Parameters:
        displayName - The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • metricType

        CreateCustomMetricRequest.Builder metricType​(String metricType)

        The type of the custom metric.

        The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

        Parameters:
        metricType - The type of the custom metric.

        The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

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

      • metricType

        CreateCustomMetricRequest.Builder metricType​(CustomMetricType metricType)

        The type of the custom metric.

        The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

        Parameters:
        metricType - The type of the custom metric.

        The type number only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.

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

      • tags

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

        Metadata that can be used to manage the custom metric.

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

      • tags

        CreateCustomMetricRequest.Builder tags​(Tag... tags)

        Metadata that can be used to manage the custom metric.

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

      • tags

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

        Metadata that can be used to manage the custom metric.

        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

        CreateCustomMetricRequest.Builder clientRequestToken​(String clientRequestToken)

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

        Parameters:
        clientRequestToken - Each custom metric must have a unique client request token. If you try to create a new custom metric that already exists with a different token, 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.