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

Class DescribeFrameworkResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.backup.model.BackupResponse
software.amazon.awssdk.services.backup.model.DescribeFrameworkResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<DescribeFrameworkResponse.Builder,DescribeFrameworkResponse>
@Generated("software.amazon.awssdk:codegen") public final class DescribeFrameworkResponse extends BackupResponse implements ToCopyableBuilder<DescribeFrameworkResponse.Builder,DescribeFrameworkResponse>

  • Method Details

    • frameworkName

      public final String frameworkName()

      The unique name of a framework.

      Returns:
      The unique name of a framework.

    • 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.

      Returns:
      An optional description of the framework.

    • hasFrameworkControls

      public final boolean hasFrameworkControls()
      For responses, this returns true if the service returned a value for the FrameworkControls property. This DOES NOT check that the value is non-empty (for which, you should check the 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.

    • frameworkControls

      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.

      Returns:
      A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

    • 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

    • frameworkStatus

      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.

      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.

    • idempotencyToken

      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.

      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.

    • toBuilder

      public DescribeFrameworkResponse.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DescribeFrameworkResponse.Builder,DescribeFrameworkResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static DescribeFrameworkResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.