com.amazonaws.services.cloudformation.model.GetTemplateRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws-java-sdk-cloudformation Show documentation
The AWS Java SDK for AWS CloudFormation module holds the client classes that are used for communicating with AWS CloudFormation Service
There is a newer version: 1.12.778
Show newest version
/*
 * Copyright 2010-2015 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.cloudformation.model;

import java.io.Serializable;
import com.amazonaws.AmazonWebServiceRequest;

/**
 * 
 * The input for a GetTemplate action.
 * 
 */
public class GetTemplateRequest extends AmazonWebServiceRequest implements
        Serializable, Cloneable {

    /**
     * 
     * The name or the unique stack ID that is associated with the stack, which
     * are not always interchangeable:
     * 
     * 
     * Running stacks: You can specify either the stack's name or its unique
     * stack ID.
     * Deleted stacks: You must specify the unique stack ID.
     * 
     * 
     * Default: There is no default value.
     * 
     */
    private String stackName;

    /**
     * 
     * The name or the unique stack ID that is associated with the stack, which
     * are not always interchangeable:
     * 
     * 
     * Running stacks: You can specify either the stack's name or its unique
     * stack ID.
     * Deleted stacks: You must specify the unique stack ID.
     * 
     * 
     * Default: There is no default value.
     * 
     * 
     * @param stackName
     *        The name or the unique stack ID that is associated with the stack,
     *        which are not always interchangeable:
     *        
     *        Running stacks: You can specify either the stack's name or its
     *        unique stack ID.
     *        Deleted stacks: You must specify the unique stack ID.
     *        
     *        
     *        Default: There is no default value.
     */
    public void setStackName(String stackName) {
        this.stackName = stackName;
    }

    /**
     * 

     * The name or the unique stack ID that is associated with the stack, which
     * are not always interchangeable:
     * 
     * 
     * Running stacks: You can specify either the stack's name or its unique
     * stack ID.
     * Deleted stacks: You must specify the unique stack ID.
     * 
     * 
     * Default: There is no default value.
     * 
     * 
     * @return The name or the unique stack ID that is associated with the
     *         stack, which are not always interchangeable:
     *         
     *         Running stacks: You can specify either the stack's name or
     *         its unique stack ID.
     *         Deleted stacks: You must specify the unique stack ID.
     *         
     *         
     *         Default: There is no default value.
     */
    public String getStackName() {
        return this.stackName;
    }

    /**
     * 

     * The name or the unique stack ID that is associated with the stack, which
     * are not always interchangeable:
     * 
     * 
     * Running stacks: You can specify either the stack's name or its unique
     * stack ID.
     * Deleted stacks: You must specify the unique stack ID.
     * 
     * 
     * Default: There is no default value.
     * 
     * 
     * @param stackName
     *        The name or the unique stack ID that is associated with the stack,
     *        which are not always interchangeable:
     *        
     *        Running stacks: You can specify either the stack's name or its
     *        unique stack ID.
     *        Deleted stacks: You must specify the unique stack ID.
     *        
     *        
     *        Default: There is no default value.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public GetTemplateRequest withStackName(String stackName) {
        setStackName(stackName);
        return this;
    }

    /**
     * Returns a string representation of this object; useful for testing and
     * debugging.
     *
     * @return A string representation of this object.
     *
     * @see java.lang.Object#toString()
     */
    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();
        sb.append("{");
        if (getStackName() != null)
            sb.append("StackName: " + getStackName());
        sb.append("}");
        return sb.toString();
    }

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

        if (obj instanceof GetTemplateRequest == false)
            return false;
        GetTemplateRequest other = (GetTemplateRequest) obj;
        if (other.getStackName() == null ^ this.getStackName() == null)
            return false;
        if (other.getStackName() != null
                && other.getStackName().equals(this.getStackName()) == false)
            return false;
        return true;
    }

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

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

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