Class ListDocumentsRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ssm.model.SsmRequest
-
- software.amazon.awssdk.services.ssm.model.ListDocumentsRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>
@Generated("software.amazon.awssdk:codegen") public final class ListDocumentsRequest extends SsmRequest implements ToCopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ListDocumentsRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ListDocumentsRequest.Builder
builder()
List<DocumentFilter>
documentFilterList()
This data type is deprecated.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
List<DocumentKeyValuesFilter>
filters()
One or moreDocumentKeyValuesFilter
objects.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
boolean
hasDocumentFilterList()
For responses, this returns true if the service returned a value for the DocumentFilterList property.boolean
hasFilters()
For responses, this returns true if the service returned a value for the Filters property.int
hashCode()
Integer
maxResults()
The maximum number of items to return for this call.String
nextToken()
The token for the next set of items to return.List<SdkField<?>>
sdkFields()
static Class<? extends ListDocumentsRequest.Builder>
serializableBuilderClass()
ListDocumentsRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
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
-
hasDocumentFilterList
public final boolean hasDocumentFilterList()
For responses, this returns true if the service returned a value for the DocumentFilterList property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
documentFilterList
public final List<DocumentFilter> documentFilterList()
This data type is deprecated. Instead, use
Filters
.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
hasDocumentFilterList()
method.- Returns:
- This data type is deprecated. Instead, use
Filters
.
-
hasFilters
public final boolean hasFilters()
For responses, this returns true if the service returned a value for the Filters property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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.
-
filters
public final List<DocumentKeyValuesFilter> filters()
One or more
DocumentKeyValuesFilter
objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys includeOwner
,Name
,PlatformTypes
,DocumentType
, andTargetType
. For example, to return documents you own useKey=Owner,Values=Self
. To specify a custom key-value pair, use the formatKey=tag:tagName,Values=valueName
.This API operation only supports filtering documents by using a single tag key and one or more tag values. For example:
Key=tag:tagName,Values=valueName1,valueName2
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
hasFilters()
method.- Returns:
- One or more
DocumentKeyValuesFilter
objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys includeOwner
,Name
,PlatformTypes
,DocumentType
, andTargetType
. For example, to return documents you own useKey=Owner,Values=Self
. To specify a custom key-value pair, use the formatKey=tag:tagName,Values=valueName
.This API operation only supports filtering documents by using a single tag key and one or more tag values. For example:
Key=tag:tagName,Values=valueName1,valueName2
-
maxResults
public final Integer maxResults()
The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
- Returns:
- The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.
-
nextToken
public final String nextToken()
The token for the next set of items to return. (You received this token from a previous call.)
- Returns:
- The token for the next set of items to return. (You received this token from a previous call.)
-
toBuilder
public ListDocumentsRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>
- Specified by:
toBuilder
in classSsmRequest
-
builder
public static ListDocumentsRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ListDocumentsRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-