Class RequestBasedServiceLevelIndicatorMetricConfig

java.lang.Object
software.amazon.awssdk.services.applicationsignals.model.RequestBasedServiceLevelIndicatorMetricConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<RequestBasedServiceLevelIndicatorMetricConfig.Builder,RequestBasedServiceLevelIndicatorMetricConfig>
@Generated("software.amazon.awssdk:codegen") public final class RequestBasedServiceLevelIndicatorMetricConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RequestBasedServiceLevelIndicatorMetricConfig.Builder,RequestBasedServiceLevelIndicatorMetricConfig>

Use this structure to specify the information for the metric that a period-based SLO will monitor.

See Also:

  • Method Details

    • hasKeyAttributes

      public final boolean hasKeyAttributes()
      For responses, this returns true if the service returned a value for the KeyAttributes property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • keyAttributes

      public final 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasKeyAttributes() method.

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

    • operationName

      public final String operationName()

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

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

    • metricType

      public final 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.

      If the service returns an enum value that is not available in the current SDK version, metricType will return ServiceLevelIndicatorMetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricTypeAsString().

      Returns:
      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.
      See Also:

    • metricTypeAsString

      public final String metricTypeAsString()

      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.

      If the service returns an enum value that is not available in the current SDK version, metricType will return ServiceLevelIndicatorMetricType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from metricTypeAsString().

      Returns:
      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.
      See Also:

    • hasTotalRequestCountMetric

      public final boolean hasTotalRequestCountMetric()
      For responses, this returns true if the service returned a value for the TotalRequestCountMetric property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • totalRequestCountMetric

      public final List<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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTotalRequestCountMetric() method.

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

    • monitoredRequestCountMetric

      public final 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.

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

    • dependencyConfig

      public final DependencyConfig dependencyConfig()

      Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName .

      Returns:
      Identifies the dependency using the DependencyKeyAttributes and DependencyOperationName.

    • toBuilder

      public RequestBasedServiceLevelIndicatorMetricConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<RequestBasedServiceLevelIndicatorMetricConfig.Builder,RequestBasedServiceLevelIndicatorMetricConfig>
      Returns:
      a builder for type T

    • builder

      public static RequestBasedServiceLevelIndicatorMetricConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends RequestBasedServiceLevelIndicatorMetricConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.