Interface RequestBasedServiceLevelIndicatorMetric.Builder

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

  • Method Details

    • keyAttributes

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

      This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

      • Type designates the type of object that this SLO is related to.

      • 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 - This is a string-to-string map that contains information about the type of object that this SLO is related to. It can include the following fields.

      • Type designates the type of object that this SLO is related to.

      • 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

      RequestBasedServiceLevelIndicatorMetric.Builder operationName(String operationName)

      If the SLO monitors a specific operation of the service, this field displays that operation name.

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

    • metricType

      RequestBasedServiceLevelIndicatorMetric.Builder metricType(String metricType)

      If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

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

    • metricType

      RequestBasedServiceLevelIndicatorMetric.Builder metricType(ServiceLevelIndicatorMetricType metricType)

      If the SLO monitors either the LATENCY or AVAILABILITY metric that Application Signals collects, this field displays which of those metrics is used.

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

    • totalRequestCountMetric

      RequestBasedServiceLevelIndicatorMetric.Builder totalRequestCountMetric(Collection<MetricDataQuery> totalRequestCountMetric)

      This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric.

      Parameters:
      totalRequestCountMetric - This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalRequestCountMetric

      RequestBasedServiceLevelIndicatorMetric.Builder totalRequestCountMetric(MetricDataQuery... totalRequestCountMetric)

      This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric.

      Parameters:
      totalRequestCountMetric - This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric defined in MonitoredRequestCountMetric.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • totalRequestCountMetric

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

      This structure defines the metric that is used as the "total requests" number for a request-based SLO. The number observed for this metric is divided by the number of "good requests" or "bad requests" that is observed for the metric 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

      RequestBasedServiceLevelIndicatorMetric.Builder monitoredRequestCountMetric(MonitoredRequestCountMetricDataQueries monitoredRequestCountMetric)

      This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is divided by the number found for MonitoredRequestCountMetric to determine the percentage of successful requests that this SLO tracks.

      Parameters:
      monitoredRequestCountMetric - This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is 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 RequestBasedServiceLevelIndicatorMetric.Builder monitoredRequestCountMetric(Consumer<MonitoredRequestCountMetricDataQueries.Builder> monitoredRequestCountMetric)

      This structure defines the metric that is used as the "good request" or "bad request" value for a request-based SLO. This value observed for the metric defined in TotalRequestCountMetric is 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

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