Interface ListRulesRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ListRulesRequest.Builder,ListRulesRequest>, RbinRequest.Builder, SdkBuilder<ListRulesRequest.Builder,ListRulesRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ListRulesRequest

@Mutable
@NotThreadSafe
public static interface ListRulesRequest.Builder
extends RbinRequest.Builder, SdkPojo, CopyableBuilder<ListRulesRequest.Builder,ListRulesRequest>

Method Summary

Modifier and Type	Method	Description
ListRulesRequest.Builder	excludeResourceTags(Collection<ResourceTag> excludeResourceTags)	[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.
ListRulesRequest.Builder	excludeResourceTags(Consumer<ResourceTag.Builder>... excludeResourceTags)	[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.
ListRulesRequest.Builder	excludeResourceTags(ResourceTag... excludeResourceTags)	[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.
ListRulesRequest.Builder	lockState(String lockState)	The lock state of the retention rules to list.
ListRulesRequest.Builder	lockState(LockState lockState)	The lock state of the retention rules to list.
ListRulesRequest.Builder	maxResults(Integer maxResults)	The maximum number of results to return with a single call.
ListRulesRequest.Builder	nextToken(String nextToken)	The token for the next page of results.
ListRulesRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
ListRulesRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
ListRulesRequest.Builder	resourceTags(Collection<ResourceTag> resourceTags)	[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
ListRulesRequest.Builder	resourceTags(Consumer<ResourceTag.Builder>... resourceTags)	[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
ListRulesRequest.Builder	resourceTags(ResourceTag... resourceTags)	[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.
ListRulesRequest.Builder	resourceType(String resourceType)	The resource type retained by the retention rule.
ListRulesRequest.Builder	resourceType(ResourceType resourceType)	The resource type retained by the retention rule.

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.rbin.model.RbinRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

maxResults

ListRulesRequest.Builder maxResults(Integer maxResults)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Parameters:

maxResults - The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned NextToken value.

Returns:

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

nextToken

ListRulesRequest.Builder nextToken(String nextToken)

The token for the next page of results.

Parameters:

nextToken - The token for the next page of results.

Returns:

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

resourceType

ListRulesRequest.Builder resourceType(String resourceType)

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Parameters:

resourceType - The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Returns:

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

See Also:

• ResourceType
• ResourceType

resourceType

ListRulesRequest.Builder resourceType(ResourceType resourceType)

The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Parameters:

resourceType - The resource type retained by the retention rule. Only retention rules that retain the specified resource type are listed. Currently, only Amazon EBS snapshots and EBS-backed AMIs are supported. To list retention rules that retain snapshots, specify EBS_SNAPSHOT. To list retention rules that retain EBS-backed AMIs, specify EC2_IMAGE.

Returns:

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

See Also:

• ResourceType
• ResourceType

resourceTags

ListRulesRequest.Builder resourceTags(Collection<ResourceTag> resourceTags)

[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

Parameters:

resourceTags - [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

Returns:

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

resourceTags

ListRulesRequest.Builder resourceTags(ResourceTag... resourceTags)

[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

Parameters:

resourceTags - [Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

Returns:

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

resourceTags

ListRulesRequest.Builder resourceTags(Consumer<ResourceTag.Builder>... resourceTags)

[Tag-level retention rules only] Information about the resource tags used to identify resources that are retained by the retention rule.

This is a convenience method that creates an instance of the ResourceTag.Builder avoiding the need to create one manually via ResourceTag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to resourceTags(List<ResourceTag>).

Parameters:

resourceTags - a consumer that will call methods on ResourceTag.Builder

Returns:

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

See Also:

• resourceTags(java.util.Collection<ResourceTag>)

lockState

ListRulesRequest.Builder lockState(String lockState)

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Parameters:

lockState - The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Returns:

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

See Also:

• LockState
• LockState

lockState

ListRulesRequest.Builder lockState(LockState lockState)

The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Parameters:

lockState - The lock state of the retention rules to list. Only retention rules with the specified lock state are returned.

Returns:

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

See Also:

• LockState
• LockState

excludeResourceTags

ListRulesRequest.Builder excludeResourceTags(Collection<ResourceTag> excludeResourceTags)

[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

Parameters:

excludeResourceTags - [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

Returns:

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

excludeResourceTags

ListRulesRequest.Builder excludeResourceTags(ResourceTag... excludeResourceTags)

[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

Parameters:

excludeResourceTags - [Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

Returns:

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

excludeResourceTags

ListRulesRequest.Builder excludeResourceTags(Consumer<ResourceTag.Builder>... excludeResourceTags)

[Region-level retention rules only] Information about the exclusion tags used to identify resources that are to be excluded, or ignored, by the retention rule.

This is a convenience method that creates an instance of the ResourceTag.Builder avoiding the need to create one manually via ResourceTag.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to excludeResourceTags(List<ResourceTag>).

Parameters:

excludeResourceTags - a consumer that will call methods on ResourceTag.Builder

Returns:

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

See Also:

• excludeResourceTags(java.util.Collection<ResourceTag>)

overrideConfiguration

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

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