commonMain.aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of medicalimaging-jvm Show documentation
The AWS SDK for Kotlin client for Medical Imaging
The newest version!
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!

package aws.sdk.kotlin.services.medicalimaging.model

import aws.smithy.kotlin.runtime.time.Instant

/**
 * The search input attribute value.
 */
public sealed class SearchByAttributeValue {
    /**
     * The DICOM accession number for search.
     */
    public data class DicomAccessionNumber(val value: kotlin.String) : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    /**
     * The patient ID input for search.
     */
    public data class DicomPatientId(val value: kotlin.String) : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    /**
     * The Series Instance UID input for search.
     */
    public data class DicomSeriesInstanceUid(val value: kotlin.String) : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    /**
     * The aggregated structure containing DICOM study date and study time for search.
     */
    public data class DicomStudyDateAndTime(val value: aws.sdk.kotlin.services.medicalimaging.model.DicomStudyDateAndTime) : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    /**
     * The DICOM study ID for search.
     */
    public data class DicomStudyId(val value: kotlin.String) : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    /**
     * The DICOM study instance UID for search.
     */
    public data class DicomStudyInstanceUid(val value: kotlin.String) : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    /**
     * The created at time of the image set provided for search.
     */
    public data class CreatedAt(val value: aws.smithy.kotlin.runtime.time.Instant) : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    /**
     * The timestamp input for search.
     */
    public data class UpdatedAt(val value: aws.smithy.kotlin.runtime.time.Instant) : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    public object SdkUnknown : aws.sdk.kotlin.services.medicalimaging.model.SearchByAttributeValue() {
    }

    /**
     * Casts this [SearchByAttributeValue] as a [DicomAccessionNumber] and retrieves its [kotlin.String] value. Throws an exception if the [SearchByAttributeValue] is not a
     * [DicomAccessionNumber].
     */
    public fun asDicomAccessionNumber(): kotlin.String = (this as SearchByAttributeValue.DicomAccessionNumber).value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomAccessionNumber] and retrieves its [kotlin.String] value. Returns null if the [SearchByAttributeValue] is not a [DicomAccessionNumber].
     */
    public fun asDicomAccessionNumberOrNull(): kotlin.String? = (this as? SearchByAttributeValue.DicomAccessionNumber)?.value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomPatientId] and retrieves its [kotlin.String] value. Throws an exception if the [SearchByAttributeValue] is not a
     * [DicomPatientId].
     */
    public fun asDicomPatientId(): kotlin.String = (this as SearchByAttributeValue.DicomPatientId).value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomPatientId] and retrieves its [kotlin.String] value. Returns null if the [SearchByAttributeValue] is not a [DicomPatientId].
     */
    public fun asDicomPatientIdOrNull(): kotlin.String? = (this as? SearchByAttributeValue.DicomPatientId)?.value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomSeriesInstanceUid] and retrieves its [kotlin.String] value. Throws an exception if the [SearchByAttributeValue] is not a
     * [DicomSeriesInstanceUid].
     */
    public fun asDicomSeriesInstanceUid(): kotlin.String = (this as SearchByAttributeValue.DicomSeriesInstanceUid).value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomSeriesInstanceUid] and retrieves its [kotlin.String] value. Returns null if the [SearchByAttributeValue] is not a [DicomSeriesInstanceUid].
     */
    public fun asDicomSeriesInstanceUidOrNull(): kotlin.String? = (this as? SearchByAttributeValue.DicomSeriesInstanceUid)?.value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomStudyDateAndTime] and retrieves its [aws.sdk.kotlin.services.medicalimaging.model.DicomStudyDateAndTime] value. Throws an exception if the [SearchByAttributeValue] is not a
     * [DicomStudyDateAndTime].
     */
    public fun asDicomStudyDateAndTime(): aws.sdk.kotlin.services.medicalimaging.model.DicomStudyDateAndTime = (this as SearchByAttributeValue.DicomStudyDateAndTime).value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomStudyDateAndTime] and retrieves its [aws.sdk.kotlin.services.medicalimaging.model.DicomStudyDateAndTime] value. Returns null if the [SearchByAttributeValue] is not a [DicomStudyDateAndTime].
     */
    public fun asDicomStudyDateAndTimeOrNull(): aws.sdk.kotlin.services.medicalimaging.model.DicomStudyDateAndTime? = (this as? SearchByAttributeValue.DicomStudyDateAndTime)?.value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomStudyId] and retrieves its [kotlin.String] value. Throws an exception if the [SearchByAttributeValue] is not a
     * [DicomStudyId].
     */
    public fun asDicomStudyId(): kotlin.String = (this as SearchByAttributeValue.DicomStudyId).value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomStudyId] and retrieves its [kotlin.String] value. Returns null if the [SearchByAttributeValue] is not a [DicomStudyId].
     */
    public fun asDicomStudyIdOrNull(): kotlin.String? = (this as? SearchByAttributeValue.DicomStudyId)?.value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomStudyInstanceUid] and retrieves its [kotlin.String] value. Throws an exception if the [SearchByAttributeValue] is not a
     * [DicomStudyInstanceUid].
     */
    public fun asDicomStudyInstanceUid(): kotlin.String = (this as SearchByAttributeValue.DicomStudyInstanceUid).value

    /**
     * Casts this [SearchByAttributeValue] as a [DicomStudyInstanceUid] and retrieves its [kotlin.String] value. Returns null if the [SearchByAttributeValue] is not a [DicomStudyInstanceUid].
     */
    public fun asDicomStudyInstanceUidOrNull(): kotlin.String? = (this as? SearchByAttributeValue.DicomStudyInstanceUid)?.value

    /**
     * Casts this [SearchByAttributeValue] as a [CreatedAt] and retrieves its [aws.smithy.kotlin.runtime.time.Instant] value. Throws an exception if the [SearchByAttributeValue] is not a
     * [CreatedAt].
     */
    public fun asCreatedAt(): aws.smithy.kotlin.runtime.time.Instant = (this as SearchByAttributeValue.CreatedAt).value

    /**
     * Casts this [SearchByAttributeValue] as a [CreatedAt] and retrieves its [aws.smithy.kotlin.runtime.time.Instant] value. Returns null if the [SearchByAttributeValue] is not a [CreatedAt].
     */
    public fun asCreatedAtOrNull(): aws.smithy.kotlin.runtime.time.Instant? = (this as? SearchByAttributeValue.CreatedAt)?.value

    /**
     * Casts this [SearchByAttributeValue] as a [UpdatedAt] and retrieves its [aws.smithy.kotlin.runtime.time.Instant] value. Throws an exception if the [SearchByAttributeValue] is not a
     * [UpdatedAt].
     */
    public fun asUpdatedAt(): aws.smithy.kotlin.runtime.time.Instant = (this as SearchByAttributeValue.UpdatedAt).value

    /**
     * Casts this [SearchByAttributeValue] as a [UpdatedAt] and retrieves its [aws.smithy.kotlin.runtime.time.Instant] value. Returns null if the [SearchByAttributeValue] is not a [UpdatedAt].
     */
    public fun asUpdatedAtOrNull(): aws.smithy.kotlin.runtime.time.Instant? = (this as? SearchByAttributeValue.UpdatedAt)?.value
}