Interface RequestBasedServiceLevelIndicatorMetricConfig.Builder

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

  • Method Details

    • keyAttributes

      RequestBasedServiceLevelIndicatorMetricConfig.Builder keyAttributes(Map<String,String> keyAttributes)

      If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

      Parameters:
      keyAttributes - If this SLO is related to a metric collected by Application Signals, you must use this field to specify which service the SLO metric is related to. To do so, you must specify at least the Type, Name, and Environment attributes.

      This is a string-to-string map. It can include the following fields.

      • Type designates the type of object this is.

      • ResourceType specifies the type of the resource. This field is used only when the value of the Type field is Resource or AWS::Resource.

      • Name specifies the name of the object. This is used only if the value of the Type field is Service, RemoteService, or AWS::Service.

      • Identifier identifies the resource objects of this resource. This is used only if the value of the Type field is Resource or AWS::Resource.

      • Environment specifies the location where this object is hosted, or what it belongs to.

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

    • operationName

      RequestBasedServiceLevelIndicatorMetricConfig.Builder operationName(String operationName)

      If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.

      Parameters:
      operationName - If the SLO is to monitor a specific operation of the service, use this field to specify the name of that operation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • metricType

      RequestBasedServiceLevelIndicatorMetricConfig.Builder metricType(String metricType)

      If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

      Parameters:
      metricType - If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • metricType

      RequestBasedServiceLevelIndicatorMetricConfig.Builder metricType(ServiceLevelIndicatorMetricType metricType)

      If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.

      Parameters:
      metricType - If the SLO is to monitor either the LATENCY or AVAILABILITY metric that Application Signals collects, use this field to specify which of those metrics is used.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • totalRequestCountMetric

      RequestBasedServiceLevelIndicatorMetricConfig.Builder totalRequestCountMetric(Collection<MetricDataQuery> totalRequestCountMetric)

      Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO. This result will be divided by the "good request" or "bad request" value defined in MonitoredRequestCountMetric.

      Parameters:
      totalRequestCountMetric - Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO. This result will be divided by the "good request" or "bad request" value defined in MonitoredRequestCountMetric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalRequestCountMetric

      RequestBasedServiceLevelIndicatorMetricConfig.Builder totalRequestCountMetric(MetricDataQuery... totalRequestCountMetric)

      Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO. This result will be divided by the "good request" or "bad request" value defined in MonitoredRequestCountMetric.

      Parameters:
      totalRequestCountMetric - Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO. This result will be divided by the "good request" or "bad request" value defined in MonitoredRequestCountMetric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalRequestCountMetric

      RequestBasedServiceLevelIndicatorMetricConfig.Builder totalRequestCountMetric(Consumer<MetricDataQuery.Builder>... totalRequestCountMetric)

      Use this structure to define the metric that you want to use as the "total requests" number for a request-based SLO. This result will be divided by the "good request" or "bad request" value defined in MonitoredRequestCountMetric.

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

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

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

    • monitoredRequestCountMetric

      RequestBasedServiceLevelIndicatorMetricConfig.Builder monitoredRequestCountMetric(MonitoredRequestCountMetricDataQueries monitoredRequestCountMetric)

      Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

      Parameters:
      monitoredRequestCountMetric - Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • monitoredRequestCountMetric

      default RequestBasedServiceLevelIndicatorMetricConfig.Builder monitoredRequestCountMetric(Consumer<MonitoredRequestCountMetricDataQueries.Builder> monitoredRequestCountMetric)

      Use this structure to define the metric that you want to use as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric will be divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

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

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

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

    • dependencyConfig

      RequestBasedServiceLevelIndicatorMetricConfig.Builder dependencyConfig(DependencyConfig dependencyConfig)

      Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

      Parameters:
      dependencyConfig - Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • dependencyConfig

      default RequestBasedServiceLevelIndicatorMetricConfig.Builder dependencyConfig(Consumer<DependencyConfig.Builder> dependencyConfig)

      Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

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

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

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