Class ClusterParameterStatus
- java.lang.Object
-
- software.amazon.awssdk.services.redshift.model.ClusterParameterStatus
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<ClusterParameterStatus.Builder,ClusterParameterStatus>
@Generated("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 Description static interface
ClusterParameterStatus.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ClusterParameterStatus.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<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()
String
toString()
Returns a string representation of this object.-
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
-
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()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ClusterParameterStatus.Builder,ClusterParameterStatus>
-
builder
public static ClusterParameterStatus.Builder builder()
-
serializableBuilderClass
public static Class<? extends ClusterParameterStatus.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
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.
-
-