software.amazon.awssdk.services.cloudformation.model

Class ValidateTemplateResponse

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.ValidateTemplateResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<ValidateTemplateResponse.Builder,ValidateTemplateResponse>

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

The output for ValidateTemplate action.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ValidateTemplateResponse.Builder

Method Summary

Modifier and Type	Method and Description
static ValidateTemplateResponse.Builder	builder()
List<Capability>	capabilities() The capabilities found within the template.
List<String>	capabilitiesAsStrings() The capabilities found within the template.
String	capabilitiesReason() The list of resources that generated the values in the Capabilities response element.
List<String>	declaredTransforms() A list of the transforms that are declared in the template.
String	description() The description found within the template.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasCapabilities() For responses, this returns true if the service returned a value for the Capabilities property.
boolean	hasDeclaredTransforms() For responses, this returns true if the service returned a value for the DeclaredTransforms property.
int	hashCode()
boolean	hasParameters() For responses, this returns true if the service returned a value for the Parameters property.
List<TemplateParameter>	parameters() A list of TemplateParameter structures.
List<SdkField<?>>	sdkFields()
static Class<? extends ValidateTemplateResponse.Builder>	serializableBuilderClass()
ValidateTemplateResponse.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

hasParameters

public final boolean hasParameters()

For responses, this returns true if the service returned a value for the Parameters 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.

parameters

public final List<TemplateParameter> parameters()

A list of TemplateParameter structures.

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 hasParameters() method.

Returns:

A list of TemplateParameter structures.

description

public final String description()

The description found within the template.

Returns:

The description found within the template.

capabilities

public final List<Capability> capabilities()

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

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 hasCapabilities() method.

Returns:

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

hasCapabilities

public final boolean hasCapabilities()

For responses, this returns true if the service returned a value for the Capabilities 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.

capabilitiesAsStrings

public final List<String> capabilitiesAsStrings()

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

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 hasCapabilities() method.

Returns:

The capabilities found within the template. If your template contains IAM resources, you must specify the CAPABILITY_IAM or CAPABILITY_NAMED_IAM value for this parameter when you use the CreateStack or UpdateStack actions with your template; otherwise, those actions return an InsufficientCapabilities error.

For more information, see Acknowledging IAM Resources in CloudFormation Templates.

capabilitiesReason

public final String capabilitiesReason()

The list of resources that generated the values in the Capabilities response element.

Returns:

The list of resources that generated the values in the Capabilities response element.

hasDeclaredTransforms

public final boolean hasDeclaredTransforms()

For responses, this returns true if the service returned a value for the DeclaredTransforms 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.

declaredTransforms

public final List<String> declaredTransforms()

A list of the transforms that are declared in the template.

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 hasDeclaredTransforms() method.

Returns:

A list of the transforms that are declared in the template.

toBuilder

public ValidateTemplateResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ValidateTemplateResponse.Builder,ValidateTemplateResponse>

Overrides:

toBuilder in class AwsResponse

builder

public static ValidateTemplateResponse.Builder builder()

serializableBuilderClass

public static Class<? extends ValidateTemplateResponse.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