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

Interface CreateCustomMetricRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>, IotRequest.Builder, SdkBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateCustomMetricRequest
public static interface CreateCustomMetricRequest.Builder extends IotRequest.Builder, SdkPojo, CopyableBuilder<CreateCustomMetricRequest.Builder,CreateCustomMetricRequest>

  • Method Details

    • 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:

    • 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:

    • 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<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:

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

    • overrideConfiguration

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

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