MetricStreamFilter (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cloudwatch.model.MetricStreamFilter

All Implemented Interfaces:

Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class MetricStreamFilter
extends Object
implements Serializable, Cloneable
```
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.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

MetricStreamFilter()

Constructors
Constructor and Description
`MetricStreamFilter()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricStreamFilter`	`clone()`
`boolean`	`equals(Object obj)`
`List<String>`	`getMetricNames()` The names of the metrics to either include or exclude from the metric stream.
`String`	`getNamespace()` The name of the metric namespace for this filter.
`int`	`hashCode()`
`void`	`setMetricNames(Collection<String> metricNames)` The names of the metrics to either include or exclude from the metric stream.
`void`	`setNamespace(String namespace)` The name of the metric namespace for this filter.
`String`	`toString()` Returns a string representation of this object.
`MetricStreamFilter`	`withMetricNames(Collection<String> metricNames)` The names of the metrics to either include or exclude from the metric stream.
`MetricStreamFilter`	`withMetricNames(String... metricNames)` The names of the metrics to either include or exclude from the metric stream.
`MetricStreamFilter`	`withNamespace(String namespace)` The name of the metric namespace for this filter.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MetricStreamFilter
```
public MetricStreamFilter()
```
- Method Detail
  - setNamespace
```
public void setNamespace(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.
    
    Parameters:
    
    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.
  - getNamespace
```
public String getNamespace()
```
    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.
    
    Returns:
    
    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.
  - withNamespace
```
public MetricStreamFilter withNamespace(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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getMetricNames
```
public List<String> getMetricNames()
```
    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.
    
    Returns:
    
    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.
  - setMetricNames
```
public void setMetricNames(Collection<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.
    
    Parameters:
    
    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.
  - withMetricNames
```
public MetricStreamFilter withMetricNames(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.
    
    NOTE: This method appends the values to the existing list (if any). Use setMetricNames(java.util.Collection) or withMetricNames(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withMetricNames
```
public MetricStreamFilter withMetricNames(Collection<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.
    
    Parameters:
    
    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.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public MetricStreamFilter clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.773

Class MetricStreamFilter

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MetricStreamFilter

Method Detail

setNamespace

getNamespace

withNamespace

getMetricNames

setMetricNames

withMetricNames

withMetricNames

toString

equals

hashCode

clone