Package software.amazon.awssdk.services.backup.model

Class Framework

java.lang.Object

software.amazon.awssdk.services.backup.model.Framework

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<Framework.Builder,Framework>

@Generated("software.amazon.awssdk:codegen")
public final class Framework
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<Framework.Builder,Framework>

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	Framework.Builder

Method Summary

Modifier and Type	Method	Description
static Framework.Builder	builder()
Instant	creationTime()	The date and time that a framework is created, in ISO 8601 representation.
String	deploymentStatus()	The deployment status of a framework.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
String	frameworkArn()	An Amazon Resource Name (ARN) that uniquely identifies a resource.
String	frameworkDescription()	An optional description of the framework with a maximum 1,024 characters.
String	frameworkName()	The unique name of a framework.
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	numberOfControls()	The number of controls contained by the framework.
List<SdkField<?>>	sdkFields()
static Class<? extends Framework.Builder>	serializableBuilderClass()
Framework.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

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

frameworkName

public final 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 (_).

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 (_).

frameworkArn

public final String frameworkArn()

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.

frameworkDescription

public final String frameworkDescription()

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.

numberOfControls

public final Integer numberOfControls()

The number of controls contained by the framework.

Returns:

The number of controls contained by the framework.

creationTime

public final Instant 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:

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.

deploymentStatus

public final String deploymentStatus()

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

toBuilder

public Framework.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<Framework.Builder,Framework>

builder

public static Framework.Builder builder()

serializableBuilderClass

public static Class<? extends Framework.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo