com.amazonaws.services.cloudformation.model.GetGeneratedTemplateRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-cloudformation Show documentation
/*
* Copyright 2019-2024 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;
/**
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class GetGeneratedTemplateRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The language to use to retrieve for the generated template. Supported values are:
*
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
*
*/
private String format;
/**
*
* The name or Amazon Resource Name (ARN) of the generated template. The format is
* arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,
* arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
*
*/
private String generatedTemplateName;
/**
*
* The language to use to retrieve for the generated template. Supported values are:
*
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
*
*
* @param format
* The language to use to retrieve for the generated template. Supported values are:
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
* @see TemplateFormat
*/
public void setFormat(String format) {
this.format = format;
}
/**
*
* The language to use to retrieve for the generated template. Supported values are:
*
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
*
*
* @return The language to use to retrieve for the generated template. Supported values are:
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
* @see TemplateFormat
*/
public String getFormat() {
return this.format;
}
/**
*
* The language to use to retrieve for the generated template. Supported values are:
*
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
*
*
* @param format
* The language to use to retrieve for the generated template. Supported values are:
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TemplateFormat
*/
public GetGeneratedTemplateRequest withFormat(String format) {
setFormat(format);
return this;
}
/**
*
* The language to use to retrieve for the generated template. Supported values are:
*
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
*
*
* @param format
* The language to use to retrieve for the generated template. Supported values are:
*
* -
*
* JSON
*
*
* -
*
* YAML
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see TemplateFormat
*/
public GetGeneratedTemplateRequest withFormat(TemplateFormat format) {
this.format = format.toString();
return this;
}
/**
*
* The name or Amazon Resource Name (ARN) of the generated template. The format is
* arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,
* arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
*
*
* @param generatedTemplateName
* The name or Amazon Resource Name (ARN) of the generated template. The format is
* arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,
* arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
*/
public void setGeneratedTemplateName(String generatedTemplateName) {
this.generatedTemplateName = generatedTemplateName;
}
/**
*
* The name or Amazon Resource Name (ARN) of the generated template. The format is
* arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,
* arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
*
*
* @return The name or Amazon Resource Name (ARN) of the generated template. The format is
* arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,
* arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
*/
public String getGeneratedTemplateName() {
return this.generatedTemplateName;
}
/**
*
* The name or Amazon Resource Name (ARN) of the generated template. The format is
* arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,
* arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
*
*
* @param generatedTemplateName
* The name or Amazon Resource Name (ARN) of the generated template. The format is
* arn:${Partition}:cloudformation:${Region}:${Account}:generatedtemplate/${Id}. For example,
* arn:aws:cloudformation:us-east-1:123456789012:generatedtemplate/2e8465c1-9a80-43ea-a3a3-4f2d692fe6dc
* .
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetGeneratedTemplateRequest withGeneratedTemplateName(String generatedTemplateName) {
setGeneratedTemplateName(generatedTemplateName);
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 (getFormat() != null)
sb.append("Format: ").append(getFormat()).append(",");
if (getGeneratedTemplateName() != null)
sb.append("GeneratedTemplateName: ").append(getGeneratedTemplateName());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof GetGeneratedTemplateRequest == false)
return false;
GetGeneratedTemplateRequest other = (GetGeneratedTemplateRequest) obj;
if (other.getFormat() == null ^ this.getFormat() == null)
return false;
if (other.getFormat() != null && other.getFormat().equals(this.getFormat()) == false)
return false;
if (other.getGeneratedTemplateName() == null ^ this.getGeneratedTemplateName() == null)
return false;
if (other.getGeneratedTemplateName() != null && other.getGeneratedTemplateName().equals(this.getGeneratedTemplateName()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getFormat() == null) ? 0 : getFormat().hashCode());
hashCode = prime * hashCode + ((getGeneratedTemplateName() == null) ? 0 : getGeneratedTemplateName().hashCode());
return hashCode;
}
@Override
public GetGeneratedTemplateRequest clone() {
return (GetGeneratedTemplateRequest) super.clone();
}
}