Interface DescribePackagesRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribePackagesRequest.Builder,
,DescribePackagesRequest> OpenSearchRequest.Builder
,SdkBuilder<DescribePackagesRequest.Builder,
,DescribePackagesRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribePackagesRequest
public static interface DescribePackagesRequest.Builder
extends OpenSearchRequest.Builder, SdkPojo, CopyableBuilder<DescribePackagesRequest.Builder,DescribePackagesRequest>
-
Method Summary
Modifier and TypeMethodDescriptionfilters
(Collection<DescribePackagesFilter> filters) Only returns packages that match theDescribePackagesFilterList
values.filters
(Consumer<DescribePackagesFilter.Builder>... filters) Only returns packages that match theDescribePackagesFilterList
values.filters
(DescribePackagesFilter... filters) Only returns packages that match theDescribePackagesFilterList
values.maxResults
(Integer maxResults) An optional parameter that specifies the maximum number of results to return.If your initialDescribePackageFilters
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribePackageFilters
operations, which returns results in the next page.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.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.services.opensearch.model.OpenSearchRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
filters
Only returns packages that match the
DescribePackagesFilterList
values.- Parameters:
filters
- Only returns packages that match theDescribePackagesFilterList
values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
Only returns packages that match the
DescribePackagesFilterList
values.- Parameters:
filters
- Only returns packages that match theDescribePackagesFilterList
values.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
filters
Only returns packages that match the
This is a convenience method that creates an instance of theDescribePackagesFilterList
values.DescribePackagesFilter.Builder
avoiding the need to create one manually viaDescribePackagesFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<DescribePackagesFilter>)
.- Parameters:
filters
- a consumer that will call methods onDescribePackagesFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
maxResults
An optional parameter that specifies the maximum number of results to return. You can use
nextToken
to get the next page of results.- Parameters:
maxResults
- An optional parameter that specifies the maximum number of results to return. You can usenextToken
to get the next page of results.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
nextToken
If your initial
DescribePackageFilters
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribePackageFilters
operations, which returns results in the next page.- Parameters:
nextToken
- If your initialDescribePackageFilters
operation returns anextToken
, you can include the returnednextToken
in subsequentDescribePackageFilters
operations, which returns results in the next page.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribePackagesRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
DescribePackagesRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-