com.amazonaws.services.fis.model.ActionParameter Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-fis Show documentation
The AWS Java SDK for AWS Fault Injection Simulator module holds the client classes that are used for communicating with AWS Fault Injection Simulator Service
There is a newer version: 1.12.772
Show newest version
/*
 * Copyright 2016-2021 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.fis.model;

import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;

/**
 * 
 * Describes a parameter for an action.
 * 
 * 
 * @see AWS API
 *      Documentation
 */
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class ActionParameter implements Serializable, Cloneable, StructuredPojo {

    /**
     * 
     * The parameter description.
     * 
     */
    private String description;
    /**
     * 
     * Indicates whether the parameter is required.
     * 
     */
    private Boolean required;

    /**
     * 
     * The parameter description.
     * 
     * 
     * @param description
     *        The parameter description.
     */

    public void setDescription(String description) {
        this.description = description;
    }

    /**
     * 
     * The parameter description.
     * 
     * 
     * @return The parameter description.
     */

    public String getDescription() {
        return this.description;
    }

    /**
     * 
     * The parameter description.
     * 
     * 
     * @param description
     *        The parameter description.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ActionParameter withDescription(String description) {
        setDescription(description);
        return this;
    }

    /**
     * 
     * Indicates whether the parameter is required.
     * 
     * 
     * @param required
     *        Indicates whether the parameter is required.
     */

    public void setRequired(Boolean required) {
        this.required = required;
    }

    /**
     * 
     * Indicates whether the parameter is required.
     * 
     * 
     * @return Indicates whether the parameter is required.
     */

    public Boolean getRequired() {
        return this.required;
    }

    /**
     * 
     * Indicates whether the parameter is required.
     * 
     * 
     * @param required
     *        Indicates whether the parameter is required.
     * @return Returns a reference to this object so that method calls can be chained together.
     */

    public ActionParameter withRequired(Boolean required) {
        setRequired(required);
        return this;
    }

    /**
     * 
     * Indicates whether the parameter is required.
     * 
     * 
     * @return Indicates whether the parameter is required.
     */

    public Boolean isRequired() {
        return this.required;
    }

    /**
     * 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 (getDescription() != null)
            sb.append("Description: ").append(getDescription()).append(",");
        if (getRequired() != null)
            sb.append("Required: ").append(getRequired());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof ActionParameter == false)
            return false;
        ActionParameter other = (ActionParameter) obj;
        if (other.getDescription() == null ^ this.getDescription() == null)
            return false;
        if (other.getDescription() != null && other.getDescription().equals(this.getDescription()) == false)
            return false;
        if (other.getRequired() == null ^ this.getRequired() == null)
            return false;
        if (other.getRequired() != null && other.getRequired().equals(this.getRequired()) == false)
            return false;
        return true;
    }

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

        hashCode = prime * hashCode + ((getDescription() == null) ? 0 : getDescription().hashCode());
        hashCode = prime * hashCode + ((getRequired() == null) ? 0 : getRequired().hashCode());
        return hashCode;
    }

    @Override
    public ActionParameter clone() {
        try {
            return (ActionParameter) super.clone();
        } catch (CloneNotSupportedException e) {
            throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
        }
    }

    @com.amazonaws.annotation.SdkInternalApi
    @Override
    public void marshall(ProtocolMarshaller protocolMarshaller) {
        com.amazonaws.services.fis.model.transform.ActionParameterMarshaller.getInstance().marshall(this, protocolMarshaller);
    }
}