software.amazon.awssdk.services.rbin.model

Interface GetRuleResponse.Builder

All Superinterfaces:

AwsResponse.Builder, Buildable, CopyableBuilder<GetRuleResponse.Builder,GetRuleResponse>, RbinResponse.Builder, SdkBuilder<GetRuleResponse.Builder,GetRuleResponse>, SdkPojo, SdkResponse.Builder

Enclosing class:

GetRuleResponse

public static interface GetRuleResponse.Builder
extends RbinResponse.Builder, SdkPojo, CopyableBuilder<GetRuleResponse.Builder,GetRuleResponse>

Method Summary

Modifier and Type	Method and Description
GetRuleResponse.Builder	description(String description) The retention rule description.
GetRuleResponse.Builder	identifier(String identifier) The unique ID of the retention rule.
default GetRuleResponse.Builder	lockConfiguration(Consumer<LockConfiguration.Builder> lockConfiguration) Information about the retention rule lock configuration.
GetRuleResponse.Builder	lockConfiguration(LockConfiguration lockConfiguration) Information about the retention rule lock configuration.
GetRuleResponse.Builder	lockEndTime(Instant lockEndTime) The date and time at which the unlock delay is set to expire.
GetRuleResponse.Builder	lockState(LockState lockState) The lock state for the retention rule.
GetRuleResponse.Builder	lockState(String lockState) The lock state for the retention rule.
GetRuleResponse.Builder	resourceTags(Collection<ResourceTag> resourceTags) Information about the resource tags used to identify resources that are retained by the retention rule.
GetRuleResponse.Builder	resourceTags(Consumer<ResourceTag.Builder>... resourceTags) Information about the resource tags used to identify resources that are retained by the retention rule.
GetRuleResponse.Builder	resourceTags(ResourceTag... resourceTags) Information about the resource tags used to identify resources that are retained by the retention rule.
GetRuleResponse.Builder	resourceType(ResourceType resourceType) The resource type retained by the retention rule.
GetRuleResponse.Builder	resourceType(String resourceType) The resource type retained by the retention rule.
default GetRuleResponse.Builder	retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod) Information about the retention period for which the retention rule is to retain resources.
GetRuleResponse.Builder	retentionPeriod(RetentionPeriod retentionPeriod) Information about the retention period for which the retention rule is to retain resources.
GetRuleResponse.Builder	status(RuleStatus status) The state of the retention rule.
GetRuleResponse.Builder	status(String status) The state of the retention rule.

Methods inherited from interface software.amazon.awssdk.services.rbin.model.RbinResponse.Builder

build, responseMetadata, responseMetadata

Methods inherited from interface software.amazon.awssdk.core.SdkResponse.Builder

sdkHttpResponse, sdkHttpResponse

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

identifier

GetRuleResponse.Builder identifier(String identifier)

The unique ID of the retention rule.

Parameters:

identifier - The unique ID of the retention rule.

Returns:

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

description

GetRuleResponse.Builder description(String description)

The retention rule description.

Parameters:

description - The retention rule description.

Returns:

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

resourceType

GetRuleResponse.Builder resourceType(String resourceType)

The resource type retained by the retention rule.

Parameters:

resourceType - The resource type retained by the retention rule.

Returns:

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

See Also:

ResourceType, ResourceType

resourceType

GetRuleResponse.Builder resourceType(ResourceType resourceType)

The resource type retained by the retention rule.

Parameters:

resourceType - The resource type retained by the retention rule.

Returns:

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

See Also:

ResourceType, ResourceType

retentionPeriod

GetRuleResponse.Builder retentionPeriod(RetentionPeriod retentionPeriod)

Information about the retention period for which the retention rule is to retain resources.

Parameters:

retentionPeriod - Information about the retention period for which the retention rule is to retain resources.

Returns:

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

retentionPeriod

default GetRuleResponse.Builder retentionPeriod(Consumer<RetentionPeriod.Builder> retentionPeriod)

Information about the retention period for which the retention rule is to retain resources.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to retentionPeriod(RetentionPeriod).

Parameters:

retentionPeriod - a consumer that will call methods on RetentionPeriod.Builder

Returns:

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

See Also:

retentionPeriod(RetentionPeriod)

resourceTags

GetRuleResponse.Builder resourceTags(Collection<ResourceTag> resourceTags)

Information about the resource tags used to identify resources that are retained by the retention rule.

Parameters:

resourceTags - 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

GetRuleResponse.Builder resourceTags(ResourceTag... resourceTags)

Information about the resource tags used to identify resources that are retained by the retention rule.

Parameters:

resourceTags - 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

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

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

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)

status

GetRuleResponse.Builder status(String status)

The state of the retention rule. Only retention rules that are in the available state retain resources.

Parameters:

status - The state of the retention rule. Only retention rules that are in the available state retain resources.

Returns:

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

See Also:

RuleStatus, RuleStatus

status

GetRuleResponse.Builder status(RuleStatus status)

The state of the retention rule. Only retention rules that are in the available state retain resources.

Parameters:

status - The state of the retention rule. Only retention rules that are in the available state retain resources.

Returns:

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

See Also:

RuleStatus, RuleStatus

lockConfiguration

GetRuleResponse.Builder lockConfiguration(LockConfiguration lockConfiguration)

Information about the retention rule lock configuration.

Parameters:

lockConfiguration - Information about the retention rule lock configuration.

Returns:

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

lockConfiguration

default GetRuleResponse.Builder lockConfiguration(Consumer<LockConfiguration.Builder> lockConfiguration)

Information about the retention rule lock configuration.

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

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to lockConfiguration(LockConfiguration).

Parameters:

lockConfiguration - a consumer that will call methods on LockConfiguration.Builder

Returns:

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

See Also:

lockConfiguration(LockConfiguration)

lockState

GetRuleResponse.Builder lockState(String lockState)

The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

Parameters:

lockState - The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

Returns:

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

See Also:

LockState, LockState

lockState

GetRuleResponse.Builder lockState(LockState lockState)

The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

Parameters:

lockState - The lock state for the retention rule.

• locked - The retention rule is locked and can't be modified or deleted.

• pending_unlock - The retention rule has been unlocked but it is still within the unlock delay period. The retention rule can be modified or deleted only after the unlock delay period has expired.

• unlocked - The retention rule is unlocked and it can be modified or deleted by any user with the required permissions.

• null - The retention rule has never been locked. Once a retention rule has been locked, it can transition between the locked and unlocked states only; it can never transition back to null.

Returns:

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

See Also:

LockState, LockState

lockEndTime

GetRuleResponse.Builder lockEndTime(Instant lockEndTime)

The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

Parameters:

lockEndTime - The date and time at which the unlock delay is set to expire. Only returned for retention rules that have been unlocked and that are still within the unlock delay period.

Returns:

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