commonMain.aws.sdk.kotlin.services.braket.model.GetJobResponse.kt Maven / Gradle / Ivy
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.braket.model
import aws.smithy.kotlin.runtime.time.Instant
public class GetJobResponse private constructor(builder: Builder) {
/**
* Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
*/
public val algorithmSpecification: aws.sdk.kotlin.services.braket.model.AlgorithmSpecification? = builder.algorithmSpecification
/**
* The list of Amazon Braket resources associated with the hybrid job.
*/
public val associations: List? = builder.associations
/**
* The billable time the Amazon Braket job used to complete.
*/
public val billableDuration: kotlin.Int? = builder.billableDuration
/**
* Information about the output locations for job checkpoint data.
*/
public val checkpointConfig: aws.sdk.kotlin.services.braket.model.JobCheckpointConfig? = builder.checkpointConfig
/**
* The date and time that the Amazon Braket job was created.
*/
public val createdAt: aws.smithy.kotlin.runtime.time.Instant = requireNotNull(builder.createdAt) { "A non-null value must be provided for createdAt" }
/**
* The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
*/
public val deviceConfig: aws.sdk.kotlin.services.braket.model.DeviceConfig? = builder.deviceConfig
/**
* The date and time that the Amazon Braket job ended.
*/
public val endedAt: aws.smithy.kotlin.runtime.time.Instant? = builder.endedAt
/**
* Details about the type and time events occurred related to the Amazon Braket job.
*/
public val events: List? = builder.events
/**
* A description of the reason why an Amazon Braket job failed, if it failed.
*/
public val failureReason: kotlin.String? = builder.failureReason
/**
* Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
*/
public val hyperParameters: Map? = builder.hyperParameters
/**
* A list of parameters that specify the name and type of input data and where it is located.
*/
public val inputDataConfig: List? = builder.inputDataConfig
/**
* The resource instances to use while running the hybrid job on Amazon Braket.
*/
public val instanceConfig: aws.sdk.kotlin.services.braket.model.InstanceConfig? = builder.instanceConfig
/**
* The ARN of the Amazon Braket job.
*/
public val jobArn: kotlin.String = requireNotNull(builder.jobArn) { "A non-null value must be provided for jobArn" }
/**
* The name of the Amazon Braket job.
*/
public val jobName: kotlin.String = requireNotNull(builder.jobName) { "A non-null value must be provided for jobName" }
/**
* The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
*/
public val outputDataConfig: aws.sdk.kotlin.services.braket.model.JobOutputDataConfig? = builder.outputDataConfig
/**
* Queue information for the requested job. Only returned if `QueueInfo` is specified in the `additionalAttributeNames"` field in the `GetJob` API request.
*/
public val queueInfo: aws.sdk.kotlin.services.braket.model.HybridJobQueueInfo? = builder.queueInfo
/**
* The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.
*/
public val roleArn: kotlin.String = requireNotNull(builder.roleArn) { "A non-null value must be provided for roleArn" }
/**
* The date and time that the Amazon Braket job was started.
*/
public val startedAt: aws.smithy.kotlin.runtime.time.Instant? = builder.startedAt
/**
* The status of the Amazon Braket job.
*/
public val status: aws.sdk.kotlin.services.braket.model.JobPrimaryStatus = requireNotNull(builder.status) { "A non-null value must be provided for status" }
/**
* The user-defined criteria that specifies when to stop a job running.
*/
public val stoppingCondition: aws.sdk.kotlin.services.braket.model.JobStoppingCondition? = builder.stoppingCondition
/**
* A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
*/
public val tags: Map? = builder.tags
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.braket.model.GetJobResponse = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("GetJobResponse(")
append("algorithmSpecification=$algorithmSpecification,")
append("associations=$associations,")
append("billableDuration=$billableDuration,")
append("checkpointConfig=$checkpointConfig,")
append("createdAt=$createdAt,")
append("deviceConfig=$deviceConfig,")
append("endedAt=$endedAt,")
append("events=$events,")
append("failureReason=$failureReason,")
append("hyperParameters=$hyperParameters,")
append("inputDataConfig=$inputDataConfig,")
append("instanceConfig=$instanceConfig,")
append("jobArn=$jobArn,")
append("jobName=$jobName,")
append("outputDataConfig=$outputDataConfig,")
append("queueInfo=$queueInfo,")
append("roleArn=$roleArn,")
append("startedAt=$startedAt,")
append("status=$status,")
append("stoppingCondition=$stoppingCondition,")
append("tags=$tags")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = algorithmSpecification?.hashCode() ?: 0
result = 31 * result + (associations?.hashCode() ?: 0)
result = 31 * result + (billableDuration ?: 0)
result = 31 * result + (checkpointConfig?.hashCode() ?: 0)
result = 31 * result + (createdAt.hashCode())
result = 31 * result + (deviceConfig?.hashCode() ?: 0)
result = 31 * result + (endedAt?.hashCode() ?: 0)
result = 31 * result + (events?.hashCode() ?: 0)
result = 31 * result + (failureReason?.hashCode() ?: 0)
result = 31 * result + (hyperParameters?.hashCode() ?: 0)
result = 31 * result + (inputDataConfig?.hashCode() ?: 0)
result = 31 * result + (instanceConfig?.hashCode() ?: 0)
result = 31 * result + (jobArn.hashCode())
result = 31 * result + (jobName.hashCode())
result = 31 * result + (outputDataConfig?.hashCode() ?: 0)
result = 31 * result + (queueInfo?.hashCode() ?: 0)
result = 31 * result + (roleArn.hashCode())
result = 31 * result + (startedAt?.hashCode() ?: 0)
result = 31 * result + (status.hashCode())
result = 31 * result + (stoppingCondition?.hashCode() ?: 0)
result = 31 * result + (tags?.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 GetJobResponse
if (algorithmSpecification != other.algorithmSpecification) return false
if (associations != other.associations) return false
if (billableDuration != other.billableDuration) return false
if (checkpointConfig != other.checkpointConfig) return false
if (createdAt != other.createdAt) return false
if (deviceConfig != other.deviceConfig) return false
if (endedAt != other.endedAt) return false
if (events != other.events) return false
if (failureReason != other.failureReason) return false
if (hyperParameters != other.hyperParameters) return false
if (inputDataConfig != other.inputDataConfig) return false
if (instanceConfig != other.instanceConfig) return false
if (jobArn != other.jobArn) return false
if (jobName != other.jobName) return false
if (outputDataConfig != other.outputDataConfig) return false
if (queueInfo != other.queueInfo) return false
if (roleArn != other.roleArn) return false
if (startedAt != other.startedAt) return false
if (status != other.status) return false
if (stoppingCondition != other.stoppingCondition) return false
if (tags != other.tags) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.braket.model.GetJobResponse = Builder(this).apply(block).build()
public class Builder {
/**
* Definition of the Amazon Braket job created. Specifies the container image the job uses, information about the Python scripts used for entry and training, and the user-defined metrics used to evaluation the job.
*/
public var algorithmSpecification: aws.sdk.kotlin.services.braket.model.AlgorithmSpecification? = null
/**
* The list of Amazon Braket resources associated with the hybrid job.
*/
public var associations: List? = null
/**
* The billable time the Amazon Braket job used to complete.
*/
public var billableDuration: kotlin.Int? = null
/**
* Information about the output locations for job checkpoint data.
*/
public var checkpointConfig: aws.sdk.kotlin.services.braket.model.JobCheckpointConfig? = null
/**
* The date and time that the Amazon Braket job was created.
*/
public var createdAt: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The quantum processing unit (QPU) or simulator used to run the Amazon Braket job.
*/
public var deviceConfig: aws.sdk.kotlin.services.braket.model.DeviceConfig? = null
/**
* The date and time that the Amazon Braket job ended.
*/
public var endedAt: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* Details about the type and time events occurred related to the Amazon Braket job.
*/
public var events: List? = null
/**
* A description of the reason why an Amazon Braket job failed, if it failed.
*/
public var failureReason: kotlin.String? = null
/**
* Algorithm-specific parameters used by an Amazon Braket job that influence the quality of the traiing job. The values are set with a string of JSON key:value pairs, where the key is the name of the hyperparameter and the value is the value of th hyperparameter.
*/
public var hyperParameters: Map? = null
/**
* A list of parameters that specify the name and type of input data and where it is located.
*/
public var inputDataConfig: List? = null
/**
* The resource instances to use while running the hybrid job on Amazon Braket.
*/
public var instanceConfig: aws.sdk.kotlin.services.braket.model.InstanceConfig? = null
/**
* The ARN of the Amazon Braket job.
*/
public var jobArn: kotlin.String? = null
/**
* The name of the Amazon Braket job.
*/
public var jobName: kotlin.String? = null
/**
* The path to the S3 location where job artifacts are stored and the encryption key used to store them there.
*/
public var outputDataConfig: aws.sdk.kotlin.services.braket.model.JobOutputDataConfig? = null
/**
* Queue information for the requested job. Only returned if `QueueInfo` is specified in the `additionalAttributeNames"` field in the `GetJob` API request.
*/
public var queueInfo: aws.sdk.kotlin.services.braket.model.HybridJobQueueInfo? = null
/**
* The Amazon Resource Name (ARN) of an IAM role that Amazon Braket can assume to perform tasks on behalf of a user. It can access user resources, run an Amazon Braket job container on behalf of user, and output resources to the s3 buckets of a user.
*/
public var roleArn: kotlin.String? = null
/**
* The date and time that the Amazon Braket job was started.
*/
public var startedAt: aws.smithy.kotlin.runtime.time.Instant? = null
/**
* The status of the Amazon Braket job.
*/
public var status: aws.sdk.kotlin.services.braket.model.JobPrimaryStatus? = null
/**
* The user-defined criteria that specifies when to stop a job running.
*/
public var stoppingCondition: aws.sdk.kotlin.services.braket.model.JobStoppingCondition? = null
/**
* A tag object that consists of a key and an optional value, used to manage metadata for Amazon Braket resources.
*/
public var tags: Map? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.braket.model.GetJobResponse) : this() {
this.algorithmSpecification = x.algorithmSpecification
this.associations = x.associations
this.billableDuration = x.billableDuration
this.checkpointConfig = x.checkpointConfig
this.createdAt = x.createdAt
this.deviceConfig = x.deviceConfig
this.endedAt = x.endedAt
this.events = x.events
this.failureReason = x.failureReason
this.hyperParameters = x.hyperParameters
this.inputDataConfig = x.inputDataConfig
this.instanceConfig = x.instanceConfig
this.jobArn = x.jobArn
this.jobName = x.jobName
this.outputDataConfig = x.outputDataConfig
this.queueInfo = x.queueInfo
this.roleArn = x.roleArn
this.startedAt = x.startedAt
this.status = x.status
this.stoppingCondition = x.stoppingCondition
this.tags = x.tags
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.braket.model.GetJobResponse = GetJobResponse(this)
/**
* construct an [aws.sdk.kotlin.services.braket.model.AlgorithmSpecification] inside the given [block]
*/
public fun algorithmSpecification(block: aws.sdk.kotlin.services.braket.model.AlgorithmSpecification.Builder.() -> kotlin.Unit) {
this.algorithmSpecification = aws.sdk.kotlin.services.braket.model.AlgorithmSpecification.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.braket.model.JobCheckpointConfig] inside the given [block]
*/
public fun checkpointConfig(block: aws.sdk.kotlin.services.braket.model.JobCheckpointConfig.Builder.() -> kotlin.Unit) {
this.checkpointConfig = aws.sdk.kotlin.services.braket.model.JobCheckpointConfig.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.braket.model.DeviceConfig] inside the given [block]
*/
public fun deviceConfig(block: aws.sdk.kotlin.services.braket.model.DeviceConfig.Builder.() -> kotlin.Unit) {
this.deviceConfig = aws.sdk.kotlin.services.braket.model.DeviceConfig.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.braket.model.InstanceConfig] inside the given [block]
*/
public fun instanceConfig(block: aws.sdk.kotlin.services.braket.model.InstanceConfig.Builder.() -> kotlin.Unit) {
this.instanceConfig = aws.sdk.kotlin.services.braket.model.InstanceConfig.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.braket.model.JobOutputDataConfig] inside the given [block]
*/
public fun outputDataConfig(block: aws.sdk.kotlin.services.braket.model.JobOutputDataConfig.Builder.() -> kotlin.Unit) {
this.outputDataConfig = aws.sdk.kotlin.services.braket.model.JobOutputDataConfig.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.braket.model.HybridJobQueueInfo] inside the given [block]
*/
public fun queueInfo(block: aws.sdk.kotlin.services.braket.model.HybridJobQueueInfo.Builder.() -> kotlin.Unit) {
this.queueInfo = aws.sdk.kotlin.services.braket.model.HybridJobQueueInfo.invoke(block)
}
/**
* construct an [aws.sdk.kotlin.services.braket.model.JobStoppingCondition] inside the given [block]
*/
public fun stoppingCondition(block: aws.sdk.kotlin.services.braket.model.JobStoppingCondition.Builder.() -> kotlin.Unit) {
this.stoppingCondition = aws.sdk.kotlin.services.braket.model.JobStoppingCondition.invoke(block)
}
internal fun correctErrors(): Builder {
if (createdAt == null) createdAt = Instant.fromEpochSeconds(0)
if (jobArn == null) jobArn = ""
if (jobName == null) jobName = ""
if (roleArn == null) roleArn = ""
if (status == null) status = JobPrimaryStatus.SdkUnknown("no value provided")
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy