com.amazonaws.services.cloudformation.model.GetTemplateSummaryRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
 * Copyright 2010-2016 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 the GetTemplateSummary action.
 * 
 */
public class GetTemplateSummaryRequest extends AmazonWebServiceRequest
        implements Serializable, Cloneable {
    /**
     * 
     * Structure containing the template body with a minimum length of 1 byte
     * and a maximum length of 51,200 bytes. For more information about
     * templates, see Template Anatomy in the AWS CloudFormation User Guide.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     */
    private String templateBody;
    /**
     * 
     * Location of file containing the template body. The URL must point to a
     * template (max size: 460,800 bytes) that is located in an Amazon S3
     * bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     */
    private String templateURL;
    /**
     * 
     * The name or the stack ID that is associated with the stack, which are not
     * always interchangeable. For running stacks, you can specify either the
     * stack's name or its unique stack ID. For deleted stack, you must specify
     * the unique stack ID.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     */
    private String stackName;
    /**
     * 
     * Structure containing the template body with a minimum length of 1 byte
     * and a maximum length of 51,200 bytes. For more information about
     * templates, see Template Anatomy in the AWS CloudFormation User Guide.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @param templateBody
     *        Structure containing the template body with a minimum length of 1
     *        byte and a maximum length of 51,200 bytes. For more information
     *        about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     *        
     *        Conditional: You must specify only one of the following
     *        parameters: StackName, TemplateBody, or
     *        TemplateURL.
     */
    public void setTemplateBody(String templateBody) {
        this.templateBody = templateBody;
    }
    /**
     * 
     * Structure containing the template body with a minimum length of 1 byte
     * and a maximum length of 51,200 bytes. For more information about
     * templates, see Template Anatomy in the AWS CloudFormation User Guide.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @return Structure containing the template body with a minimum length of 1
     *         byte and a maximum length of 51,200 bytes. For more information
     *         about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     *         
     *         Conditional: You must specify only one of the following
     *         parameters: StackName, TemplateBody, or
     *         TemplateURL.
     */
    public String getTemplateBody() {
        return this.templateBody;
    }
    /**
     * 
     * Structure containing the template body with a minimum length of 1 byte
     * and a maximum length of 51,200 bytes. For more information about
     * templates, see Template Anatomy in the AWS CloudFormation User Guide.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @param templateBody
     *        Structure containing the template body with a minimum length of 1
     *        byte and a maximum length of 51,200 bytes. For more information
     *        about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     *        
     *        Conditional: You must specify only one of the following
     *        parameters: StackName, TemplateBody, or
     *        TemplateURL.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public GetTemplateSummaryRequest withTemplateBody(String templateBody) {
        setTemplateBody(templateBody);
        return this;
    }
    /**
     * 
     * Location of file containing the template body. The URL must point to a
     * template (max size: 460,800 bytes) that is located in an Amazon S3
     * bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @param templateURL
     *        Location of file containing the template body. The URL must point
     *        to a template (max size: 460,800 bytes) that is located in an
     *        Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     *        
     *        Conditional: You must specify only one of the following
     *        parameters: StackName, TemplateBody, or
     *        TemplateURL.
     */
    public void setTemplateURL(String templateURL) {
        this.templateURL = templateURL;
    }
    /**
     * 
     * Location of file containing the template body. The URL must point to a
     * template (max size: 460,800 bytes) that is located in an Amazon S3
     * bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @return Location of file containing the template body. The URL must point
     *         to a template (max size: 460,800 bytes) that is located in an
     *         Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     *         
     *         Conditional: You must specify only one of the following
     *         parameters: StackName, TemplateBody, or
     *         TemplateURL.
     */
    public String getTemplateURL() {
        return this.templateURL;
    }
    /**
     * 
     * Location of file containing the template body. The URL must point to a
     * template (max size: 460,800 bytes) that is located in an Amazon S3
     * bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @param templateURL
     *        Location of file containing the template body. The URL must point
     *        to a template (max size: 460,800 bytes) that is located in an
     *        Amazon S3 bucket. For more information about templates, see Template Anatomy in the AWS CloudFormation User Guide.
     *        
     *        Conditional: You must specify only one of the following
     *        parameters: StackName, TemplateBody, or
     *        TemplateURL.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public GetTemplateSummaryRequest withTemplateURL(String templateURL) {
        setTemplateURL(templateURL);
        return this;
    }
    /**
     * 
     * The name or the stack ID that is associated with the stack, which are not
     * always interchangeable. For running stacks, you can specify either the
     * stack's name or its unique stack ID. For deleted stack, you must specify
     * the unique stack ID.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @param stackName
     *        The name or the stack ID that is associated with the stack, which
     *        are not always interchangeable. For running stacks, you can
     *        specify either the stack's name or its unique stack ID. For
     *        deleted stack, you must specify the unique stack ID.
     *        
     *        Conditional: You must specify only one of the following
     *        parameters: StackName, TemplateBody, or
     *        TemplateURL.
     */
    public void setStackName(String stackName) {
        this.stackName = stackName;
    }
    /**
     * 
     * The name or the stack ID that is associated with the stack, which are not
     * always interchangeable. For running stacks, you can specify either the
     * stack's name or its unique stack ID. For deleted stack, you must specify
     * the unique stack ID.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @return The name or the stack ID that is associated with the stack, which
     *         are not always interchangeable. For running stacks, you can
     *         specify either the stack's name or its unique stack ID. For
     *         deleted stack, you must specify the unique stack ID.
     *         
     *         Conditional: You must specify only one of the following
     *         parameters: StackName, TemplateBody, or
     *         TemplateURL.
     */
    public String getStackName() {
        return this.stackName;
    }
    /**
     * 
     * The name or the stack ID that is associated with the stack, which are not
     * always interchangeable. For running stacks, you can specify either the
     * stack's name or its unique stack ID. For deleted stack, you must specify
     * the unique stack ID.
     * 
     * 
     * Conditional: You must specify only one of the following parameters:
     * StackName, TemplateBody, or
     * TemplateURL.
     * 
     * 
     * @param stackName
     *        The name or the stack ID that is associated with the stack, which
     *        are not always interchangeable. For running stacks, you can
     *        specify either the stack's name or its unique stack ID. For
     *        deleted stack, you must specify the unique stack ID.
     *        
     *        Conditional: You must specify only one of the following
     *        parameters: StackName, TemplateBody, or
     *        TemplateURL.
     * @return Returns a reference to this object so that method calls can be
     *         chained together.
     */
    public GetTemplateSummaryRequest 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 (getTemplateBody() != null)
            sb.append("TemplateBody: " + getTemplateBody() + ",");
        if (getTemplateURL() != null)
            sb.append("TemplateURL: " + getTemplateURL() + ",");
        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 GetTemplateSummaryRequest == false)
            return false;
        GetTemplateSummaryRequest other = (GetTemplateSummaryRequest) obj;
        if (other.getTemplateBody() == null ^ this.getTemplateBody() == null)
            return false;
        if (other.getTemplateBody() != null
                && other.getTemplateBody().equals(this.getTemplateBody()) == false)
            return false;
        if (other.getTemplateURL() == null ^ this.getTemplateURL() == null)
            return false;
        if (other.getTemplateURL() != null
                && other.getTemplateURL().equals(this.getTemplateURL()) == false)
            return false;
        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
                + ((getTemplateBody() == null) ? 0 : getTemplateBody()
                        .hashCode());
        hashCode = prime
                * hashCode
                + ((getTemplateURL() == null) ? 0 : getTemplateURL().hashCode());
        hashCode = prime * hashCode
                + ((getStackName() == null) ? 0 : getStackName().hashCode());
        return hashCode;
    }
    @Override
    public GetTemplateSummaryRequest clone() {
        return (GetTemplateSummaryRequest) super.clone();
    }
}