software.amazon.awssdk.services.ssm.model

Class OpsItemFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.OpsItemFilter

All Implemented Interfaces:

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

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

Describes an OpsItem filter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	OpsItemFilter.Builder

Method Summary

Modifier and Type	Method and Description
static OpsItemFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues() Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty).
OpsItemFilterKey	key() The name of the filter.
String	keyAsString() The name of the filter.
OpsItemFilterOperator	operator() The operator used by the filter call.
String	operatorAsString() The operator used by the filter call.
List<SdkField<?>>	sdkFields()
static Class<? extends OpsItemFilter.Builder>	serializableBuilderClass()
OpsItemFilter.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.
List<String>	values() The filter value.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

key

public final OpsItemFilterKey key()

The name of the filter.

If the service returns an enum value that is not available in the current SDK version, key will return OpsItemFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The name of the filter.

See Also:

OpsItemFilterKey

keyAsString

public final String keyAsString()

The name of the filter.

If the service returns an enum value that is not available in the current SDK version, key will return OpsItemFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The name of the filter.

See Also:

OpsItemFilterKey

hasValues

public final boolean hasValues()

Returns true if the Values property was specified by the sender (it may be empty), or false if the sender did not specify the value (it will be empty). For responses returned by the SDK, the sender is the AWS service.

values

public final List<String> values()

The filter value.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

You can use hasValues() to see if a value was sent in this field.

Returns:

The filter value.

operator

public final OpsItemFilterOperator operator()

The operator used by the filter call.

If the service returns an enum value that is not available in the current SDK version, operator will return OpsItemFilterOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

The operator used by the filter call.

See Also:

OpsItemFilterOperator

operatorAsString

public final String operatorAsString()

The operator used by the filter call.

If the service returns an enum value that is not available in the current SDK version, operator will return OpsItemFilterOperator.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from operatorAsString().

Returns:

The operator used by the filter call.

See Also:

OpsItemFilterOperator

toBuilder

public OpsItemFilter.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<OpsItemFilter.Builder,OpsItemFilter>

Returns:

a builder for type T

builder

public static OpsItemFilter.Builder builder()

serializableBuilderClass

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

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.