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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	MetricPolicy.Builder

Method Summary

Modifier and Type	Method	Description
static MetricPolicy.Builder	builder()
ContainerLevelMetrics	containerLevelMetrics()	A setting to enable or disable metrics at the container level.
String	containerLevelMetricsAsString()	A setting to enable or disable metrics at the container level.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasMetricPolicyRules()	For responses, this returns true if the service returned a value for the MetricPolicyRules property.
List<MetricPolicyRule>	metricPolicyRules()	A parameter that holds an array of rules that enable metrics at the object level.
List<SdkField<?>>	sdkFields()
static Class<? extends MetricPolicy.Builder>	serializableBuilderClass()
MetricPolicy.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

ContainerLevelMetrics

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:

ContainerLevelMetrics

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()

Specified by:

toBuilder in interface ToCopyableBuilder<MetricPolicy.Builder,MetricPolicy>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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