software.amazon.awssdk.services.ssm.model

Interface DescribePatchGroupsRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<DescribePatchGroupsRequest.Builder,DescribePatchGroupsRequest>, SdkBuilder<DescribePatchGroupsRequest.Builder,DescribePatchGroupsRequest>, SdkPojo, SdkRequest.Builder, SsmRequest.Builder

Enclosing class:

DescribePatchGroupsRequest

public static interface DescribePatchGroupsRequest.Builder
extends SsmRequest.Builder, SdkPojo, CopyableBuilder<DescribePatchGroupsRequest.Builder,DescribePatchGroupsRequest>

Method Summary

Modifier and Type	Method and Description
DescribePatchGroupsRequest.Builder	filters(Collection<PatchOrchestratorFilter> filters) One or more filters.
DescribePatchGroupsRequest.Builder	filters(Consumer<PatchOrchestratorFilter.Builder>... filters) One or more filters.
DescribePatchGroupsRequest.Builder	filters(PatchOrchestratorFilter... filters) One or more filters.
DescribePatchGroupsRequest.Builder	maxResults(Integer maxResults) The maximum number of patch groups to return (per page).
DescribePatchGroupsRequest.Builder	nextToken(String nextToken) The token for the next set of items to return.
DescribePatchGroupsRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
DescribePatchGroupsRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.

Methods inherited from interface software.amazon.awssdk.services.ssm.model.SsmRequest.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

maxResults

DescribePatchGroupsRequest.Builder maxResults(Integer maxResults)

The maximum number of patch groups to return (per page).

Parameters:

maxResults - The maximum number of patch groups to return (per page).

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribePatchGroupsRequest.Builder filters(Collection<PatchOrchestratorFilter> filters)

One or more filters. Use a filter to return a more specific list of results.

For DescribePatchGroups,valid filter keys include the following:

• NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.

• OPERATING_SYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.

  Examples:

  • --filters Key=NAME_PREFIX,Values=MyPatchGroup*

  • --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2

Parameters:

filters - One or more filters. Use a filter to return a more specific list of results.

For DescribePatchGroups,valid filter keys include the following:

• NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.

• OPERATING_SYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.

  Examples:

  • --filters Key=NAME_PREFIX,Values=MyPatchGroup*

  • --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribePatchGroupsRequest.Builder filters(PatchOrchestratorFilter... filters)

One or more filters. Use a filter to return a more specific list of results.

For DescribePatchGroups,valid filter keys include the following:

• NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.

• OPERATING_SYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.

  Examples:

  • --filters Key=NAME_PREFIX,Values=MyPatchGroup*

  • --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2

Parameters:

filters - One or more filters. Use a filter to return a more specific list of results.

For DescribePatchGroups,valid filter keys include the following:

• NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.

• OPERATING_SYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.

  Examples:

  • --filters Key=NAME_PREFIX,Values=MyPatchGroup*

  • --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2

Returns:

Returns a reference to this object so that method calls can be chained together.

filters

DescribePatchGroupsRequest.Builder filters(Consumer<PatchOrchestratorFilter.Builder>... filters)

One or more filters. Use a filter to return a more specific list of results.

For DescribePatchGroups,valid filter keys include the following:

• NAME_PREFIX: The name of the patch group. Wildcards (*) are accepted.

• OPERATING_SYSTEM: The supported operating system type to return results for. For valid operating system values, see GetDefaultPatchBaselineRequest$OperatingSystem in CreatePatchBaseline.

  Examples:

  • --filters Key=NAME_PREFIX,Values=MyPatchGroup*

  • --filters Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2

This is a convenience that creates an instance of the 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).

Parameters:

filters - a consumer that will call methods on List.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

#filters(List)

nextToken

DescribePatchGroupsRequest.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

DescribePatchGroupsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

DescribePatchGroupsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.