@Generated(value="software.amazon.awssdk:codegen") public final class DescribeFrameworkResponse extends BackupResponse implements ToCopyableBuilder<DescribeFrameworkResponse.Builder,DescribeFrameworkResponse>
| Modifier and Type | Class and Description |
|---|---|
static interface |
DescribeFrameworkResponse.Builder |
| Modifier and Type | Method and Description |
|---|---|
static DescribeFrameworkResponse.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.
|
List<FrameworkControl> |
frameworkControls()
A list of the controls that make up the framework.
|
String |
frameworkDescription()
An optional description of the framework.
|
String |
frameworkName()
The unique name of a framework.
|
String |
frameworkStatus()
A framework consists of one or more controls.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasFrameworkControls()
For responses, this returns true if the service returned a value for the FrameworkControls property.
|
int |
hashCode() |
String |
idempotencyToken()
A customer-chosen string that you can use to distinguish between otherwise identical calls to
DescribeFrameworkOutput. |
List<SdkField<?>> |
sdkFields() |
static Class<? extends DescribeFrameworkResponse.Builder> |
serializableBuilderClass() |
DescribeFrameworkResponse.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
responseMetadatasdkHttpResponseclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String frameworkName()
The unique name of a framework.
public final String frameworkArn()
An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
public final String frameworkDescription()
An optional description of the framework.
public final boolean hasFrameworkControls()
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.public final List<FrameworkControl> frameworkControls()
A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
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 hasFrameworkControls() method.
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.
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.public final String deploymentStatus()
The deployment status of a framework. The statuses are:
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED
public final 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.
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.
public final 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.
DescribeFrameworkOutput. Retrying a successful request with the same idempotency token
results in a success message with no action taken.public DescribeFrameworkResponse.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<DescribeFrameworkResponse.Builder,DescribeFrameworkResponse>toBuilder in class AwsResponsepublic static DescribeFrameworkResponse.Builder builder()
public static Class<? extends DescribeFrameworkResponse.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsResponsepublic final boolean equals(Object obj)
equals in class AwsResponsepublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkResponseCopyright © 2023. All rights reserved.