public static interface ListDocumentsRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ListDocumentsRequest.Builder documentFilterList(Collection<DocumentFilter> documentFilterList)
This data type is deprecated. Instead, use Filters
.
documentFilterList
- This data type is deprecated. Instead, use Filters
.ListDocumentsRequest.Builder documentFilterList(DocumentFilter... documentFilterList)
This data type is deprecated. Instead, use Filters
.
documentFilterList
- This data type is deprecated. Instead, use Filters
.ListDocumentsRequest.Builder documentFilterList(Consumer<DocumentFilter.Builder>... documentFilterList)
This data type is deprecated. Instead, use Filters
.
List.Builder
avoiding the need
to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #documentFilterList(List)
.documentFilterList
- a consumer that will call methods on List.Builder
#documentFilterList(List)
ListDocumentsRequest.Builder filters(Collection<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
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
ListDocumentsRequest.Builder filters(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
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
ListDocumentsRequest.Builder filters(Consumer<DocumentKeyValuesFilter.Builder>... 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
List.Builder
avoiding the need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called
immediately and its result is passed to #filters(List)
.filters
- a consumer that will call methods on List.Builder
#filters(List)
ListDocumentsRequest.Builder maxResults(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.
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.ListDocumentsRequest.Builder nextToken(String nextToken)
The token for the next set of items to return. (You received this token from a previous call.)
nextToken
- The token for the next set of items to return. (You received this token from a previous call.)ListDocumentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ListDocumentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2021 Amazon Web Services, Inc. All Rights Reserved.