software.amazon.awssdk.services.redshift.model

Class ClusterParameterStatus

java.lang.Object

software.amazon.awssdk.services.redshift.model.ClusterParameterStatus

All Implemented Interfaces:

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

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

Describes the status of a parameter group.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ClusterParameterStatus.Builder

Method Summary

Modifier and Type	Method and Description
static ClusterParameterStatus.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	parameterApplyErrorDescription() The error that prevented the parameter from being applied to the database.
String	parameterApplyStatus() The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.
String	parameterName() The name of the parameter.
List<SdkField<?>>	sdkFields()
static Class<? extends ClusterParameterStatus.Builder>	serializableBuilderClass()
ClusterParameterStatus.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString() Returns a string representation of this object.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

parameterName

public final String parameterName()

The name of the parameter.

Returns:

The name of the parameter.

parameterApplyStatus

public final String parameterApplyStatus()

The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.

The following are possible statuses and descriptions.

• in-sync: The parameter value is in sync with the database.

• pending-reboot: The parameter value will be applied after the cluster reboots.

• applying: The parameter value is being applied to the database.

• invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.

• apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.

• apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.

• unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.

Returns:

The status of the parameter that indicates whether the parameter is in sync with the database, waiting for a cluster reboot, or encountered an error when being applied.

The following are possible statuses and descriptions.

• in-sync: The parameter value is in sync with the database.

• pending-reboot: The parameter value will be applied after the cluster reboots.

• applying: The parameter value is being applied to the database.

• invalid-parameter: Cannot apply the parameter value because it has an invalid value or syntax.

• apply-deferred: The parameter contains static property changes. The changes are deferred until the cluster reboots.

• apply-error: Cannot connect to the cluster. The parameter change will be applied after the cluster reboots.

• unknown-error: Cannot apply the parameter change right now. The change will be applied after the cluster reboots.

parameterApplyErrorDescription

public final String parameterApplyErrorDescription()

The error that prevented the parameter from being applied to the database.

Returns:

The error that prevented the parameter from being applied to the database.

toBuilder

public ClusterParameterStatus.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<ClusterParameterStatus.Builder,ClusterParameterStatus>

Returns:

a builder for type T

builder

public static ClusterParameterStatus.Builder builder()

serializableBuilderClass

public static Class<? extends ClusterParameterStatus.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)

Description copied from interface: SdkPojo

Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.