Package software.amazon.awssdk.services.ssm.model

Class DocumentFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.DocumentFilter

All Implemented Interfaces:

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

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

This data type is deprecated. Instead, use DocumentKeyValuesFilter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentFilter.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentFilter.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
DocumentFilterKey	key()	The name of the filter.
String	keyAsString()	The name of the filter.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentFilter.Builder>	serializableBuilderClass()
DocumentFilter.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	value()	The value of the filter.

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

key

public final DocumentFilterKey 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 DocumentFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The name of the filter.

See Also:

DocumentFilterKey

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 DocumentFilterKey.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from keyAsString().

Returns:

The name of the filter.

See Also:

DocumentFilterKey

value

public final String value()

The value of the filter.

Returns:

The value of the filter.

toBuilder

public DocumentFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentFilter.Builder,DocumentFilter>

builder

public static DocumentFilter.Builder builder()

serializableBuilderClass

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