@Generated(value="software.amazon.awssdk:codegen") public final class MetricStreamFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<MetricStreamFilter.Builder,MetricStreamFilter>
This structure contains a metric namespace and optionally, a list of metric names, to either include in a metric stream or exclude from a metric stream.
A metric stream's filters can include up to 1000 total names. This limit applies to the sum of namespace names and metric names in the filters. For example, this could include 10 metric namespace filters with 99 metrics each, or 20 namespace filters with 49 metrics specified in each filter.
Modifier and Type | Class and Description |
---|---|
static interface |
MetricStreamFilter.Builder |
Modifier and Type | Method and Description |
---|---|
static MetricStreamFilter.Builder |
builder() |
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
boolean |
hasMetricNames()
For responses, this returns true if the service returned a value for the MetricNames property.
|
List<String> |
metricNames()
The names of the metrics to either include or exclude from the metric stream.
|
String |
namespace()
The name of the metric namespace for this filter.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends MetricStreamFilter.Builder> |
serializableBuilderClass() |
MetricStreamFilter.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
copy
public final String namespace()
The name of the metric namespace for this filter.
The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.
The namespace can contain only ASCII printable characters (ASCII range 32 through 126). It must contain at least one non-whitespace character.
public final boolean hasMetricNames()
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.public final List<String> metricNames()
The names of the metrics to either include or exclude from the metric stream.
If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter.
Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character.
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 hasMetricNames()
method.
If you omit this parameter, all metrics in the namespace are included or excluded, depending on whether this filter is specified as an exclude filter or an include filter.
Each metric name can contain only ASCII printable characters (ASCII range 32 through 126). Each metric name must contain at least one non-whitespace character.
public MetricStreamFilter.Builder toBuilder()
toBuilder
in interface ToCopyableBuilder<MetricStreamFilter.Builder,MetricStreamFilter>
public static MetricStreamFilter.Builder builder()
public static Class<? extends MetricStreamFilter.Builder> serializableBuilderClass()
public final boolean equalsBySdkFields(Object obj)
equalsBySdkFields
in interface SdkPojo
public final String toString()
Copyright © 2023. All rights reserved.