Package software.amazon.awssdk.services.cloudformation.model

Class GetTemplateResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse

software.amazon.awssdk.services.cloudformation.model.GetTemplateResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetTemplateResponse.Builder,GetTemplateResponse>

@Generated("software.amazon.awssdk:codegen")
public final class GetTemplateResponse
extends CloudFormationResponse
implements ToCopyableBuilder<GetTemplateResponse.Builder,GetTemplateResponse>

The output for GetTemplate action.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetTemplateResponse.Builder

Method Summary

Modifier and Type	Method	Description
static GetTemplateResponse.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasStagesAvailable()	For responses, this returns true if the service returned a value for the StagesAvailable property.
List<SdkField<?>>	sdkFields()
static Class<? extends GetTemplateResponse.Builder>	serializableBuilderClass()
List<TemplateStage>	stagesAvailable()	The stage of the template that you can retrieve.
List<String>	stagesAvailableAsStrings()	The stage of the template that you can retrieve.
String	templateBody()	Structure containing the template body.
GetTemplateResponse.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.services.cloudformation.model.CloudFormationResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

templateBody

public final String templateBody()

Structure containing the template body.

CloudFormation returns the same template that was used when the stack was created.

Returns:

Structure containing the template body.

CloudFormation returns the same template that was used when the stack was created.

stagesAvailable

public final List<TemplateStage> stagesAvailable()

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStagesAvailable() method.

Returns:

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

hasStagesAvailable

public final boolean hasStagesAvailable()

For responses, this returns true if the service returned a value for the StagesAvailable property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

stagesAvailableAsStrings

public final List<String> stagesAvailableAsStrings()

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasStagesAvailable() method.

Returns:

The stage of the template that you can retrieve. For stacks, the Original and Processed templates are always available. For change sets, the Original template is always available. After CloudFormation finishes creating the change set, the Processed template becomes available.

toBuilder

public GetTemplateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetTemplateResponse.Builder,GetTemplateResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetTemplateResponse.Builder builder()

serializableBuilderClass

public static Class<? extends GetTemplateResponse.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

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.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkResponse

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo