Interface DescribeParametersRequest.Builder
-
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeParametersRequest.Builder,DescribeParametersRequest>
,SdkBuilder<DescribeParametersRequest.Builder,DescribeParametersRequest>
,SdkPojo
,SdkRequest.Builder
,SsmRequest.Builder
- Enclosing class:
- DescribeParametersRequest
public static interface DescribeParametersRequest.Builder extends SsmRequest.Builder, SdkPojo, CopyableBuilder<DescribeParametersRequest.Builder,DescribeParametersRequest>
-
-
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
-
filters
DescribeParametersRequest.Builder filters(Collection<ParametersFilter> filters)
This data type is deprecated. Instead, use
ParameterFilters
.- Parameters:
filters
- This data type is deprecated. Instead, useParameterFilters
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
DescribeParametersRequest.Builder filters(ParametersFilter... filters)
This data type is deprecated. Instead, use
ParameterFilters
.- Parameters:
filters
- This data type is deprecated. Instead, useParameterFilters
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
DescribeParametersRequest.Builder filters(Consumer<ParametersFilter.Builder>... filters)
This data type is deprecated. Instead, use
This is a convenience method that creates an instance of theParameterFilters
.ParametersFilter.Builder
avoiding the need to create one manually viaParametersFilter.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 onParametersFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#filters(java.util.Collection
)
-
parameterFilters
DescribeParametersRequest.Builder parameterFilters(Collection<ParameterStringFilter> parameterFilters)
Filters to limit the request results.
- Parameters:
parameterFilters
- Filters to limit the request results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameterFilters
DescribeParametersRequest.Builder parameterFilters(ParameterStringFilter... parameterFilters)
Filters to limit the request results.
- Parameters:
parameterFilters
- Filters to limit the request results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
parameterFilters
DescribeParametersRequest.Builder parameterFilters(Consumer<ParameterStringFilter.Builder>... parameterFilters)
Filters to limit the request results.
This is a convenience method that creates an instance of theParameterStringFilter.Builder
avoiding the need to create one manually viaParameterStringFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#parameterFilters(List
.) - Parameters:
parameterFilters
- a consumer that will call methods onParameterStringFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#parameterFilters(java.util.Collection
)
-
maxResults
DescribeParametersRequest.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
DescribeParametersRequest.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.
-
shared
DescribeParametersRequest.Builder shared(Boolean shared)
Lists parameters that are shared with you.
By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated
RAM Resource Share Created From Policy
must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
- Parameters:
shared
- Lists parameters that are shared with you.By default when using this option, the command returns parameters that have been shared using a standard Resource Access Manager Resource Share. In order for a parameter that was shared using the PutResourcePolicy command to be returned, the associated
RAM Resource Share Created From Policy
must have been promoted to a standard Resource Share using the RAM PromoteResourceShareCreatedFromPolicy API operation.For more information about sharing parameters, see Working with shared parameters in the Amazon Web Services Systems Manager User Guide.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeParametersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
overrideConfiguration
DescribeParametersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
-
-