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

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

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

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface DescribeGeneratedTemplateResponse.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static DescribeGeneratedTemplateResponse.Builder`	`builder()`
`Instant`	`creationTime()`	The time the generated template was created.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`generatedTemplateId()`	The Amazon Resource Name (ARN) of the generated template.
`String`	`generatedTemplateName()`	The name of the generated template.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`boolean`	`hasResources()`	For responses, this returns true if the service returned a value for the Resources property.
`Instant`	`lastUpdatedTime()`	The time the generated template was last updated.
`TemplateProgress`	`progress()`	An object describing the progress of the template generation.
`List<ResourceDetail>`	`resources()`	A list of objects describing the details of the resources in the template generation.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends DescribeGeneratedTemplateResponse.Builder>`	`serializableBuilderClass()`
`String`	`stackId()`	The stack ARN of the base stack if a base stack was provided when generating the template.
`GeneratedTemplateStatus`	`status()`	The status of the template generation.
`String`	`statusAsString()`	The status of the template generation.
`String`	`statusReason()`	The reason for the current template generation status.
`TemplateConfiguration`	`templateConfiguration()`	The configuration details of the generated template, including the `DeletionPolicy` and `UpdateReplacePolicy`.
`DescribeGeneratedTemplateResponse.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`Integer`	`totalWarnings()`	The number of warnings generated for this template.

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
  - generatedTemplateId
```
public final String generatedTemplateId()
```
    The 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 .
    
    Returns:
    
    The 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 .
  - generatedTemplateName
```
public final String generatedTemplateName()
```
    The name of the generated template.
    
    Returns:
    
    The name of the generated template.
  - hasResources
```
public final boolean hasResources()
```
    For responses, this returns true if the service returned a value for the Resources 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.
  - resources
```
public final List<ResourceDetail> resources()
```
    A list of objects describing the details of the resources in the template generation.
    
    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 hasResources() method.
    
    Returns:
    
    A list of objects describing the details of the resources in the template generation.
  - status
```
public final GeneratedTemplateStatus status()
```
    The status of the template generation. Supported values are:
    
    CreatePending - the creation of the template is pending.
    
    CreateInProgress - the creation of the template is in progress.
    
    DeletePending - the deletion of the template is pending.
    
    DeleteInProgress - the deletion of the template is in progress.
    
    UpdatePending - the update of the template is pending.
    
    UpdateInProgress - the update of the template is in progress.
    
    Failed - the template operation failed.
    
    Complete - the template operation is complete.
    
    If the service returns an enum value that is not available in the current SDK version, status will return GeneratedTemplateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the template generation. Supported values are:
    
    CreatePending - the creation of the template is pending.
    
    CreateInProgress - the creation of the template is in progress.
    
    DeletePending - the deletion of the template is pending.
    
    DeleteInProgress - the deletion of the template is in progress.
    
    UpdatePending - the update of the template is pending.
    
    UpdateInProgress - the update of the template is in progress.
    
    Failed - the template operation failed.
    
    Complete - the template operation is complete.
    
    See Also:
    
    GeneratedTemplateStatus
  - statusAsString
```
public final String statusAsString()
```
    The status of the template generation. Supported values are:
    
    CreatePending - the creation of the template is pending.
    
    CreateInProgress - the creation of the template is in progress.
    
    DeletePending - the deletion of the template is pending.
    
    DeleteInProgress - the deletion of the template is in progress.
    
    UpdatePending - the update of the template is pending.
    
    UpdateInProgress - the update of the template is in progress.
    
    Failed - the template operation failed.
    
    Complete - the template operation is complete.
    
    If the service returns an enum value that is not available in the current SDK version, status will return GeneratedTemplateStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    The status of the template generation. Supported values are:
    
    CreatePending - the creation of the template is pending.
    
    CreateInProgress - the creation of the template is in progress.
    
    DeletePending - the deletion of the template is pending.
    
    DeleteInProgress - the deletion of the template is in progress.
    
    UpdatePending - the update of the template is pending.
    
    UpdateInProgress - the update of the template is in progress.
    
    Failed - the template operation failed.
    
    Complete - the template operation is complete.
    
    See Also:
    
    GeneratedTemplateStatus
  - statusReason
```
public final String statusReason()
```
    The reason for the current template generation status. This will provide more details if a failure happened.
    
    Returns:
    
    The reason for the current template generation status. This will provide more details if a failure happened.
  - creationTime
```
public final Instant creationTime()
```
    The time the generated template was created.
    
    Returns:
    
    The time the generated template was created.
  - lastUpdatedTime
```
public final Instant lastUpdatedTime()
```
    The time the generated template was last updated.
    
    Returns:
    
    The time the generated template was last updated.
  - progress
```
public final TemplateProgress progress()
```
    An object describing the progress of the template generation.
    
    Returns:
    
    An object describing the progress of the template generation.
  - stackId
```
public final String stackId()
```
    The stack ARN of the base stack if a base stack was provided when generating the template.
    
    Returns:
    
    The stack ARN of the base stack if a base stack was provided when generating the template.
  - templateConfiguration
```
public final TemplateConfiguration templateConfiguration()
```
    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
    
    Returns:
    
    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
  - totalWarnings
```
public final Integer totalWarnings()
```
    The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
    
    Returns:
    
    The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
  - toBuilder
```
public DescribeGeneratedTemplateResponse.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<DescribeGeneratedTemplateResponse.Builder,DescribeGeneratedTemplateResponse>
    
    Specified by:
    
    toBuilder in class AwsResponse
  - builder
```
public static DescribeGeneratedTemplateResponse.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends DescribeGeneratedTemplateResponse.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 DescribeGeneratedTemplateResponse

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

generatedTemplateId

generatedTemplateName

hasResources

resources

status

statusAsString

statusReason

creationTime

lastUpdatedTime

progress

stackId

templateConfiguration

totalWarnings

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields