software.amazon.awssdk.services.dlm.model

Class CreateLifecyclePolicyRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.dlm.model.DlmRequest

software.amazon.awssdk.services.dlm.model.CreateLifecyclePolicyRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<CreateLifecyclePolicyRequest.Builder,CreateLifecyclePolicyRequest>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CreateLifecyclePolicyRequest.Builder

Method Summary

Modifier and Type	Method and Description
static CreateLifecyclePolicyRequest.Builder	builder()
String	description() A description of the lifecycle policy.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	executionRoleArn() The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasTags() For responses, this returns true if the service returned a value for the Tags property.
PolicyDetails	policyDetails() The configuration details of the lifecycle policy.
List<SdkField<?>>	sdkFields()
static Class<? extends CreateLifecyclePolicyRequest.Builder>	serializableBuilderClass()
SettablePolicyStateValues	state() The desired activation state of the lifecycle policy after creation.
String	stateAsString() The desired activation state of the lifecycle policy after creation.
Map<String,String>	tags() The tags to apply to the lifecycle policy during creation.
CreateLifecyclePolicyRequest.Builder	toBuilder()
String	toString() Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

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

executionRoleArn

public final String executionRoleArn()

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

Returns:

The Amazon Resource Name (ARN) of the IAM role used to run the operations specified by the lifecycle policy.

description

public final String description()

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

Returns:

A description of the lifecycle policy. The characters ^[0-9A-Za-z _-]+$ are supported.

state

public final SettablePolicyStateValues state()

The desired activation state of the lifecycle policy after creation.

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

Returns:

The desired activation state of the lifecycle policy after creation.

See Also:

SettablePolicyStateValues

stateAsString

public final String stateAsString()

The desired activation state of the lifecycle policy after creation.

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

Returns:

The desired activation state of the lifecycle policy after creation.

See Also:

SettablePolicyStateValues

policyDetails

public final PolicyDetails policyDetails()

The configuration details of the lifecycle policy.

Returns:

The configuration details of the lifecycle policy.

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 Map<String,String> tags()

The tags to apply to the lifecycle policy during creation.

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:

The tags to apply to the lifecycle policy during creation.

toBuilder

public CreateLifecyclePolicyRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateLifecyclePolicyRequest.Builder,CreateLifecyclePolicyRequest>

Specified by:

toBuilder in class DlmRequest

builder

public static CreateLifecyclePolicyRequest.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

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 SdkRequest

sdkFields

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

Specified by:

sdkFields in interface SdkPojo