Interface MetricDefinition.Builder

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

  • Method Details

    • arn

      MetricDefinition.Builder arn(String arn)

      The Amazon Resource Name (ARN) of the metric. May be qualified with $SAVED or $LATEST.

      Parameters:
      arn - The Amazon Resource Name (ARN) of the metric. May be qualified with $SAVED or $LATEST.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • id

      MetricDefinition.Builder id(String id)

      The identifier of the metric.

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

    • name

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

    • description

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

    • metricCalculation

      MetricDefinition.Builder metricCalculation(MetricCalculation metricCalculation)

      The calculation definition for the metric.

      Parameters:
      metricCalculation - The calculation definition for the metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricCalculation

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

      The calculation definition for the metric.

      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:

    • creationMethod

      MetricDefinition.Builder creationMethod(String creationMethod)

      The method used to create the metric. Valid values: SERVICE_LEVEL_BUILDER (created with the guided service-level experience) | METRIC_BUILDER (created with the free-form metric builder).

      Parameters:
      creationMethod - The method used to create the metric. Valid values: SERVICE_LEVEL_BUILDER (created with the guided service-level experience) | METRIC_BUILDER (created with the free-form metric builder).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • creationMethod

      MetricDefinition.Builder creationMethod(MetricCreationMethod creationMethod)

      The method used to create the metric. Valid values: SERVICE_LEVEL_BUILDER (created with the guided service-level experience) | METRIC_BUILDER (created with the free-form metric builder).

      Parameters:
      creationMethod - The method used to create the metric. Valid values: SERVICE_LEVEL_BUILDER (created with the guided service-level experience) | METRIC_BUILDER (created with the free-form metric builder).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      MetricDefinition.Builder status(String status)

      The publish status of the metric. Valid values: PUBLISHED | SAVED.

      Parameters:
      status - The publish status of the metric. Valid values: PUBLISHED | SAVED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      MetricDefinition.Builder status(MetricStatus status)

      The publish status of the metric. Valid values: PUBLISHED | SAVED.

      Parameters:
      status - The publish status of the metric. Valid values: PUBLISHED | SAVED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      MetricDefinition.Builder type(String type)

      The type of the metric. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.

      Parameters:
      type - The type of the metric. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • type

      MetricDefinition.Builder type(MetricType type)

      The type of the metric. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.

      Parameters:
      type - The type of the metric. Valid values: AWS_MANAGED | CUSTOMER_MANAGED.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • unit

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

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

    • positiveTrendIndicator

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

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

    • groupings

      MetricDefinition.Builder groupings(Collection<String> groupings)

      The groupings available for this metric.

      Parameters:
      groupings - The groupings available for this metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • groupings

      MetricDefinition.Builder groupings(String... groupings)

      The groupings available for this metric.

      Parameters:
      groupings - The groupings available for this metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      MetricDefinition.Builder filters(Collection<AvailableFilter> filters)

      The filters applied to the metric.

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

    • filters

      MetricDefinition.Builder filters(AvailableFilter... filters)

      The filters applied to the metric.

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

    • filters

      MetricDefinition.Builder filters(Consumer<AvailableFilter.Builder>... filters)

      The filters applied to the metric.

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

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

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

    • effectiveTime

      MetricDefinition.Builder effectiveTime(Instant effectiveTime)

      The earliest time that can be queried for this metric.

      Parameters:
      effectiveTime - The earliest time that can be queried for this metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • refreshRate

      MetricDefinition.Builder refreshRate(Long refreshRate)

      The minimum interval, in seconds, between data refreshes for this metric.

      Parameters:
      refreshRate - The minimum interval, in seconds, between data refreshes for this metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • category

      MetricDefinition.Builder category(String category)

      The category of the metric.

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

    • supportedStats

      MetricDefinition.Builder supportedStats(Collection<String> supportedStats)

      The stat aggregations available for this metric.

      Parameters:
      supportedStats - The stat aggregations available for this metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportedStats

      MetricDefinition.Builder supportedStats(String... supportedStats)

      The stat aggregations available for this metric.

      Parameters:
      supportedStats - The stat aggregations available for this metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • defaultStat

      MetricDefinition.Builder defaultStat(String defaultStat)

      The default stat aggregation for the metric.

      Parameters:
      defaultStat - The default stat aggregation for the metric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportsPreaggregateCalculation

      MetricDefinition.Builder supportsPreaggregateCalculation(Boolean supportsPreaggregateCalculation)

      Specifies whether the metric can be used inside aggregating statistical functions (SUM, AVG, etc.) in custom metric calculations.

      Parameters:
      supportsPreaggregateCalculation - Specifies whether the metric can be used inside aggregating statistical functions (SUM, AVG, etc.) in custom metric calculations.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • supportsCustomCalculation

      MetricDefinition.Builder supportsCustomCalculation(Boolean supportsCustomCalculation)

      Specifies whether the metric can be used as a component of custom metrics.

      Parameters:
      supportsCustomCalculation - Specifies whether the metric can be used as a component of custom metrics.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • primaryEventSource

      MetricDefinition.Builder primaryEventSource(String primaryEventSource)

      The primary event source for the metric data.

      Parameters:
      primaryEventSource - The primary event source for the metric data.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • primaryEventSourceEffectiveTimestampType

      MetricDefinition.Builder primaryEventSourceEffectiveTimestampType(String primaryEventSourceEffectiveTimestampType)

      The timestamp type that determines where the metric appears on a time series.

      Parameters:
      primaryEventSourceEffectiveTimestampType - The timestamp type that determines where the metric appears on a time series.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdTime

      MetricDefinition.Builder createdTime(Instant createdTime)

      The timestamp of when the metric was created.

      Parameters:
      createdTime - The timestamp of when the metric was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdUser

      MetricDefinition.Builder createdUser(CreatedByInfo createdUser)

      The user that created the metric. The creator for metrics created through the CreateMetric API will be Amazon Connect API.

      Parameters:
      createdUser - The user that created the metric. The creator for metrics created through the CreateMetric API will be Amazon Connect API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdUser

      default MetricDefinition.Builder createdUser(Consumer<CreatedByInfo.Builder> createdUser)

      The user that created the metric. The creator for metrics created through the CreateMetric API will be Amazon Connect API.

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

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

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

    • lastModifiedRegion

      MetricDefinition.Builder lastModifiedRegion(String lastModifiedRegion)

      The region where the metric was last modified.

      Parameters:
      lastModifiedRegion - The region where the metric was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedTime

      MetricDefinition.Builder lastModifiedTime(Instant lastModifiedTime)

      The timestamp of when the metric was last modified.

      Parameters:
      lastModifiedTime - The timestamp of when the metric was last modified.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedUser

      MetricDefinition.Builder lastModifiedUser(CreatedByInfo lastModifiedUser)

      The user that last modified the metric. For modifications made through the API, this will be Amazon Connect API.

      Parameters:
      lastModifiedUser - The user that last modified the metric. For modifications made through the API, this will be Amazon Connect API.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • lastModifiedUser

      default MetricDefinition.Builder lastModifiedUser(Consumer<CreatedByInfo.Builder> lastModifiedUser)

      The user that last modified the metric. For modifications made through the API, this will be Amazon Connect API.

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

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

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

    • tags

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