com.amazonaws.services.rds.model.ModifyDBParameterGroupRequest.java Source code

Java tutorial

Introduction

Here is the source code for com.amazonaws.services.rds.model.ModifyDBParameterGroupRequest.java

Source

/*
 * Copyright 2014-2019 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.rds.model;

import java.io.Serializable;
import javax.annotation.Generated;

import com.amazonaws.AmazonWebServiceRequest;

/**
 * <p/>
 * 
 * @see <a href="http://docs.aws.amazon.com/goto/WebAPI/rds-2014-10-31/ModifyDBParameterGroup" target="_top">AWS API
 *      Documentation</a>
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ModifyDBParameterGroupRequest extends com.amazonaws.AmazonWebServiceRequest
        implements Serializable, Cloneable {

    /**
     * <p>
     * The name of the DB parameter group.
     * </p>
     * <p>
     * Constraints:
     * </p>
     * <ul>
     * <li>
     * <p>
     * If supplied, must match the name of an existing <code>DBParameterGroup</code>.
     * </p>
     * </li>
     * </ul>
     */
    private String dBParameterGroupName;
    /**
     * <p>
     * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name,
     * value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be
     * modified in a single request.
     * </p>
     * <p>
     * Valid Values (for the application method): <code>immediate | pending-reboot</code>
     * </p>
     * <note>
     * <p>
     * You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both
     * dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
     * </p>
     * </note>
     */
    private com.amazonaws.internal.SdkInternalList<Parameter> parameters;

    /**
     * Default constructor for ModifyDBParameterGroupRequest object. Callers should use the setter or fluent setter
     * (with...) methods to initialize the object after creating it.
     */
    public ModifyDBParameterGroupRequest() {
    }

    /**
     * Constructs a new ModifyDBParameterGroupRequest object. Callers should use the setter or fluent setter (with...)
     * methods to initialize any additional object members.
     * 
     * @param dBParameterGroupName
     *        The name of the DB parameter group.</p>
     *        <p>
     *        Constraints:
     *        </p>
     *        <ul>
     *        <li>
     *        <p>
     *        If supplied, must match the name of an existing <code>DBParameterGroup</code>.
     *        </p>
     *        </li>
     * @param parameters
     *        An array of parameter names, values, and the apply method for the parameter update. At least one parameter
     *        name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20
     *        parameters can be modified in a single request.</p>
     *        <p>
     *        Valid Values (for the application method): <code>immediate | pending-reboot</code>
     *        </p>
     *        <note>
     *        <p>
     *        You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for
     *        both dynamic and static parameters, and changes are applied when you reboot the DB instance without
     *        failover.
     *        </p>
     */
    public ModifyDBParameterGroupRequest(String dBParameterGroupName, java.util.List<Parameter> parameters) {
        setDBParameterGroupName(dBParameterGroupName);
        setParameters(parameters);
    }

    /**
     * <p>
     * The name of the DB parameter group.
     * </p>
     * <p>
     * Constraints:
     * </p>
     * <ul>
     * <li>
     * <p>
     * If supplied, must match the name of an existing <code>DBParameterGroup</code>.
     * </p>
     * </li>
     * </ul>
     * 
     * @param dBParameterGroupName
     *        The name of the DB parameter group.</p>
     *        <p>
     *        Constraints:
     *        </p>
     *        <ul>
     *        <li>
     *        <p>
     *        If supplied, must match the name of an existing <code>DBParameterGroup</code>.
     *        </p>
     *        </li>
     */

    public void setDBParameterGroupName(String dBParameterGroupName) {
        this.dBParameterGroupName = dBParameterGroupName;
    }

    /**
     * <p>
     * The name of the DB parameter group.
     * </p>
     * <p>
     * Constraints:
     * </p>
     * <ul>
     * <li>
     * <p>
     * If supplied, must match the name of an existing <code>DBParameterGroup</code>.
     * </p>
     * </li>
     * </ul>
     * 
     * @return The name of the DB parameter group.</p>
     *         <p>
     *         Constraints:
     *         </p>
     *         <ul>
     *         <li>
     *         <p>
     *         If supplied, must match the name of an existing <code>DBParameterGroup</code>.
     *         </p>
     *         </li>
     */

    public String getDBParameterGroupName() {
        return this.dBParameterGroupName;
    }

    /**
     * <p>
     * The name of the DB parameter group.
     * </p>
     * <p>
     * Constraints:
     * </p>
     * <ul>
     * <li>
     * <p>
     * If supplied, must match the name of an existing <code>DBParameterGroup</code>.
     * </p>
     * </li>
     * </ul>
     * 
     * @param dBParameterGroupName
     *        The name of the DB parameter group.</p>
     *        <p>
     *        Constraints:
     *        </p>
     *        <ul>
     *        <li>
     *        <p>
     *        If supplied, must match the name of an existing <code>DBParameterGroup</code>.
     *        </p>
     *        </li>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ModifyDBParameterGroupRequest withDBParameterGroupName(String dBParameterGroupName) {
        setDBParameterGroupName(dBParameterGroupName);
        return this;
    }

    /**
     * <p>
     * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name,
     * value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be
     * modified in a single request.
     * </p>
     * <p>
     * Valid Values (for the application method): <code>immediate | pending-reboot</code>
     * </p>
     * <note>
     * <p>
     * You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both
     * dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
     * </p>
     * </note>
     * 
     * @return An array of parameter names, values, and the apply method for the parameter update. At least one
     *         parameter name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of
     *         20 parameters can be modified in a single request.</p>
     *         <p>
     *         Valid Values (for the application method): <code>immediate | pending-reboot</code>
     *         </p>
     *         <note>
     *         <p>
     *         You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for
     *         both dynamic and static parameters, and changes are applied when you reboot the DB instance without
     *         failover.
     *         </p>
     */

    public java.util.List<Parameter> getParameters() {
        if (parameters == null) {
            parameters = new com.amazonaws.internal.SdkInternalList<Parameter>();
        }
        return parameters;
    }

    /**
     * <p>
     * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name,
     * value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be
     * modified in a single request.
     * </p>
     * <p>
     * Valid Values (for the application method): <code>immediate | pending-reboot</code>
     * </p>
     * <note>
     * <p>
     * You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both
     * dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
     * </p>
     * </note>
     * 
     * @param parameters
     *        An array of parameter names, values, and the apply method for the parameter update. At least one parameter
     *        name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20
     *        parameters can be modified in a single request.</p>
     *        <p>
     *        Valid Values (for the application method): <code>immediate | pending-reboot</code>
     *        </p>
     *        <note>
     *        <p>
     *        You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for
     *        both dynamic and static parameters, and changes are applied when you reboot the DB instance without
     *        failover.
     *        </p>
     */

    public void setParameters(java.util.Collection<Parameter> parameters) {
        if (parameters == null) {
            this.parameters = null;
            return;
        }

        this.parameters = new com.amazonaws.internal.SdkInternalList<Parameter>(parameters);
    }

    /**
     * <p>
     * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name,
     * value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be
     * modified in a single request.
     * </p>
     * <p>
     * Valid Values (for the application method): <code>immediate | pending-reboot</code>
     * </p>
     * <note>
     * <p>
     * You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both
     * dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
     * </p>
     * </note>
     * <p>
     * <b>NOTE:</b> This method appends the values to the existing list (if any). Use
     * {@link #setParameters(java.util.Collection)} or {@link #withParameters(java.util.Collection)} if you want to
     * override the existing values.
     * </p>
     * 
     * @param parameters
     *        An array of parameter names, values, and the apply method for the parameter update. At least one parameter
     *        name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20
     *        parameters can be modified in a single request.</p>
     *        <p>
     *        Valid Values (for the application method): <code>immediate | pending-reboot</code>
     *        </p>
     *        <note>
     *        <p>
     *        You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for
     *        both dynamic and static parameters, and changes are applied when you reboot the DB instance without
     *        failover.
     *        </p>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ModifyDBParameterGroupRequest withParameters(Parameter... parameters) {
        if (this.parameters == null) {
            setParameters(new com.amazonaws.internal.SdkInternalList<Parameter>(parameters.length));
        }
        for (Parameter ele : parameters) {
            this.parameters.add(ele);
        }
        return this;
    }

    /**
     * <p>
     * An array of parameter names, values, and the apply method for the parameter update. At least one parameter name,
     * value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20 parameters can be
     * modified in a single request.
     * </p>
     * <p>
     * Valid Values (for the application method): <code>immediate | pending-reboot</code>
     * </p>
     * <note>
     * <p>
     * You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for both
     * dynamic and static parameters, and changes are applied when you reboot the DB instance without failover.
     * </p>
     * </note>
     * 
     * @param parameters
     *        An array of parameter names, values, and the apply method for the parameter update. At least one parameter
     *        name, value, and apply method must be supplied; subsequent arguments are optional. A maximum of 20
     *        parameters can be modified in a single request.</p>
     *        <p>
     *        Valid Values (for the application method): <code>immediate | pending-reboot</code>
     *        </p>
     *        <note>
     *        <p>
     *        You can use the immediate value with dynamic parameters only. You can use the pending-reboot value for
     *        both dynamic and static parameters, and changes are applied when you reboot the DB instance without
     *        failover.
     *        </p>
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ModifyDBParameterGroupRequest withParameters(java.util.Collection<Parameter> parameters) {
        setParameters(parameters);
        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 (getDBParameterGroupName() != null)
            sb.append("DBParameterGroupName: ").append(getDBParameterGroupName()).append(",");
        if (getParameters() != null)
            sb.append("Parameters: ").append(getParameters());
        sb.append("}");
        return sb.toString();
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj)
            return true;
        if (obj == null)
            return false;

        if (obj instanceof ModifyDBParameterGroupRequest == false)
            return false;
        ModifyDBParameterGroupRequest other = (ModifyDBParameterGroupRequest) obj;
        if (other.getDBParameterGroupName() == null ^ this.getDBParameterGroupName() == null)
            return false;
        if (other.getDBParameterGroupName() != null
                && other.getDBParameterGroupName().equals(this.getDBParameterGroupName()) == false)
            return false;
        if (other.getParameters() == null ^ this.getParameters() == null)
            return false;
        if (other.getParameters() != null && other.getParameters().equals(this.getParameters()) == false)
            return false;
        return true;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int hashCode = 1;

        hashCode = prime * hashCode
                + ((getDBParameterGroupName() == null) ? 0 : getDBParameterGroupName().hashCode());
        hashCode = prime * hashCode + ((getParameters() == null) ? 0 : getParameters().hashCode());
        return hashCode;
    }

    @Override
    public ModifyDBParameterGroupRequest clone() {
        return (ModifyDBParameterGroupRequest) super.clone();
    }

}