Package software.amazon.awssdk.services.mediastore.model

Class MetricPolicy

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

The metric policy that is associated with the container. A metric policy allows AWS Elemental MediaStore to send metrics to Amazon CloudWatch. In the policy, you must indicate whether you want MediaStore to send container-level metrics. You can also include rules to define groups of objects that you want MediaStore to send object-level metrics for.

To view examples of how to construct a metric policy for your use case, see Example Metric Policies.

See Also:

  • Method Details

    • containerLevelMetrics

      public final ContainerLevelMetrics containerLevelMetrics()

      A setting to enable or disable metrics at the container level.

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

      Returns:
      A setting to enable or disable metrics at the container level.
      See Also:

    • containerLevelMetricsAsString

      public final String containerLevelMetricsAsString()

      A setting to enable or disable metrics at the container level.

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

      Returns:
      A setting to enable or disable metrics at the container level.
      See Also:

    • hasMetricPolicyRules

      public final boolean hasMetricPolicyRules()
      For responses, this returns true if the service returned a value for the MetricPolicyRules 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.

    • metricPolicyRules

      public final List<MetricPolicyRule> metricPolicyRules()

      A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy.

      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 hasMetricPolicyRules() method.

      Returns:
      A parameter that holds an array of rules that enable metrics at the object level. This parameter is optional, but if you choose to include it, you must also include at least one rule. By default, you can include up to five rules. You can also request a quota increase to allow up to 300 rules per policy.

    • toBuilder

      public MetricPolicy.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<MetricPolicy.Builder,MetricPolicy>
      Returns:
      a builder for type T

    • builder

      public static MetricPolicy.Builder builder()

    • serializableBuilderClass

      public static Class<? extends MetricPolicy.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.