java.lang.Object
- software.amazon.awssdk.services.connect.model.Filters

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<Filters.Builder,Filters>

@Generated("software.amazon.awssdk:codegen")
public final class Filters
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Filters.Builder,Filters>

Contains the filter to apply when retrieving metrics.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface Filters.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static Filters.Builder`	`builder()`
`List<Channel>`	`channels()`	The channel to use to filter the metrics.
`List<String>`	`channelsAsStrings()`	The channel to use to filter the metrics.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasChannels()`	For responses, this returns true if the service returned a value for the Channels property.
`int`	`hashCode()`
`boolean`	`hasQueues()`	For responses, this returns true if the service returned a value for the Queues property.
`boolean`	`hasRoutingProfiles()`	For responses, this returns true if the service returned a value for the RoutingProfiles property.
`boolean`	`hasRoutingStepExpressions()`	For responses, this returns true if the service returned a value for the RoutingStepExpressions property.
`List<String>`	`queues()`	The queues to use to filter the metrics.
`List<String>`	`routingProfiles()`	A list of up to 100 routing profile IDs or ARNs.
`List<String>`	`routingStepExpressions()`	A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends Filters.Builder>`	`serializableBuilderClass()`
`Filters.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
  - hasQueues
```
public final boolean hasQueues()
```
    For responses, this returns true if the service returned a value for the Queues 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.
  - queues
```
public final List<String> queues()
```
    The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
    
    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 hasQueues() method.
    
    Returns:
    
    The queues to use to filter the metrics. You should specify at least one queue, and can specify up to 100 queues per request. The GetCurrentMetricsData API in particular requires a queue when you include a Filter in your request.
  - channels
```
public final List<Channel> channels()
```
    The channel to use to filter the metrics.
    
    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 hasChannels() method.
    
    Returns:
    
    The channel to use to filter the metrics.
  - hasChannels
```
public final boolean hasChannels()
```
    For responses, this returns true if the service returned a value for the Channels 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.
  - channelsAsStrings
```
public final List<String> channelsAsStrings()
```
    The channel to use to filter the metrics.
    
    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 hasChannels() method.
    
    Returns:
    
    The channel to use to filter the metrics.
  - hasRoutingProfiles
```
public final boolean hasRoutingProfiles()
```
    For responses, this returns true if the service returned a value for the RoutingProfiles 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.
  - routingProfiles
```
public final List<String> routingProfiles()
```
    A list of up to 100 routing profile IDs or ARNs.
    
    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 hasRoutingProfiles() method.
    
    Returns:
    
    A list of up to 100 routing profile IDs or ARNs.
  - hasRoutingStepExpressions
```
public final boolean hasRoutingStepExpressions()
```
    For responses, this returns true if the service returned a value for the RoutingStepExpressions 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.
  - routingStepExpressions
```
public final List<String> routingStepExpressions()
```
    A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.
    
    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 hasRoutingStepExpressions() method.
    
    Returns:
    
    A list of expressions as a filter, in which an expression is an object of a step in a routing criteria.
  - toBuilder
```
public Filters.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<Filters.Builder,Filters>
  - builder
```
public static Filters.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends Filters.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

Class Filters

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

hasQueues

queues

channels

hasChannels

channelsAsStrings

hasRoutingProfiles

routingProfiles

hasRoutingStepExpressions

routingStepExpressions

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields