software.amazon.awssdk.services.redshift.model.ClusterParameterStatus Maven / Gradle / Ivy
Show all versions of redshift Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.redshift.model;
import java.io.Serializable;
import java.util.Arrays;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* Describes the status of a parameter group.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class ClusterParameterStatus implements SdkPojo, Serializable,
ToCopyableBuilder {
private static final SdkField PARAMETER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ParameterName").getter(getter(ClusterParameterStatus::parameterName))
.setter(setter(Builder::parameterName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParameterName").build()).build();
private static final SdkField PARAMETER_APPLY_STATUS_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("ParameterApplyStatus").getter(getter(ClusterParameterStatus::parameterApplyStatus))
.setter(setter(Builder::parameterApplyStatus))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParameterApplyStatus").build())
.build();
private static final SdkField PARAMETER_APPLY_ERROR_DESCRIPTION_FIELD = SdkField
. builder(MarshallingType.STRING)
.memberName("ParameterApplyErrorDescription")
.getter(getter(ClusterParameterStatus::parameterApplyErrorDescription))
.setter(setter(Builder::parameterApplyErrorDescription))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("ParameterApplyErrorDescription")
.build()).build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(PARAMETER_NAME_FIELD,
PARAMETER_APPLY_STATUS_FIELD, PARAMETER_APPLY_ERROR_DESCRIPTION_FIELD));
private static final long serialVersionUID = 1L;
private final String parameterName;
private final String parameterApplyStatus;
private final String parameterApplyErrorDescription;
private ClusterParameterStatus(BuilderImpl builder) {
this.parameterName = builder.parameterName;
this.parameterApplyStatus = builder.parameterApplyStatus;
this.parameterApplyErrorDescription = builder.parameterApplyErrorDescription;
}
/**
*
* The name of the parameter.
*
*
* @return The name of the parameter.
*/
public final String parameterName() {
return parameterName;
}
/**
*
* 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.
*
*
*
*
* @return 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.
*
*
*/
public final String parameterApplyStatus() {
return parameterApplyStatus;
}
/**
*
* The error that prevented the parameter from being applied to the database.
*
*
* @return The error that prevented the parameter from being applied to the database.
*/
public final String parameterApplyErrorDescription() {
return parameterApplyErrorDescription;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class extends Builder> serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + Objects.hashCode(parameterName());
hashCode = 31 * hashCode + Objects.hashCode(parameterApplyStatus());
hashCode = 31 * hashCode + Objects.hashCode(parameterApplyErrorDescription());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof ClusterParameterStatus)) {
return false;
}
ClusterParameterStatus other = (ClusterParameterStatus) obj;
return Objects.equals(parameterName(), other.parameterName())
&& Objects.equals(parameterApplyStatus(), other.parameterApplyStatus())
&& Objects.equals(parameterApplyErrorDescription(), other.parameterApplyErrorDescription());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("ClusterParameterStatus").add("ParameterName", parameterName())
.add("ParameterApplyStatus", parameterApplyStatus())
.add("ParameterApplyErrorDescription", parameterApplyErrorDescription()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "ParameterName":
return Optional.ofNullable(clazz.cast(parameterName()));
case "ParameterApplyStatus":
return Optional.ofNullable(clazz.cast(parameterApplyStatus()));
case "ParameterApplyErrorDescription":
return Optional.ofNullable(clazz.cast(parameterApplyErrorDescription()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function