com.amazonaws.services.docdb.model.Parameter Maven / Gradle / Ivy
Show all versions of aws-java-sdk-docdb Show documentation
/*
* Copyright 2019-2024 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 com.amazonaws.services.docdb.model;
import java.io.Serializable;
import javax.annotation.Generated;
/**
*
* Detailed information about an individual parameter.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class Parameter implements Serializable, Cloneable {
/**
*
* Specifies the name of the parameter.
*
*/
private String parameterName;
/**
*
* Specifies the value of the parameter.
*
*/
private String parameterValue;
/**
*
* Provides a description of the parameter.
*
*/
private String description;
/**
*
* Indicates the source of the parameter value.
*
*/
private String source;
/**
*
* Specifies the engine-specific parameters type.
*
*/
private String applyType;
/**
*
* Specifies the valid data type for the parameter.
*
*/
private String dataType;
/**
*
* Specifies the valid range of values for the parameter.
*
*/
private String allowedValues;
/**
*
* Indicates whether (true) or not (false) the parameter can be modified. Some parameters
* have security or operational implications that prevent them from being changed.
*
*/
private Boolean isModifiable;
/**
*
* The earliest engine version to which the parameter can apply.
*
*/
private String minimumEngineVersion;
/**
*
* Indicates when to apply parameter updates.
*
*/
private String applyMethod;
/**
*
* Specifies the name of the parameter.
*
*
* @param parameterName
* Specifies the name of the parameter.
*/
public void setParameterName(String parameterName) {
this.parameterName = parameterName;
}
/**
*
* Specifies the name of the parameter.
*
*
* @return Specifies the name of the parameter.
*/
public String getParameterName() {
return this.parameterName;
}
/**
*
* Specifies the name of the parameter.
*
*
* @param parameterName
* Specifies the name of the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withParameterName(String parameterName) {
setParameterName(parameterName);
return this;
}
/**
*
* Specifies the value of the parameter.
*
*
* @param parameterValue
* Specifies the value of the parameter.
*/
public void setParameterValue(String parameterValue) {
this.parameterValue = parameterValue;
}
/**
*
* Specifies the value of the parameter.
*
*
* @return Specifies the value of the parameter.
*/
public String getParameterValue() {
return this.parameterValue;
}
/**
*
* Specifies the value of the parameter.
*
*
* @param parameterValue
* Specifies the value of the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withParameterValue(String parameterValue) {
setParameterValue(parameterValue);
return this;
}
/**
*
* Provides a description of the parameter.
*
*
* @param description
* Provides a description of the parameter.
*/
public void setDescription(String description) {
this.description = description;
}
/**
*
* Provides a description of the parameter.
*
*
* @return Provides a description of the parameter.
*/
public String getDescription() {
return this.description;
}
/**
*
* Provides a description of the parameter.
*
*
* @param description
* Provides a description of the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withDescription(String description) {
setDescription(description);
return this;
}
/**
*
* Indicates the source of the parameter value.
*
*
* @param source
* Indicates the source of the parameter value.
*/
public void setSource(String source) {
this.source = source;
}
/**
*
* Indicates the source of the parameter value.
*
*
* @return Indicates the source of the parameter value.
*/
public String getSource() {
return this.source;
}
/**
*
* Indicates the source of the parameter value.
*
*
* @param source
* Indicates the source of the parameter value.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withSource(String source) {
setSource(source);
return this;
}
/**
*
* Specifies the engine-specific parameters type.
*
*
* @param applyType
* Specifies the engine-specific parameters type.
*/
public void setApplyType(String applyType) {
this.applyType = applyType;
}
/**
*
* Specifies the engine-specific parameters type.
*
*
* @return Specifies the engine-specific parameters type.
*/
public String getApplyType() {
return this.applyType;
}
/**
*
* Specifies the engine-specific parameters type.
*
*
* @param applyType
* Specifies the engine-specific parameters type.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withApplyType(String applyType) {
setApplyType(applyType);
return this;
}
/**
*
* Specifies the valid data type for the parameter.
*
*
* @param dataType
* Specifies the valid data type for the parameter.
*/
public void setDataType(String dataType) {
this.dataType = dataType;
}
/**
*
* Specifies the valid data type for the parameter.
*
*
* @return Specifies the valid data type for the parameter.
*/
public String getDataType() {
return this.dataType;
}
/**
*
* Specifies the valid data type for the parameter.
*
*
* @param dataType
* Specifies the valid data type for the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withDataType(String dataType) {
setDataType(dataType);
return this;
}
/**
*
* Specifies the valid range of values for the parameter.
*
*
* @param allowedValues
* Specifies the valid range of values for the parameter.
*/
public void setAllowedValues(String allowedValues) {
this.allowedValues = allowedValues;
}
/**
*
* Specifies the valid range of values for the parameter.
*
*
* @return Specifies the valid range of values for the parameter.
*/
public String getAllowedValues() {
return this.allowedValues;
}
/**
*
* Specifies the valid range of values for the parameter.
*
*
* @param allowedValues
* Specifies the valid range of values for the parameter.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withAllowedValues(String allowedValues) {
setAllowedValues(allowedValues);
return this;
}
/**
*
* Indicates whether (true) or not (false) the parameter can be modified. Some parameters
* have security or operational implications that prevent them from being changed.
*
*
* @param isModifiable
* Indicates whether (true) or not (false) the parameter can be modified. Some
* parameters have security or operational implications that prevent them from being changed.
*/
public void setIsModifiable(Boolean isModifiable) {
this.isModifiable = isModifiable;
}
/**
*
* Indicates whether (true) or not (false) the parameter can be modified. Some parameters
* have security or operational implications that prevent them from being changed.
*
*
* @return Indicates whether (true) or not (false) the parameter can be modified. Some
* parameters have security or operational implications that prevent them from being changed.
*/
public Boolean getIsModifiable() {
return this.isModifiable;
}
/**
*
* Indicates whether (true) or not (false) the parameter can be modified. Some parameters
* have security or operational implications that prevent them from being changed.
*
*
* @param isModifiable
* Indicates whether (true) or not (false) the parameter can be modified. Some
* parameters have security or operational implications that prevent them from being changed.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withIsModifiable(Boolean isModifiable) {
setIsModifiable(isModifiable);
return this;
}
/**
*
* Indicates whether (true) or not (false) the parameter can be modified. Some parameters
* have security or operational implications that prevent them from being changed.
*
*
* @return Indicates whether (true) or not (false) the parameter can be modified. Some
* parameters have security or operational implications that prevent them from being changed.
*/
public Boolean isModifiable() {
return this.isModifiable;
}
/**
*
* The earliest engine version to which the parameter can apply.
*
*
* @param minimumEngineVersion
* The earliest engine version to which the parameter can apply.
*/
public void setMinimumEngineVersion(String minimumEngineVersion) {
this.minimumEngineVersion = minimumEngineVersion;
}
/**
*
* The earliest engine version to which the parameter can apply.
*
*
* @return The earliest engine version to which the parameter can apply.
*/
public String getMinimumEngineVersion() {
return this.minimumEngineVersion;
}
/**
*
* The earliest engine version to which the parameter can apply.
*
*
* @param minimumEngineVersion
* The earliest engine version to which the parameter can apply.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public Parameter withMinimumEngineVersion(String minimumEngineVersion) {
setMinimumEngineVersion(minimumEngineVersion);
return this;
}
/**
*
* Indicates when to apply parameter updates.
*
*
* @param applyMethod
* Indicates when to apply parameter updates.
* @see ApplyMethod
*/
public void setApplyMethod(String applyMethod) {
this.applyMethod = applyMethod;
}
/**
*
* Indicates when to apply parameter updates.
*
*
* @return Indicates when to apply parameter updates.
* @see ApplyMethod
*/
public String getApplyMethod() {
return this.applyMethod;
}
/**
*
* Indicates when to apply parameter updates.
*
*
* @param applyMethod
* Indicates when to apply parameter updates.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApplyMethod
*/
public Parameter withApplyMethod(String applyMethod) {
setApplyMethod(applyMethod);
return this;
}
/**
*
* Indicates when to apply parameter updates.
*
*
* @param applyMethod
* Indicates when to apply parameter updates.
* @return Returns a reference to this object so that method calls can be chained together.
* @see ApplyMethod
*/
public Parameter withApplyMethod(ApplyMethod applyMethod) {
this.applyMethod = applyMethod.toString();
return this;
}
/**
* 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.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getParameterName() != null)
sb.append("ParameterName: ").append(getParameterName()).append(",");
if (getParameterValue() != null)
sb.append("ParameterValue: ").append(getParameterValue()).append(",");
if (getDescription() != null)
sb.append("Description: ").append(getDescription()).append(",");
if (getSource() != null)
sb.append("Source: ").append(getSource()).append(",");
if (getApplyType() != null)
sb.append("ApplyType: ").append(getApplyType()).append(",");
if (getDataType() != null)
sb.append("DataType: ").append(getDataType()).append(",");
if (getAllowedValues() != null)
sb.append("AllowedValues: ").append(getAllowedValues()).append(",");
if (getIsModifiable() != null)
sb.append("IsModifiable: ").append(getIsModifiable()).append(",");
if (getMinimumEngineVersion() != null)
sb.append("MinimumEngineVersion: ").append(getMinimumEngineVersion()).append(",");
if (getApplyMethod() != null)
sb.append("ApplyMethod: ").append(getApplyMethod());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof Parameter == false)
return false;
Parameter other = (Parameter) obj;
if (other.getParameterName() == null ^ this.getParameterName() == null)
return false;
if (other.getParameterName() != null && other.getParameterName().equals(this.getParameterName()) == false)
return false;
if (other.getParameterValue() == null ^ this.getParameterValue() == null)
return false;
if (other.getParameterValue() != null && other.getParameterValue().equals(this.getParameterValue()) == false)
return false;
if (other.getDescription() == null ^ this.getDescription() == null)
return false;
if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
return false;
if (other.getSource() == null ^ this.getSource() == null)
return false;
if (other.getSource() != null && other.getSource().equals(this.getSource()) == false)
return false;
if (other.getApplyType() == null ^ this.getApplyType() == null)
return false;
if (other.getApplyType() != null && other.getApplyType().equals(this.getApplyType()) == false)
return false;
if (other.getDataType() == null ^ this.getDataType() == null)
return false;
if (other.getDataType() != null && other.getDataType().equals(this.getDataType()) == false)
return false;
if (other.getAllowedValues() == null ^ this.getAllowedValues() == null)
return false;
if (other.getAllowedValues() != null && other.getAllowedValues().equals(this.getAllowedValues()) == false)
return false;
if (other.getIsModifiable() == null ^ this.getIsModifiable() == null)
return false;
if (other.getIsModifiable() != null && other.getIsModifiable().equals(this.getIsModifiable()) == false)
return false;
if (other.getMinimumEngineVersion() == null ^ this.getMinimumEngineVersion() == null)
return false;
if (other.getMinimumEngineVersion() != null && other.getMinimumEngineVersion().equals(this.getMinimumEngineVersion()) == false)
return false;
if (other.getApplyMethod() == null ^ this.getApplyMethod() == null)
return false;
if (other.getApplyMethod() != null && other.getApplyMethod().equals(this.getApplyMethod()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getParameterName() == null) ? 0 : getParameterName().hashCode());
hashCode = prime * hashCode + ((getParameterValue() == null) ? 0 : getParameterValue().hashCode());
hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
hashCode = prime * hashCode + ((getSource() == null) ? 0 : getSource().hashCode());
hashCode = prime * hashCode + ((getApplyType() == null) ? 0 : getApplyType().hashCode());
hashCode = prime * hashCode + ((getDataType() == null) ? 0 : getDataType().hashCode());
hashCode = prime * hashCode + ((getAllowedValues() == null) ? 0 : getAllowedValues().hashCode());
hashCode = prime * hashCode + ((getIsModifiable() == null) ? 0 : getIsModifiable().hashCode());
hashCode = prime * hashCode + ((getMinimumEngineVersion() == null) ? 0 : getMinimumEngineVersion().hashCode());
hashCode = prime * hashCode + ((getApplyMethod() == null) ? 0 : getApplyMethod().hashCode());
return hashCode;
}
@Override
public Parameter clone() {
try {
return (Parameter) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
}