software.amazon.awssdk.services.rbin.model

Class CreateRuleResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.rbin.model.RbinResponse

software.amazon.awssdk.services.rbin.model.CreateRuleResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateRuleResponse.Builder,CreateRuleResponse>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateRuleResponse
extends RbinResponse
implements ToCopyableBuilder<CreateRuleResponse.Builder,CreateRuleResponse>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateRuleResponse.Builder

Method Summary

Modifier and Type	Method and Description
static CreateRuleResponse.Builder	builder()
String	description() The retention rule description.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasResourceTags() For responses, this returns true if the service returned a value for the ResourceTags property.
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
String	identifier() The unique ID of the retention rule.
LockConfiguration	lockConfiguration() Information about the retention rule lock configuration.
LockState	lockState() The lock state for the retention rule.
String	lockStateAsString() The lock state for the retention rule.
List<ResourceTag>	resourceTags() Information about the resource tags used to identify resources that are retained by the retention rule.
ResourceType	resourceType() The resource type retained by the retention rule.
String	resourceTypeAsString() The resource type retained by the retention rule.
RetentionPeriod	retentionPeriod() Returns the value of the RetentionPeriod property for this object.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateRuleResponse.Builder>	serializableBuilderClass()
RuleStatus	status() The state of the retention rule.
String	statusAsString() The state of the retention rule.
List<Tag>	tags() Information about the tags assigned to the retention rule.
CreateRuleResponse.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.rbin.model.RbinResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

identifier

public final String identifier()

The unique ID of the retention rule.

Returns:

The unique ID of the retention rule.

retentionPeriod

public final RetentionPeriod retentionPeriod()

Returns the value of the RetentionPeriod property for this object.

Returns:

The value of the RetentionPeriod property for this object.

description

public final String description()

The retention rule description.

Returns:

The retention rule description.

hasTags

public final boolean hasTags()

For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

tags

public final List<Tag> tags()

Information about the tags assigned to the retention rule.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasTags() method.

Returns:

Information about the tags assigned to the retention rule.

resourceType

public final ResourceType resourceType()

The resource type retained by the retention rule.

If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

The resource type retained by the retention rule.

See Also:

ResourceType

resourceTypeAsString

public final String resourceTypeAsString()

The resource type retained by the retention rule.

If the service returns an enum value that is not available in the current SDK version, resourceType will return ResourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from resourceTypeAsString().

Returns:

The resource type retained by the retention rule.

See Also:

ResourceType

hasResourceTags

public final boolean hasResourceTags()

For responses, this returns true if the service returned a value for the ResourceTags property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

resourceTags

public final List<ResourceTag> resourceTags()

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

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasResourceTags() method.

Returns:

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

status

public final RuleStatus status()

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

If the service returns an enum value that is not available in the current SDK version, status will return RuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

RuleStatus

statusAsString

public final String statusAsString()

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

If the service returns an enum value that is not available in the current SDK version, status will return RuleStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

Returns:

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

See Also:

RuleStatus

lockConfiguration

public final LockConfiguration lockConfiguration()

Information about the retention rule lock configuration.

Returns:

Information about the retention rule lock configuration.

lockState

public final 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.

If the service returns an enum value that is not available in the current SDK version, lockState will return LockState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lockStateAsString().

Returns:

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.

See Also:

LockState

lockStateAsString

public final String lockStateAsString()

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.

If the service returns an enum value that is not available in the current SDK version, lockState will return LockState.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from lockStateAsString().

Returns:

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.

See Also:

LockState

toBuilder

public CreateRuleResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRuleResponse.Builder,CreateRuleResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static CreateRuleResponse.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRuleResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo