GetTemplateSummaryResponse (AWS Java SDK :: Services :: AWS CloudFormation 2.20.143 API)

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

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<GetTemplateSummaryResponse.Builder,GetTemplateSummaryResponse>

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

The output for the GetTemplateSummary action.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface GetTemplateSummaryResponse.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`GetTemplateSummaryResponse.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static GetTemplateSummaryResponse.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 value that's defined in the `Description` property of 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.
`boolean`	`hasResourceIdentifierSummaries()` For responses, this returns true if the service returned a value for the ResourceIdentifierSummaries property.
`boolean`	`hasResourceTypes()` For responses, this returns true if the service returned a value for the ResourceTypes property.
`String`	`metadata()` The value that's defined for the `Metadata` property of the template.
`List<ParameterDeclaration>`	`parameters()` A list of parameter declarations that describe various properties for each parameter.
`List<ResourceIdentifierSummary>`	`resourceIdentifierSummaries()` A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources.
`List<String>`	`resourceTypes()` A list of all the template resource types that are defined in the template, such as `AWS::EC2::Instance`, `AWS::Dynamo::Table`, and `Custom::MyCustomInstance`.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends GetTemplateSummaryResponse.Builder>`	`serializableBuilderClass()`
`GetTemplateSummaryResponse.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`version()` The Amazon Web Services template format version, which identifies the capabilities of the template.
`Warnings`	`warnings()` An object containing any warnings returned.

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<ParameterDeclaration> parameters()
```
    A list of parameter declarations that describe various properties for each parameter.
    
    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 parameter declarations that describe various properties for each parameter.
  - description
```
public final String description()
```
    The value that's defined in the Description property of the template.
    
    Returns:
    
    The value that's defined in the Description property of 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.
  - hasResourceTypes
```
public final boolean hasResourceTypes()
```
    For responses, this returns true if the service returned a value for the ResourceTypes 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.
  - resourceTypes
```
public final List<String> resourceTypes()
```
    A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
    
    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 hasResourceTypes() method.
    
    Returns:
    
    A list of all the template resource types that are defined in the template, such as AWS::EC2::Instance, AWS::Dynamo::Table, and Custom::MyCustomInstance.
  - version
```
public final String version()
```
    The Amazon Web Services template format version, which identifies the capabilities of the template.
    
    Returns:
    
    The Amazon Web Services template format version, which identifies the capabilities of the template.
  - metadata
```
public final String metadata()
```
    The value that's defined for the Metadata property of the template.
    
    Returns:
    
    The value that's defined for the Metadata property of the template.
  - 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.
  - hasResourceIdentifierSummaries
```
public final boolean hasResourceIdentifierSummaries()
```
    For responses, this returns true if the service returned a value for the ResourceIdentifierSummaries 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.
  - resourceIdentifierSummaries
```
public final List<ResourceIdentifierSummary> resourceIdentifierSummaries()
```
    A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.
    
    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 hasResourceIdentifierSummaries() method.
    
    Returns:
    
    A list of resource identifier summaries that describe the target resources of an import operation and the properties you can provide during the import to identify the target resources. For example, BucketName is a possible identifier property for an AWS::S3::Bucket resource.
  - warnings
```
public final Warnings warnings()
```
    An object containing any warnings returned.
    
    Returns:
    
    An object containing any warnings returned.
  - toBuilder
```
public GetTemplateSummaryResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<GetTemplateSummaryResponse.Builder,GetTemplateSummaryResponse>
    
    Overrides:
    
    toBuilder in class AwsResponse
  - builder
```
public static GetTemplateSummaryResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends GetTemplateSummaryResponse.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

Class GetTemplateSummaryResponse

Nested Class Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

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

Method Detail

hasParameters

parameters

description

capabilities

hasCapabilities

capabilitiesAsStrings

capabilitiesReason

hasResourceTypes

resourceTypes

version

metadata

hasDeclaredTransforms

declaredTransforms

hasResourceIdentifierSummaries

resourceIdentifierSummaries

warnings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields