com.amazonaws.services.cloudformation.model.GetTemplateRequest Maven / Gradle / Ivy
/*
* Copyright 2017-2022 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 javax.annotation.Generated;
import com.amazonaws.AmazonWebServiceRequest;
/**
*
* The input for a GetTemplate action.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetTemplateRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name or the unique stack ID that's associated with the stack, which aren't 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 Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template.
* If you specify a name, you must also specify the StackName.
*
*/
private String changeSetName;
/**
*
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has processed
* all transforms, specify Processed.
*
*
* If the template doesn't include transforms, Original and Processed return the same
* template. By default, CloudFormation specifies Processed.
*
*/
private String templateStage;
/**
*
* The name or the unique stack ID that's associated with the stack, which aren't 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's associated with the stack, which aren't 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's associated with the stack, which aren't 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's associated with the stack, which aren't 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's associated with the stack, which aren't 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's associated with the stack, which aren't 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;
}
/**
*
* The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template.
* If you specify a name, you must also specify the StackName.
*
*
* @param changeSetName
* The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated
* template. If you specify a name, you must also specify the StackName.
*/
public void setChangeSetName(String changeSetName) {
this.changeSetName = changeSetName;
}
/**
*
* The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template.
* If you specify a name, you must also specify the StackName.
*
*
* @return The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated
* template. If you specify a name, you must also specify the StackName.
*/
public String getChangeSetName() {
return this.changeSetName;
}
/**
*
* The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated template.
* If you specify a name, you must also specify the StackName.
*
*
* @param changeSetName
* The name or Amazon Resource Name (ARN) of a change set for which CloudFormation returns the associated
* template. If you specify a name, you must also specify the StackName.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetTemplateRequest withChangeSetName(String changeSetName) {
setChangeSetName(changeSetName);
return this;
}
/**
*
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has processed
* all transforms, specify Processed.
*
*
* If the template doesn't include transforms, Original and Processed return the same
* template. By default, CloudFormation specifies Processed.
*
*
* @param templateStage
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has
* processed all transforms, specify Processed.
*
* If the template doesn't include transforms, Original and Processed return the
* same template. By default, CloudFormation specifies Processed.
* @see TemplateStage
*/
public void setTemplateStage(String templateStage) {
this.templateStage = templateStage;
}
/**
*
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has processed
* all transforms, specify Processed.
*
*
* If the template doesn't include transforms, Original and Processed return the same
* template. By default, CloudFormation specifies Processed.
*
*
* @return For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has
* processed all transforms, specify Processed.
*
* If the template doesn't include transforms, Original and Processed return the
* same template. By default, CloudFormation specifies Processed.
* @see TemplateStage
*/
public String getTemplateStage() {
return this.templateStage;
}
/**
*
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has processed
* all transforms, specify Processed.
*
*
* If the template doesn't include transforms, Original and Processed return the same
* template. By default, CloudFormation specifies Processed.
*
*
* @param templateStage
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has
* processed all transforms, specify Processed.
*
* If the template doesn't include transforms, Original and Processed return the
* same template. By default, CloudFormation specifies Processed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TemplateStage
*/
public GetTemplateRequest withTemplateStage(String templateStage) {
setTemplateStage(templateStage);
return this;
}
/**
*
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has processed
* all transforms, specify Processed.
*
*
* If the template doesn't include transforms, Original and Processed return the same
* template. By default, CloudFormation specifies Processed.
*
*
* @param templateStage
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has
* processed all transforms, specify Processed.
*
* If the template doesn't include transforms, Original and Processed return the
* same template. By default, CloudFormation specifies Processed.
* @see TemplateStage
*/
public void setTemplateStage(TemplateStage templateStage) {
withTemplateStage(templateStage);
}
/**
*
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has processed
* all transforms, specify Processed.
*
*
* If the template doesn't include transforms, Original and Processed return the same
* template. By default, CloudFormation specifies Processed.
*
*
* @param templateStage
* For templates that include transforms, the stage of the template that CloudFormation returns. To get the
* user-submitted template, specify Original. To get the template after CloudFormation has
* processed all transforms, specify Processed.
*
* If the template doesn't include transforms, Original and Processed return the
* same template. By default, CloudFormation specifies Processed.
* @return Returns a reference to this object so that method calls can be chained together.
* @see TemplateStage
*/
public GetTemplateRequest withTemplateStage(TemplateStage templateStage) {
this.templateStage = templateStage.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 (getStackName() != null)
sb.append("StackName: ").append(getStackName()).append(",");
if (getChangeSetName() != null)
sb.append("ChangeSetName: ").append(getChangeSetName()).append(",");
if (getTemplateStage() != null)
sb.append("TemplateStage: ").append(getTemplateStage());
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;
if (other.getChangeSetName() == null ^ this.getChangeSetName() == null)
return false;
if (other.getChangeSetName() != null && other.getChangeSetName().equals(this.getChangeSetName()) == false)
return false;
if (other.getTemplateStage() == null ^ this.getTemplateStage() == null)
return false;
if (other.getTemplateStage() != null && other.getTemplateStage().equals(this.getTemplateStage()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getStackName() == null) ? 0 : getStackName().hashCode());
hashCode = prime * hashCode + ((getChangeSetName() == null) ? 0 : getChangeSetName().hashCode());
hashCode = prime * hashCode + ((getTemplateStage() == null) ? 0 : getTemplateStage().hashCode());
return hashCode;
}
@Override
public GetTemplateRequest clone() {
return (GetTemplateRequest) super.clone();
}
}