software.amazon.awssdk.services.cloudformation.model.GetTemplateSummaryRequest Maven / Gradle / Ivy
Show all versions of cloudformation Show documentation
/*
* Copyright 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 software.amazon.awssdk.services.cloudformation.model;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*
* The input for the GetTemplateSummary action.
*
*/
@Generated("software.amazon.awssdk:codegen")
public final class GetTemplateSummaryRequest extends CloudFormationRequest implements
ToCopyableBuilder {
private static final SdkField TEMPLATE_BODY_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateBody").getter(getter(GetTemplateSummaryRequest::templateBody))
.setter(setter(Builder::templateBody))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateBody").build()).build();
private static final SdkField TEMPLATE_URL_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("TemplateURL").getter(getter(GetTemplateSummaryRequest::templateURL))
.setter(setter(Builder::templateURL))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateURL").build()).build();
private static final SdkField STACK_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackName").getter(getter(GetTemplateSummaryRequest::stackName)).setter(setter(Builder::stackName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackName").build()).build();
private static final SdkField STACK_SET_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("StackSetName").getter(getter(GetTemplateSummaryRequest::stackSetName))
.setter(setter(Builder::stackSetName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("StackSetName").build()).build();
private static final SdkField CALL_AS_FIELD = SdkField. builder(MarshallingType.STRING).memberName("CallAs")
.getter(getter(GetTemplateSummaryRequest::callAsAsString)).setter(setter(Builder::callAs))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("CallAs").build()).build();
private static final SdkField TEMPLATE_SUMMARY_CONFIG_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("TemplateSummaryConfig")
.getter(getter(GetTemplateSummaryRequest::templateSummaryConfig)).setter(setter(Builder::templateSummaryConfig))
.constructor(TemplateSummaryConfig::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("TemplateSummaryConfig").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(TEMPLATE_BODY_FIELD,
TEMPLATE_URL_FIELD, STACK_NAME_FIELD, STACK_SET_NAME_FIELD, CALL_AS_FIELD, TEMPLATE_SUMMARY_CONFIG_FIELD));
private static final Map> SDK_NAME_TO_FIELD = Collections
.unmodifiableMap(new HashMap>() {
{
put("TemplateBody", TEMPLATE_BODY_FIELD);
put("TemplateURL", TEMPLATE_URL_FIELD);
put("StackName", STACK_NAME_FIELD);
put("StackSetName", STACK_SET_NAME_FIELD);
put("CallAs", CALL_AS_FIELD);
put("TemplateSummaryConfig", TEMPLATE_SUMMARY_CONFIG_FIELD);
}
});
private final String templateBody;
private final String templateURL;
private final String stackName;
private final String stackSetName;
private final String callAs;
private final TemplateSummaryConfig templateSummaryConfig;
private GetTemplateSummaryRequest(BuilderImpl builder) {
super(builder);
this.templateBody = builder.templateBody;
this.templateURL = builder.templateURL;
this.stackName = builder.stackName;
this.stackSetName = builder.stackSetName;
this.callAs = builder.callAs;
this.templateSummaryConfig = builder.templateSummaryConfig;
}
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @return Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200
* bytes.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public final String templateBody() {
return templateBody;
}
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's
* located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket must start
* with https://.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @return Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes)
* that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket
* must start with https://.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public final String templateURL() {
return templateURL;
}
/**
*
* The name or the stack ID that's associated with the stack, which aren't 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,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @return The name or the stack ID that's associated with the stack, which aren't 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,
* StackSetName, TemplateBody, or TemplateURL.
*/
public final String stackName() {
return stackName;
}
/**
*
* The name or unique ID of the stack set from which the stack was created.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @return The name or unique ID of the stack set from which the stack was created.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*/
public final String stackSetName() {
return stackSetName;
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #callAs} will
* return {@link CallAs#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #callAsAsString}.
*
*
* @return [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @see CallAs
*/
public final CallAs callAs() {
return CallAs.fromValue(callAs);
}
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's
* management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account. For
* more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* If the service returns an enum value that is not available in the current SDK version, {@link #callAs} will
* return {@link CallAs#UNKNOWN_TO_SDK_VERSION}. The raw value returned by the service is available from
* {@link #callAsAsString}.
*
*
* @return [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @see CallAs
*/
public final String callAsAsString() {
return callAs;
}
/**
*
* Specifies options for the GetTemplateSummary API action.
*
*
* @return Specifies options for the GetTemplateSummary API action.
*/
public final TemplateSummaryConfig templateSummaryConfig() {
return templateSummaryConfig;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(templateBody());
hashCode = 31 * hashCode + Objects.hashCode(templateURL());
hashCode = 31 * hashCode + Objects.hashCode(stackName());
hashCode = 31 * hashCode + Objects.hashCode(stackSetName());
hashCode = 31 * hashCode + Objects.hashCode(callAsAsString());
hashCode = 31 * hashCode + Objects.hashCode(templateSummaryConfig());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof GetTemplateSummaryRequest)) {
return false;
}
GetTemplateSummaryRequest other = (GetTemplateSummaryRequest) obj;
return Objects.equals(templateBody(), other.templateBody()) && Objects.equals(templateURL(), other.templateURL())
&& Objects.equals(stackName(), other.stackName()) && Objects.equals(stackSetName(), other.stackSetName())
&& Objects.equals(callAsAsString(), other.callAsAsString())
&& Objects.equals(templateSummaryConfig(), other.templateSummaryConfig());
}
/**
* 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.
*/
@Override
public final String toString() {
return ToString.builder("GetTemplateSummaryRequest").add("TemplateBody", templateBody())
.add("TemplateURL", templateURL()).add("StackName", stackName()).add("StackSetName", stackSetName())
.add("CallAs", callAsAsString()).add("TemplateSummaryConfig", templateSummaryConfig()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "TemplateBody":
return Optional.ofNullable(clazz.cast(templateBody()));
case "TemplateURL":
return Optional.ofNullable(clazz.cast(templateURL()));
case "StackName":
return Optional.ofNullable(clazz.cast(stackName()));
case "StackSetName":
return Optional.ofNullable(clazz.cast(stackSetName()));
case "CallAs":
return Optional.ofNullable(clazz.cast(callAsAsString()));
case "TemplateSummaryConfig":
return Optional.ofNullable(clazz.cast(templateSummaryConfig()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
@Override
public final Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
private static Function getter(Function g) {
return obj -> g.apply((GetTemplateSummaryRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends CloudFormationRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* Structure containing the template body with a minimum length of 1 byte and a maximum length of 51,200 bytes.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, 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.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateBody(String templateBody);
/**
*
* Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes)
* that's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon S3 bucket
* must start with https://.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, 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's located in an Amazon S3 bucket or a Systems Manager document. The location for an Amazon
* S3 bucket must start with https://.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateURL(String templateURL);
/**
*
* The name or the stack ID that's associated with the stack, which aren't 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,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param stackName
* The name or the stack ID that's associated with the stack, which aren't 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,
* StackSetName, TemplateBody, or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackName(String stackName);
/**
*
* The name or unique ID of the stack set from which the stack was created.
*
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
*
*
* @param stackSetName
* The name or unique ID of the stack set from which the stack was created.
*
* Conditional: You must specify only one of the following parameters: StackName,
* StackSetName, TemplateBody, or TemplateURL.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder stackSetName(String stackSetName);
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account.
* For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @param callAs
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @see CallAs
* @return Returns a reference to this object so that method calls can be chained together.
* @see CallAs
*/
Builder callAs(String callAs);
/**
*
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management account.
* For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
*
*
* @param callAs
* [Service-managed permissions] Specifies whether you are acting as an account administrator in the
* organization's management account or as a delegated administrator in a member account.
*
* By default, SELF is specified. Use SELF for stack sets with self-managed
* permissions.
*
*
* -
*
* If you are signed in to the management account, specify SELF.
*
*
* -
*
* If you are signed in to a delegated administrator account, specify DELEGATED_ADMIN.
*
*
* Your Amazon Web Services account must be registered as a delegated administrator in the management
* account. For more information, see Register a delegated administrator in the CloudFormation User Guide.
*
*
* @see CallAs
* @return Returns a reference to this object so that method calls can be chained together.
* @see CallAs
*/
Builder callAs(CallAs callAs);
/**
*
* Specifies options for the GetTemplateSummary API action.
*
*
* @param templateSummaryConfig
* Specifies options for the GetTemplateSummary API action.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder templateSummaryConfig(TemplateSummaryConfig templateSummaryConfig);
/**
*
* Specifies options for the GetTemplateSummary API action.
*
* This is a convenience method that creates an instance of the {@link TemplateSummaryConfig.Builder} avoiding
* the need to create one manually via {@link TemplateSummaryConfig#builder()}.
*
*
* When the {@link Consumer} completes, {@link TemplateSummaryConfig.Builder#build()} is called immediately and
* its result is passed to {@link #templateSummaryConfig(TemplateSummaryConfig)}.
*
* @param templateSummaryConfig
* a consumer that will call methods on {@link TemplateSummaryConfig.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #templateSummaryConfig(TemplateSummaryConfig)
*/
default Builder templateSummaryConfig(Consumer templateSummaryConfig) {
return templateSummaryConfig(TemplateSummaryConfig.builder().applyMutation(templateSummaryConfig).build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends CloudFormationRequest.BuilderImpl implements Builder {
private String templateBody;
private String templateURL;
private String stackName;
private String stackSetName;
private String callAs;
private TemplateSummaryConfig templateSummaryConfig;
private BuilderImpl() {
}
private BuilderImpl(GetTemplateSummaryRequest model) {
super(model);
templateBody(model.templateBody);
templateURL(model.templateURL);
stackName(model.stackName);
stackSetName(model.stackSetName);
callAs(model.callAs);
templateSummaryConfig(model.templateSummaryConfig);
}
public final String getTemplateBody() {
return templateBody;
}
public final void setTemplateBody(String templateBody) {
this.templateBody = templateBody;
}
@Override
public final Builder templateBody(String templateBody) {
this.templateBody = templateBody;
return this;
}
public final String getTemplateURL() {
return templateURL;
}
public final void setTemplateURL(String templateURL) {
this.templateURL = templateURL;
}
@Override
public final Builder templateURL(String templateURL) {
this.templateURL = templateURL;
return this;
}
public final String getStackName() {
return stackName;
}
public final void setStackName(String stackName) {
this.stackName = stackName;
}
@Override
public final Builder stackName(String stackName) {
this.stackName = stackName;
return this;
}
public final String getStackSetName() {
return stackSetName;
}
public final void setStackSetName(String stackSetName) {
this.stackSetName = stackSetName;
}
@Override
public final Builder stackSetName(String stackSetName) {
this.stackSetName = stackSetName;
return this;
}
public final String getCallAs() {
return callAs;
}
public final void setCallAs(String callAs) {
this.callAs = callAs;
}
@Override
public final Builder callAs(String callAs) {
this.callAs = callAs;
return this;
}
@Override
public final Builder callAs(CallAs callAs) {
this.callAs(callAs == null ? null : callAs.toString());
return this;
}
public final TemplateSummaryConfig.Builder getTemplateSummaryConfig() {
return templateSummaryConfig != null ? templateSummaryConfig.toBuilder() : null;
}
public final void setTemplateSummaryConfig(TemplateSummaryConfig.BuilderImpl templateSummaryConfig) {
this.templateSummaryConfig = templateSummaryConfig != null ? templateSummaryConfig.build() : null;
}
@Override
public final Builder templateSummaryConfig(TemplateSummaryConfig templateSummaryConfig) {
this.templateSummaryConfig = templateSummaryConfig;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public GetTemplateSummaryRequest build() {
return new GetTemplateSummaryRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
@Override
public Map> sdkFieldNameToField() {
return SDK_NAME_TO_FIELD;
}
}
}