Package software.amazon.awssdk.services.opensearchserverless.model

Class EffectiveLifecyclePolicyDetail

java.lang.Object

software.amazon.awssdk.services.opensearchserverless.model.EffectiveLifecyclePolicyDetail

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<EffectiveLifecyclePolicyDetail.Builder,EffectiveLifecyclePolicyDetail>

@Generated("software.amazon.awssdk:codegen")
public final class EffectiveLifecyclePolicyDetail
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<EffectiveLifecyclePolicyDetail.Builder,EffectiveLifecyclePolicyDetail>

Error information for an OpenSearch Serverless request.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	EffectiveLifecyclePolicyDetail.Builder

Method Summary

Modifier and Type	Method	Description
static EffectiveLifecyclePolicyDetail.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Boolean	noMinRetentionPeriod()	The minimum number of index retention days set.
String	policyName()	The name of the lifecycle policy.
String	resource()	The name of the OpenSearch Serverless index resource.
ResourceType	resourceType()	The type of OpenSearch Serverless resource.
String	resourceTypeAsString()	The type of OpenSearch Serverless resource.
String	retentionPeriod()	The minimum number of index retention in days or hours.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends EffectiveLifecyclePolicyDetail.Builder>	serializableBuilderClass()
EffectiveLifecyclePolicyDetail.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
LifecyclePolicyType	type()	The type of lifecycle policy.
String	typeAsString()	The type of lifecycle policy.

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

noMinRetentionPeriod

public final Boolean noMinRetentionPeriod()

The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.

Returns:

The minimum number of index retention days set. That is an optional param that will return as true if the minimum number of days or hours is not set to a index resource.

policyName

public final String policyName()

The name of the lifecycle policy.

Returns:

The name of the lifecycle policy.

resource

public final String resource()

The name of the OpenSearch Serverless index resource.

Returns:

The name of the OpenSearch Serverless index resource.

resourceType

public final ResourceType resourceType()

The type of OpenSearch Serverless resource. Currently, the only supported resource is index.

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 type of OpenSearch Serverless resource. Currently, the only supported resource is index.

See Also:

ResourceType

resourceTypeAsString

public final String resourceTypeAsString()

The type of OpenSearch Serverless resource. Currently, the only supported resource is index.

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 type of OpenSearch Serverless resource. Currently, the only supported resource is index.

See Also:

ResourceType

retentionPeriod

public final String retentionPeriod()

The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

Returns:

The minimum number of index retention in days or hours. This is an optional parameter that will return only if it’s set.

type

public final LifecyclePolicyType type()

The type of lifecycle policy.

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

Returns:

The type of lifecycle policy.

See Also:

LifecyclePolicyType

typeAsString

public final String typeAsString()

The type of lifecycle policy.

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

Returns:

The type of lifecycle policy.

See Also:

LifecyclePolicyType

toBuilder

public EffectiveLifecyclePolicyDetail.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<EffectiveLifecyclePolicyDetail.Builder,EffectiveLifecyclePolicyDetail>

builder

public static EffectiveLifecyclePolicyDetail.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo