@Generated(value="software.amazon.awssdk:codegen") public final class ListDocumentsRequest extends SsmRequest implements ToCopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
ListDocumentsRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static ListDocumentsRequest.Builder |
builder() |
List<DocumentFilter> |
documentFilterList()
This data type is deprecated.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj)
Indicates whether some other object is "equal to" this one by SDK fields.
|
List<DocumentKeyValuesFilter> |
filters()
One or more
DocumentKeyValuesFilter objects. |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest. |
boolean |
hasDocumentFilterList()
Returns true if the DocumentFilterList property was specified by the sender (it may be empty), or false if the
sender did not specify the value (it will be empty).
|
boolean |
hasFilters()
Returns true if the Filters property was specified by the sender (it may be empty), or false if the sender did
not specify the value (it will be empty).
|
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()
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.
|
overrideConfigurationcopypublic final boolean hasDocumentFilterList()
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.
You can use hasDocumentFilterList() to see if a value was sent in this field.
Filters.public final boolean hasFilters()
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
include Owner, Name, PlatformTypes, DocumentType, and
TargetType. For example, to return documents you own use Key=Owner,Values=Self. To
specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.
This API action 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.
You can use hasFilters() to see if a value was sent in this field.
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 include Owner, Name, PlatformTypes,
DocumentType, and TargetType. For example, to return documents you own use
Key=Owner,Values=Self. To specify a custom key-value pair, use the format
Key=tag:tagName,Values=valueName.
This API action only supports filtering documents by using a single tag key and one or more tag values.
For example: Key=tag:tagName,Values=valueName1,valueName2
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.
public final String nextToken()
The token for the next set of items to return. (You received this token from a previous call.)
public ListDocumentsRequest.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>toBuilder in class SsmRequestpublic static ListDocumentsRequest.Builder builder()
public static Class<? extends ListDocumentsRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
SdkPojoSdkPojo 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.
equalsBySdkFields in interface SdkPojoobj - the object to be compared withpublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequestSdkRequest. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will
again be available.getValueForField in class SdkRequestfieldName - The name of the member to be retrieved.clazz - The class to cast the returned object to.