software.amazon.awssdk.services.ssm.model

Class DocumentKeyValuesFilter

java.lang.Object

software.amazon.awssdk.services.ssm.model.DocumentKeyValuesFilter

All Implemented Interfaces:

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

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

One or more filters. Use a filter to return a more specific list of documents.

For keys, you can specify one or more tags that have been applied to a document.

You can also use Amazon Web Services-provided keys, some of which have specific allowed values. These keys and their associated values are as follows:

DocumentType

• ApplicationConfiguration

• ApplicationConfigurationSchema

• Automation

• ChangeCalendar

• Command

• DeploymentStrategy

• Package

• Policy

• Session

Owner

Note that only one Owner can be specified in a request. For example: Key=Owner,Values=Self.

• Amazon

• Private

• Public

• Self

• ThirdParty

PlatformTypes

• Linux

• Windows

Name is another Amazon Web Services-provided key. If you use Name as a key, you can use a name prefix to return a list of documents. For example, in the Amazon Web Services CLI, to return a list of all documents that begin with Te, run the following command:

aws ssm list-documents --filters Key=Name,Values=Te

You can also use the TargetType Amazon Web Services-provided key. For a list of valid resource type values that can be used with this key, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

If you specify more than two keys, only documents that are identified by all the tags are returned in the results. If you specify more than two values for a key, documents that are identified by any of the values are returned in the results.

To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

For example, if you created a key called region and are using the Amazon Web Services CLI to call the list-documents command:

aws ssm list-documents --filters Key=tag:region,Values=east,west Key=Owner,Values=Self

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	DocumentKeyValuesFilter.Builder

Method Summary

Modifier and Type	Method and Description
static DocumentKeyValuesFilter.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	key() The name of the filter key.
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentKeyValuesFilter.Builder>	serializableBuilderClass()
DocumentKeyValuesFilter.Builder	toBuilder()
String	toString() Returns a string representation of this object.
List<String>	values() The value for the filter key.

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 String key()

The name of the filter key.

Returns:

The name of the filter key.

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 value for the filter key.

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 value for the filter key.

toBuilder

public DocumentKeyValuesFilter.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentKeyValuesFilter.Builder,DocumentKeyValuesFilter>

builder

public static DocumentKeyValuesFilter.Builder builder()

serializableBuilderClass

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