DescribeGeneratedTemplateResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.cloudformation.model.DescribeGeneratedTemplateResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class DescribeGeneratedTemplateResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeGeneratedTemplateResult()

Constructors
Constructor and Description
`DescribeGeneratedTemplateResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeGeneratedTemplateResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` The time the generated template was created.
`String`	`getGeneratedTemplateId()` The Amazon Resource Name (ARN) of the generated template.
`String`	`getGeneratedTemplateName()` The name of the generated template.
`Date`	`getLastUpdatedTime()` The time the generated template was last updated.
`TemplateProgress`	`getProgress()` An object describing the progress of the template generation.
`List<ResourceDetail>`	`getResources()` A list of objects describing the details of the resources in the template generation.
`String`	`getStackId()` The stack ARN of the base stack if a base stack was provided when generating the template.
`String`	`getStatus()` The status of the template generation.
`String`	`getStatusReason()` The reason for the current template generation status.
`TemplateConfiguration`	`getTemplateConfiguration()` The configuration details of the generated template, including the `DeletionPolicy` and `UpdateReplacePolicy`.
`Integer`	`getTotalWarnings()` The number of warnings generated for this template.
`int`	`hashCode()`
`void`	`setCreationTime(Date creationTime)` The time the generated template was created.
`void`	`setGeneratedTemplateId(String generatedTemplateId)` The Amazon Resource Name (ARN) of the generated template.
`void`	`setGeneratedTemplateName(String generatedTemplateName)` The name of the generated template.
`void`	`setLastUpdatedTime(Date lastUpdatedTime)` The time the generated template was last updated.
`void`	`setProgress(TemplateProgress progress)` An object describing the progress of the template generation.
`void`	`setResources(Collection<ResourceDetail> resources)` A list of objects describing the details of the resources in the template generation.
`void`	`setStackId(String stackId)` The stack ARN of the base stack if a base stack was provided when generating the template.
`void`	`setStatus(String status)` The status of the template generation.
`void`	`setStatusReason(String statusReason)` The reason for the current template generation status.
`void`	`setTemplateConfiguration(TemplateConfiguration templateConfiguration)` The configuration details of the generated template, including the `DeletionPolicy` and `UpdateReplacePolicy`.
`void`	`setTotalWarnings(Integer totalWarnings)` The number of warnings generated for this template.
`String`	`toString()` Returns a string representation of this object.
`DescribeGeneratedTemplateResult`	`withCreationTime(Date creationTime)` The time the generated template was created.
`DescribeGeneratedTemplateResult`	`withGeneratedTemplateId(String generatedTemplateId)` The Amazon Resource Name (ARN) of the generated template.
`DescribeGeneratedTemplateResult`	`withGeneratedTemplateName(String generatedTemplateName)` The name of the generated template.
`DescribeGeneratedTemplateResult`	`withLastUpdatedTime(Date lastUpdatedTime)` The time the generated template was last updated.
`DescribeGeneratedTemplateResult`	`withProgress(TemplateProgress progress)` An object describing the progress of the template generation.
`DescribeGeneratedTemplateResult`	`withResources(Collection<ResourceDetail> resources)` A list of objects describing the details of the resources in the template generation.
`DescribeGeneratedTemplateResult`	`withResources(ResourceDetail... resources)` A list of objects describing the details of the resources in the template generation.
`DescribeGeneratedTemplateResult`	`withStackId(String stackId)` The stack ARN of the base stack if a base stack was provided when generating the template.
`DescribeGeneratedTemplateResult`	`withStatus(GeneratedTemplateStatus status)` The status of the template generation.
`DescribeGeneratedTemplateResult`	`withStatus(String status)` The status of the template generation.
`DescribeGeneratedTemplateResult`	`withStatusReason(String statusReason)` The reason for the current template generation status.
`DescribeGeneratedTemplateResult`	`withTemplateConfiguration(TemplateConfiguration templateConfiguration)` The configuration details of the generated template, including the `DeletionPolicy` and `UpdateReplacePolicy`.
`DescribeGeneratedTemplateResult`	`withTotalWarnings(Integer totalWarnings)` The number of warnings generated for this template.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DescribeGeneratedTemplateResult
```
public DescribeGeneratedTemplateResult()
```
- Method Detail
  - setGeneratedTemplateId
```
public void setGeneratedTemplateId(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 .
    
    Parameters:
    
    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 .
  - getGeneratedTemplateId
```
public String getGeneratedTemplateId()
```
    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 .
  - withGeneratedTemplateId
```
public DescribeGeneratedTemplateResult withGeneratedTemplateId(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 .
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - setGeneratedTemplateName
```
public void setGeneratedTemplateName(String generatedTemplateName)
```
    The name of the generated template.
    
    Parameters:
    
    generatedTemplateName - The name of the generated template.
  - getGeneratedTemplateName
```
public String getGeneratedTemplateName()
```
    The name of the generated template.
    
    Returns:
    
    The name of the generated template.
  - withGeneratedTemplateName
```
public DescribeGeneratedTemplateResult withGeneratedTemplateName(String generatedTemplateName)
```
    The name of the generated template.
    
    Parameters:
    
    generatedTemplateName - The name of the generated template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getResources
```
public List<ResourceDetail> getResources()
```
    A list of objects describing the details of the resources in the template generation.
    
    Returns:
    
    A list of objects describing the details of the resources in the template generation.
  - setResources
```
public void setResources(Collection<ResourceDetail> resources)
```
    A list of objects describing the details of the resources in the template generation.
    
    Parameters:
    
    resources - A list of objects describing the details of the resources in the template generation.
  - withResources
```
public DescribeGeneratedTemplateResult withResources(ResourceDetail... resources)
```
    A list of objects describing the details of the resources in the template generation.
    
    NOTE: This method appends the values to the existing list (if any). Use setResources(java.util.Collection) or withResources(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    resources - A list of objects describing the details of the resources in the template generation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withResources
```
public DescribeGeneratedTemplateResult withResources(Collection<ResourceDetail> resources)
```
    A list of objects describing the details of the resources in the template generation.
    
    Parameters:
    
    resources - A list of objects describing the details of the resources in the template generation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStatus
```
public void setStatus(String 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.
    Parameters:
    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.
    See Also:
    
    GeneratedTemplateStatus
  - getStatus
```
public String getStatus()
```
    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.
    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
  - withStatus
```
public DescribeGeneratedTemplateResult withStatus(String 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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GeneratedTemplateStatus
  - withStatus
```
public DescribeGeneratedTemplateResult withStatus(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.
    Parameters:
    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.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    GeneratedTemplateStatus
  - setStatusReason
```
public void setStatusReason(String statusReason)
```
    The reason for the current template generation status. This will provide more details if a failure happened.
    
    Parameters:
    
    statusReason - The reason for the current template generation status. This will provide more details if a failure happened.
  - getStatusReason
```
public String getStatusReason()
```
    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.
  - withStatusReason
```
public DescribeGeneratedTemplateResult withStatusReason(String statusReason)
```
    The reason for the current template generation status. This will provide more details if a failure happened.
    
    Parameters:
    
    statusReason - The reason for the current template generation status. This will provide more details if a failure happened.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The time the generated template was created.
    
    Parameters:
    
    creationTime - The time the generated template was created.
  - getCreationTime
```
public Date getCreationTime()
```
    The time the generated template was created.
    
    Returns:
    
    The time the generated template was created.
  - withCreationTime
```
public DescribeGeneratedTemplateResult withCreationTime(Date creationTime)
```
    The time the generated template was created.
    
    Parameters:
    
    creationTime - The time the generated template was created.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setLastUpdatedTime
```
public void setLastUpdatedTime(Date lastUpdatedTime)
```
    The time the generated template was last updated.
    
    Parameters:
    
    lastUpdatedTime - The time the generated template was last updated.
  - getLastUpdatedTime
```
public Date getLastUpdatedTime()
```
    The time the generated template was last updated.
    
    Returns:
    
    The time the generated template was last updated.
  - withLastUpdatedTime
```
public DescribeGeneratedTemplateResult withLastUpdatedTime(Date lastUpdatedTime)
```
    The time the generated template was last updated.
    
    Parameters:
    
    lastUpdatedTime - The time the generated template was last updated.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setProgress
```
public void setProgress(TemplateProgress progress)
```
    An object describing the progress of the template generation.
    
    Parameters:
    
    progress - An object describing the progress of the template generation.
  - getProgress
```
public TemplateProgress getProgress()
```
    An object describing the progress of the template generation.
    
    Returns:
    
    An object describing the progress of the template generation.
  - withProgress
```
public DescribeGeneratedTemplateResult withProgress(TemplateProgress progress)
```
    An object describing the progress of the template generation.
    
    Parameters:
    
    progress - An object describing the progress of the template generation.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setStackId
```
public void setStackId(String stackId)
```
    The stack ARN of the base stack if a base stack was provided when generating the template.
    
    Parameters:
    
    stackId - The stack ARN of the base stack if a base stack was provided when generating the template.
  - getStackId
```
public String getStackId()
```
    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.
  - withStackId
```
public DescribeGeneratedTemplateResult withStackId(String stackId)
```
    The stack ARN of the base stack if a base stack was provided when generating the template.
    
    Parameters:
    
    stackId - The stack ARN of the base stack if a base stack was provided when generating the template.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTemplateConfiguration
```
public void setTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
    
    Parameters:
    
    templateConfiguration - The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
  - getTemplateConfiguration
```
public TemplateConfiguration getTemplateConfiguration()
```
    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.
  - withTemplateConfiguration
```
public DescribeGeneratedTemplateResult withTemplateConfiguration(TemplateConfiguration templateConfiguration)
```
    The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
    
    Parameters:
    
    templateConfiguration - The configuration details of the generated template, including the DeletionPolicy and UpdateReplacePolicy.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setTotalWarnings
```
public void setTotalWarnings(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.
    
    Parameters:
    
    totalWarnings - The number of warnings generated for this template. The warnings are found in the details of each of the resources in the template.
  - getTotalWarnings
```
public Integer getTotalWarnings()
```
    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.
  - withTotalWarnings
```
public DescribeGeneratedTemplateResult withTotalWarnings(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.
    
    Parameters:
    
    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:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public DescribeGeneratedTemplateResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.773

Class DescribeGeneratedTemplateResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeGeneratedTemplateResult

Method Detail

setGeneratedTemplateId

getGeneratedTemplateId

withGeneratedTemplateId

setGeneratedTemplateName

getGeneratedTemplateName

withGeneratedTemplateName

getResources

setResources

withResources

withResources

setStatus

getStatus

withStatus

withStatus

setStatusReason

getStatusReason

withStatusReason

setCreationTime

getCreationTime

withCreationTime

setLastUpdatedTime

getLastUpdatedTime

withLastUpdatedTime

setProgress

getProgress

withProgress

setStackId

getStackId

withStackId

setTemplateConfiguration

getTemplateConfiguration

withTemplateConfiguration

setTotalWarnings

getTotalWarnings

withTotalWarnings

toString

equals

hashCode

clone