Interface ListDocumentsRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>
,SdkBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>
,SdkPojo
,SdkRequest.Builder
,SsmRequest.Builder
- Enclosing class:
- ListDocumentsRequest
public static interface ListDocumentsRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<ListDocumentsRequest.Builder,ListDocumentsRequest>
-
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder
build
-
-
-
-
Method Detail
-
documentFilterList
ListDocumentsRequest.Builder documentFilterList(Collection<DocumentFilter> documentFilterList)
This data type is deprecated. Instead, use
Filters
.- Parameters:
documentFilterList
- This data type is deprecated. Instead, useFilters
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentFilterList
ListDocumentsRequest.Builder documentFilterList(DocumentFilter... documentFilterList)
This data type is deprecated. Instead, use
Filters
.- Parameters:
documentFilterList
- This data type is deprecated. Instead, useFilters
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
documentFilterList
ListDocumentsRequest.Builder documentFilterList(Consumer<DocumentFilter.Builder>... documentFilterList)
This data type is deprecated. Instead, use
This is a convenience method that creates an instance of theFilters
.DocumentFilter.Builder
avoiding the need to create one manually viaDocumentFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#documentFilterList(List
.) - Parameters:
documentFilterList
- a consumer that will call methods onDocumentFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#documentFilterList(java.util.Collection
)
-
filters
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 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
- Parameters:
filters
- One or moreDocumentKeyValuesFilter
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
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 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
- Parameters:
filters
- One or moreDocumentKeyValuesFilter
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
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
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 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
DocumentKeyValuesFilter.Builder
avoiding the need to create one manually viaDocumentKeyValuesFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#filters(List
.) - Parameters:
filters
- a consumer that will call methods onDocumentKeyValuesFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection
)
-
maxResults
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
ListDocumentsRequest.Builder nextToken(String nextToken)
The token for the next set of items to return. (You received this token from a previous call.)
- Parameters:
nextToken
- The token for the next set of items to return. (You received this token from a previous call.)- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
ListDocumentsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
ListDocumentsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-