DescribeFrameworkResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.backup.model.DescribeFrameworkResult

All Implemented Interfaces:: Serializable, Cloneable

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

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

DescribeFrameworkResult()

Constructors
Constructor and Description
`DescribeFrameworkResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`DescribeFrameworkResult`	`clone()`
`boolean`	`equals(Object obj)`
`Date`	`getCreationTime()` The date and time that a framework is created, in ISO 8601 representation.
`String`	`getDeploymentStatus()` The deployment status of a framework.
`String`	`getFrameworkArn()` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`List<FrameworkControl>`	`getFrameworkControls()` A list of the controls that make up the framework.
`String`	`getFrameworkDescription()` An optional description of the framework.
`String`	`getFrameworkName()` The unique name of a framework.
`String`	`getFrameworkStatus()` A framework consists of one or more controls.
`String`	`getIdempotencyToken()` A customer-chosen string that you can use to distinguish between otherwise identical calls to `DescribeFrameworkOutput`.
`int`	`hashCode()`
`void`	`setCreationTime(Date creationTime)` The date and time that a framework is created, in ISO 8601 representation.
`void`	`setDeploymentStatus(String deploymentStatus)` The deployment status of a framework.
`void`	`setFrameworkArn(String frameworkArn)` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`void`	`setFrameworkControls(Collection<FrameworkControl> frameworkControls)` A list of the controls that make up the framework.
`void`	`setFrameworkDescription(String frameworkDescription)` An optional description of the framework.
`void`	`setFrameworkName(String frameworkName)` The unique name of a framework.
`void`	`setFrameworkStatus(String frameworkStatus)` A framework consists of one or more controls.
`void`	`setIdempotencyToken(String idempotencyToken)` A customer-chosen string that you can use to distinguish between otherwise identical calls to `DescribeFrameworkOutput`.
`String`	`toString()` Returns a string representation of this object.
`DescribeFrameworkResult`	`withCreationTime(Date creationTime)` The date and time that a framework is created, in ISO 8601 representation.
`DescribeFrameworkResult`	`withDeploymentStatus(String deploymentStatus)` The deployment status of a framework.
`DescribeFrameworkResult`	`withFrameworkArn(String frameworkArn)` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`DescribeFrameworkResult`	`withFrameworkControls(Collection<FrameworkControl> frameworkControls)` A list of the controls that make up the framework.
`DescribeFrameworkResult`	`withFrameworkControls(FrameworkControl... frameworkControls)` A list of the controls that make up the framework.
`DescribeFrameworkResult`	`withFrameworkDescription(String frameworkDescription)` An optional description of the framework.
`DescribeFrameworkResult`	`withFrameworkName(String frameworkName)` The unique name of a framework.
`DescribeFrameworkResult`	`withFrameworkStatus(String frameworkStatus)` A framework consists of one or more controls.
`DescribeFrameworkResult`	`withIdempotencyToken(String idempotencyToken)` A customer-chosen string that you can use to distinguish between otherwise identical calls to `DescribeFrameworkOutput`.

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
  - DescribeFrameworkResult
```
public DescribeFrameworkResult()
```
- Method Detail
  - setFrameworkName
```
public void setFrameworkName(String frameworkName)
```
    The unique name of a framework.
    
    Parameters:
    
    frameworkName - The unique name of a framework.
  - getFrameworkName
```
public String getFrameworkName()
```
    The unique name of a framework.
    
    Returns:
    
    The unique name of a framework.
  - withFrameworkName
```
public DescribeFrameworkResult withFrameworkName(String frameworkName)
```
    The unique name of a framework.
    
    Parameters:
    
    frameworkName - The unique name of a framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFrameworkArn
```
public void setFrameworkArn(String frameworkArn)
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    frameworkArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - getFrameworkArn
```
public String getFrameworkArn()
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
  - withFrameworkArn
```
public DescribeFrameworkResult withFrameworkArn(String frameworkArn)
```
    An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Parameters:
    
    frameworkArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFrameworkDescription
```
public void setFrameworkDescription(String frameworkDescription)
```
    An optional description of the framework.
    
    Parameters:
    
    frameworkDescription - An optional description of the framework.
  - getFrameworkDescription
```
public String getFrameworkDescription()
```
    An optional description of the framework.
    
    Returns:
    
    An optional description of the framework.
  - withFrameworkDescription
```
public DescribeFrameworkResult withFrameworkDescription(String frameworkDescription)
```
    An optional description of the framework.
    
    Parameters:
    
    frameworkDescription - An optional description of the framework.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - getFrameworkControls
```
public List<FrameworkControl> getFrameworkControls()
```
    A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
    
    Returns:
    
    A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
  - setFrameworkControls
```
public void setFrameworkControls(Collection<FrameworkControl> frameworkControls)
```
    A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
    
    Parameters:
    
    frameworkControls - A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
  - withFrameworkControls
```
public DescribeFrameworkResult withFrameworkControls(FrameworkControl... frameworkControls)
```
    A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
    
    NOTE: This method appends the values to the existing list (if any). Use setFrameworkControls(java.util.Collection) or withFrameworkControls(java.util.Collection) if you want to override the existing values.
    
    Parameters:
    
    frameworkControls - A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - withFrameworkControls
```
public DescribeFrameworkResult withFrameworkControls(Collection<FrameworkControl> frameworkControls)
```
    A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
    
    Parameters:
    
    frameworkControls - A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setCreationTime
```
public void setCreationTime(Date creationTime)
```
    The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
    
    Parameters:
    
    creationTime - The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
  - getCreationTime
```
public Date getCreationTime()
```
    The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
    
    Returns:
    
    The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
  - withCreationTime
```
public DescribeFrameworkResult withCreationTime(Date creationTime)
```
    The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
    
    Parameters:
    
    creationTime - The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setDeploymentStatus
```
public void setDeploymentStatus(String deploymentStatus)
```
    The deployment status of a framework. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
    
    Parameters:
    
    deploymentStatus - The deployment status of a framework. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
  - getDeploymentStatus
```
public String getDeploymentStatus()
```
    The deployment status of a framework. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
    
    Returns:
    
    The deployment status of a framework. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
  - withDeploymentStatus
```
public DescribeFrameworkResult withDeploymentStatus(String deploymentStatus)
```
    The deployment status of a framework. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
    
    Parameters:
    
    deploymentStatus - The deployment status of a framework. The statuses are:
    
    CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setFrameworkStatus
```
public void setFrameworkStatus(String frameworkStatus)
```
    A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
    - ACTIVE when recording is turned on for all resources governed by the framework.
    - PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
    - INACTIVE when recording is turned off for all resources governed by the framework.
    - UNAVAILABLE when Backup is unable to validate recording status at this time.
    Parameters:
    frameworkStatus - A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
    
    ACTIVE when recording is turned on for all resources governed by the framework.
    
    PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
    
    INACTIVE when recording is turned off for all resources governed by the framework.
    
    UNAVAILABLE when Backup is unable to validate recording status at this time.
  - getFrameworkStatus
```
public String getFrameworkStatus()
```
    A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
    - ACTIVE when recording is turned on for all resources governed by the framework.
    - PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
    - INACTIVE when recording is turned off for all resources governed by the framework.
    - UNAVAILABLE when Backup is unable to validate recording status at this time.
    Returns:
    A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
    
    ACTIVE when recording is turned on for all resources governed by the framework.
    
    PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
    
    INACTIVE when recording is turned off for all resources governed by the framework.
    
    UNAVAILABLE when Backup is unable to validate recording status at this time.
  - withFrameworkStatus
```
public DescribeFrameworkResult withFrameworkStatus(String frameworkStatus)
```
    A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
    - ACTIVE when recording is turned on for all resources governed by the framework.
    - PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
    - INACTIVE when recording is turned off for all resources governed by the framework.
    - UNAVAILABLE when Backup is unable to validate recording status at this time.
    Parameters:
    frameworkStatus - A framework consists of one or more controls. Each control governs a resource, such as backup plans, backup selections, backup vaults, or recovery points. You can also turn Config recording on or off for each resource. The statuses are:
    
    ACTIVE when recording is turned on for all resources governed by the framework.
    
    PARTIALLY_ACTIVE when recording is turned off for at least one resource governed by the framework.
    
    INACTIVE when recording is turned off for all resources governed by the framework.
    
    UNAVAILABLE when Backup is unable to validate recording status at this time.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setIdempotencyToken
```
public void setIdempotencyToken(String idempotencyToken)
```
    A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
    
    Parameters:
    
    idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
  - getIdempotencyToken
```
public String getIdempotencyToken()
```
    A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
    
    Returns:
    
    A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
  - withIdempotencyToken
```
public DescribeFrameworkResult withIdempotencyToken(String idempotencyToken)
```
    A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
    
    Parameters:
    
    idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to DescribeFrameworkOutput. Retrying a successful request with the same idempotency token results in a success message with no action taken.
    
    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 DescribeFrameworkResult clone()
```
    Overrides:
    
    clone in class Object

AWS SDK for Java 1.x API Reference - 1.12.771

Class DescribeFrameworkResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

DescribeFrameworkResult

Method Detail

setFrameworkName

getFrameworkName

withFrameworkName

setFrameworkArn

getFrameworkArn

withFrameworkArn

setFrameworkDescription

getFrameworkDescription

withFrameworkDescription

getFrameworkControls

setFrameworkControls

withFrameworkControls

withFrameworkControls

setCreationTime

getCreationTime

withCreationTime

setDeploymentStatus

getDeploymentStatus

withDeploymentStatus

setFrameworkStatus

getFrameworkStatus

withFrameworkStatus

setIdempotencyToken

getIdempotencyToken

withIdempotencyToken

toString

equals

hashCode

clone