software.amazon.awssdk.services.elasticbeanstalk.model

Class SearchFilter

java.lang.Object

software.amazon.awssdk.services.elasticbeanstalk.model.SearchFilter

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SearchFilter.Builder,SearchFilter>

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

Describes criteria to restrict a list of results.

For operators that apply a single value to the attribute, the filter is evaluated as follows: Attribute Operator Values[1]

Some operators, e.g. in, can apply multiple values. In this case, the filter is evaluated as a logical union (OR) of applications of the operator to the attribute with each one of the values: (Attribute Operator Values[1]) OR (Attribute Operator Values[2]) OR ...

The valid values for attributes of SearchFilter depend on the API action. For valid values, see the reference page for the API action you're calling that takes a SearchFilter parameter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SearchFilter.Builder

Method Summary

Modifier and Type	Method and Description
String	attribute() The result attribute to which the filter values are applied.
static SearchFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() For responses, this returns true if the service returned a value for the Values property.
String	operator() The operator to apply to the Attribute with each of the Values.
List<SdkField<?>>	sdkFields()
static Class<? extends SearchFilter.Builder>	serializableBuilderClass()
SearchFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() The list of values applied to the Attribute and Operator attributes.

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

attribute

public final String attribute()

The result attribute to which the filter values are applied. Valid values vary by API action.

Returns:

The result attribute to which the filter values are applied. Valid values vary by API action.

operator

public final String operator()

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

Returns:

The operator to apply to the Attribute with each of the Values. Valid values vary by Attribute.

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values 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.

values

public final List<String> values()

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

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

Returns:

The list of values applied to the Attribute and Operator attributes. Number of values and valid values vary by Attribute.

toBuilder

public SearchFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SearchFilter.Builder,SearchFilter>

builder

public static SearchFilter.Builder builder()

serializableBuilderClass

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