Interface CreateMetricRequest.Builder

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

  • Method Details

    • instanceId

      CreateMetricRequest.Builder instanceId(String instanceId)

      The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

      Parameters:
      instanceId - The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreateMetricRequest.Builder name(String name)

      The name of the metric.

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

    • metricCalculation

      CreateMetricRequest.Builder metricCalculation(MetricCalculation metricCalculation)

      The calculation definition for the metric, including the formula expression and the component metrics it references.

      Parameters:
      metricCalculation - The calculation definition for the metric, including the formula expression and the component metrics it references.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricCalculation

      default CreateMetricRequest.Builder metricCalculation(Consumer<MetricCalculation.Builder> metricCalculation)

      The calculation definition for the metric, including the formula expression and the component metrics it references.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to metricCalculation(MetricCalculation).

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

    • unit

      CreateMetricRequest.Builder unit(String unit)

      The display unit for the metric's data.

      Parameters:
      unit - The display unit for the metric's data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • unit

      CreateMetricRequest.Builder unit(MetricUnit unit)

      The display unit for the metric's data.

      Parameters:
      unit - The display unit for the metric's data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      CreateMetricRequest.Builder status(String status)

      The publish status of the metric. Set to PUBLISHED to make the metric available for use in dashboards and reports, or SAVED to keep it in draft state.

      Parameters:
      status - The publish status of the metric. Set to PUBLISHED to make the metric available for use in dashboards and reports, or SAVED to keep it in draft state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      CreateMetricRequest.Builder status(MetricStatus status)

      The publish status of the metric. Set to PUBLISHED to make the metric available for use in dashboards and reports, or SAVED to keep it in draft state.

      Parameters:
      status - The publish status of the metric. Set to PUBLISHED to make the metric available for use in dashboards and reports, or SAVED to keep it in draft state.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • clientToken

      CreateMetricRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.

      Parameters:
      clientToken - A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateMetricRequest.Builder description(String description)

      The description of the metric.

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

    • positiveTrendIndicator

      CreateMetricRequest.Builder positiveTrendIndicator(String positiveTrendIndicator)

      How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.

      Parameters:
      positiveTrendIndicator - How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • positiveTrendIndicator

      CreateMetricRequest.Builder positiveTrendIndicator(TrendIndicator positiveTrendIndicator)

      How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.

      Parameters:
      positiveTrendIndicator - How an increase in the metric value should be interpreted. Valid values: POSITIVE, NEUTRAL, NEGATIVE.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • tags

      CreateMetricRequest.Builder tags(Map<String,String> tags)

      The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

      Parameters:
      tags - The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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