Framework (AWS Java SDK for AWS Backup 1.12.716 API)

java.lang.Object
- com.amazonaws.services.backup.model.Framework

All Implemented Interfaces:

StructuredPojo, Serializable, Cloneable
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class Framework
extends Object
implements Serializable, Cloneable, StructuredPojo
```
Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

Framework()

Constructors
Constructor and Description
`Framework()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Framework`	`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.
`String`	`getFrameworkDescription()` An optional description of the framework with a maximum 1,024 characters.
`String`	`getFrameworkName()` The unique name of a framework.
`Integer`	`getNumberOfControls()` The number of controls contained by the framework.
`int`	`hashCode()`
`void`	`marshall(ProtocolMarshaller protocolMarshaller)`
`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`	`setFrameworkDescription(String frameworkDescription)` An optional description of the framework with a maximum 1,024 characters.
`void`	`setFrameworkName(String frameworkName)` The unique name of a framework.
`void`	`setNumberOfControls(Integer numberOfControls)` The number of controls contained by the framework.
`String`	`toString()` Returns a string representation of this object.
`Framework`	`withCreationTime(Date creationTime)` The date and time that a framework is created, in ISO 8601 representation.
`Framework`	`withDeploymentStatus(String deploymentStatus)` The deployment status of a framework.
`Framework`	`withFrameworkArn(String frameworkArn)` An Amazon Resource Name (ARN) that uniquely identifies a resource.
`Framework`	`withFrameworkDescription(String frameworkDescription)` An optional description of the framework with a maximum 1,024 characters.
`Framework`	`withFrameworkName(String frameworkName)` The unique name of a framework.
`Framework`	`withNumberOfControls(Integer numberOfControls)` The number of controls contained by the framework.

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

- Constructor Detail
  - Framework
```
public Framework()
```
- Method Detail
  - setFrameworkName
```
public void setFrameworkName(String frameworkName)
```
    The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
    
    Parameters:
    
    frameworkName - The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
  - getFrameworkName
```
public String getFrameworkName()
```
    The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
    
    Returns:
    
    The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
  - withFrameworkName
```
public Framework withFrameworkName(String frameworkName)
```
    The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
    
    Parameters:
    
    frameworkName - The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).
    
    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 Framework 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 with a maximum 1,024 characters.
    
    Parameters:
    
    frameworkDescription - An optional description of the framework with a maximum 1,024 characters.
  - getFrameworkDescription
```
public String getFrameworkDescription()
```
    An optional description of the framework with a maximum 1,024 characters.
    
    Returns:
    
    An optional description of the framework with a maximum 1,024 characters.
  - withFrameworkDescription
```
public Framework withFrameworkDescription(String frameworkDescription)
```
    An optional description of the framework with a maximum 1,024 characters.
    
    Parameters:
    
    frameworkDescription - An optional description of the framework with a maximum 1,024 characters.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setNumberOfControls
```
public void setNumberOfControls(Integer numberOfControls)
```
    The number of controls contained by the framework.
    
    Parameters:
    
    numberOfControls - The number of controls contained by the framework.
  - getNumberOfControls
```
public Integer getNumberOfControls()
```
    The number of controls contained by the framework.
    
    Returns:
    
    The number of controls contained by the framework.
  - withNumberOfControls
```
public Framework withNumberOfControls(Integer numberOfControls)
```
    The number of controls contained by the framework.
    
    Parameters:
    
    numberOfControls - The number of controls contained by the framework.
    
    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 Framework 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 Framework 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.
  - 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 Framework clone()
```
    Overrides:
    
    clone in class Object
  - marshall
```
public void marshall(ProtocolMarshaller protocolMarshaller)
```
    Specified by:
    
    marshall in interface StructuredPojo

Class Framework

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Framework

Method Detail

setFrameworkName

getFrameworkName

withFrameworkName

setFrameworkArn

getFrameworkArn

withFrameworkArn

setFrameworkDescription

getFrameworkDescription

withFrameworkDescription

setNumberOfControls

getNumberOfControls

withNumberOfControls

setCreationTime

getCreationTime

withCreationTime

setDeploymentStatus

getDeploymentStatus

withDeploymentStatus

toString

equals

hashCode

clone

marshall