commonMain.aws.sdk.kotlin.services.backup.model.DescribeFrameworkResponse.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.backup.model
import aws.smithy.kotlin.runtime.SdkDsl
import aws.smithy.kotlin.runtime.time.Instant
public class DescribeFrameworkResponse private constructor(builder: Builder) {
/**
* 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.
*/
public val creationTime: aws.smithy.kotlin.runtime.time.Instant? = builder.creationTime
/**
* The deployment status of a framework. The statuses are:
*
* `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
*/
public val deploymentStatus: kotlin.String? = builder.deploymentStatus
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
public val frameworkArn: kotlin.String? = builder.frameworkArn
/**
* A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
*/
public val frameworkControls: List? = builder.frameworkControls
/**
* An optional description of the framework.
*/
public val frameworkDescription: kotlin.String? = builder.frameworkDescription
/**
* The unique name of a framework.
*/
public val frameworkName: kotlin.String? = builder.frameworkName
/**
* 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.
*/
public val frameworkStatus: kotlin.String? = builder.frameworkStatus
/**
* 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.
*/
public val idempotencyToken: kotlin.String? = builder.idempotencyToken
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.backup.model.DescribeFrameworkResponse = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("DescribeFrameworkResponse(")
append("creationTime=$creationTime,")
append("deploymentStatus=$deploymentStatus,")
append("frameworkArn=$frameworkArn,")
append("frameworkControls=$frameworkControls,")
append("frameworkDescription=$frameworkDescription,")
append("frameworkName=$frameworkName,")
append("frameworkStatus=$frameworkStatus,")
append("idempotencyToken=$idempotencyToken")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = creationTime?.hashCode() ?: 0
result = 31 * result + (deploymentStatus?.hashCode() ?: 0)
result = 31 * result + (frameworkArn?.hashCode() ?: 0)
result = 31 * result + (frameworkControls?.hashCode() ?: 0)
result = 31 * result + (frameworkDescription?.hashCode() ?: 0)
result = 31 * result + (frameworkName?.hashCode() ?: 0)
result = 31 * result + (frameworkStatus?.hashCode() ?: 0)
result = 31 * result + (idempotencyToken?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as DescribeFrameworkResponse
if (creationTime != other.creationTime) return false
if (deploymentStatus != other.deploymentStatus) return false
if (frameworkArn != other.frameworkArn) return false
if (frameworkControls != other.frameworkControls) return false
if (frameworkDescription != other.frameworkDescription) return false
if (frameworkName != other.frameworkName) return false
if (frameworkStatus != other.frameworkStatus) return false
if (idempotencyToken != other.idempotencyToken) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.backup.model.DescribeFrameworkResponse = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* 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.
*/
public var creationTime: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The deployment status of a framework. The statuses are:
*
* `CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED`
*/
public var deploymentStatus: kotlin.String? = null
/**
* An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.
*/
public var frameworkArn: kotlin.String? = null
/**
* A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.
*/
public var frameworkControls: List? = null
/**
* An optional description of the framework.
*/
public var frameworkDescription: kotlin.String? = null
/**
* The unique name of a framework.
*/
public var frameworkName: kotlin.String? = null
/**
* 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.
*/
public var frameworkStatus: kotlin.String? = null
/**
* 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.
*/
public var idempotencyToken: kotlin.String? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.backup.model.DescribeFrameworkResponse) : this() {
this.creationTime = x.creationTime
this.deploymentStatus = x.deploymentStatus
this.frameworkArn = x.frameworkArn
this.frameworkControls = x.frameworkControls
this.frameworkDescription = x.frameworkDescription
this.frameworkName = x.frameworkName
this.frameworkStatus = x.frameworkStatus
this.idempotencyToken = x.idempotencyToken
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.backup.model.DescribeFrameworkResponse = DescribeFrameworkResponse(this)
internal fun correctErrors(): Builder {
return this
}
}
}