commonMain.aws.sdk.kotlin.services.finspace.model.CreateKxDataviewRequest.kt Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of finspace-jvm Show documentation
Show all versions of finspace-jvm Show documentation
The AWS SDK for Kotlin client for finspace
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.finspace.model
import aws.smithy.kotlin.runtime.SdkDsl
public class CreateKxDataviewRequest private constructor(builder: Builder) {
/**
* The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.
*/
public val autoUpdate: kotlin.Boolean? = builder.autoUpdate
/**
* The identifier of the availability zones.
*/
public val availabilityZoneId: kotlin.String? = builder.availabilityZoneId
/**
* The number of availability zones you want to assign per volume. Currently, FinSpace only supports `SINGLE` for volumes. This places dataview in a single AZ.
*/
public val azMode: aws.sdk.kotlin.services.finspace.model.KxAzMode? = builder.azMode
/**
* A unique identifier of the changeset that you want to use to ingest data.
*/
public val changesetId: kotlin.String? = builder.changesetId
/**
* A token that ensures idempotency. This token expires in 10 minutes.
*/
public val clientToken: kotlin.String? = builder.clientToken
/**
* The name of the database where you want to create a dataview.
*/
public val databaseName: kotlin.String? = builder.databaseName
/**
* A unique identifier for the dataview.
*/
public val dataviewName: kotlin.String? = builder.dataviewName
/**
* A description of the dataview.
*/
public val description: kotlin.String? = builder.description
/**
* A unique identifier for the kdb environment, where you want to create the dataview.
*/
public val environmentId: kotlin.String? = builder.environmentId
/**
* The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.
* + You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.
* + You cannot perform updates on a writeable dataview. Hence, `autoUpdate` must be set as **False** if `readWrite` is **True** for a dataview.
* + You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
* + Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the `readWrite` parameter later.
*/
public val readWrite: kotlin.Boolean? = builder.readWrite
/**
* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
*/
public val segmentConfigurations: List? = builder.segmentConfigurations
/**
* A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
*/
public val tags: Map? = builder.tags
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.finspace.model.CreateKxDataviewRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("CreateKxDataviewRequest(")
append("autoUpdate=$autoUpdate,")
append("availabilityZoneId=$availabilityZoneId,")
append("azMode=$azMode,")
append("changesetId=$changesetId,")
append("clientToken=$clientToken,")
append("databaseName=$databaseName,")
append("dataviewName=$dataviewName,")
append("description=$description,")
append("environmentId=$environmentId,")
append("readWrite=$readWrite,")
append("segmentConfigurations=$segmentConfigurations,")
append("tags=$tags")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = autoUpdate?.hashCode() ?: 0
result = 31 * result + (availabilityZoneId?.hashCode() ?: 0)
result = 31 * result + (azMode?.hashCode() ?: 0)
result = 31 * result + (changesetId?.hashCode() ?: 0)
result = 31 * result + (clientToken?.hashCode() ?: 0)
result = 31 * result + (databaseName?.hashCode() ?: 0)
result = 31 * result + (dataviewName?.hashCode() ?: 0)
result = 31 * result + (description?.hashCode() ?: 0)
result = 31 * result + (environmentId?.hashCode() ?: 0)
result = 31 * result + (readWrite?.hashCode() ?: 0)
result = 31 * result + (segmentConfigurations?.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 CreateKxDataviewRequest
if (autoUpdate != other.autoUpdate) return false
if (availabilityZoneId != other.availabilityZoneId) return false
if (azMode != other.azMode) return false
if (changesetId != other.changesetId) return false
if (clientToken != other.clientToken) return false
if (databaseName != other.databaseName) return false
if (dataviewName != other.dataviewName) return false
if (description != other.description) return false
if (environmentId != other.environmentId) return false
if (readWrite != other.readWrite) return false
if (segmentConfigurations != other.segmentConfigurations) return false
if (tags != other.tags) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.finspace.model.CreateKxDataviewRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* The option to specify whether you want to apply all the future additions and corrections automatically to the dataview, when you ingest new changesets. The default value is false.
*/
public var autoUpdate: kotlin.Boolean? = null
/**
* The identifier of the availability zones.
*/
public var availabilityZoneId: kotlin.String? = null
/**
* The number of availability zones you want to assign per volume. Currently, FinSpace only supports `SINGLE` for volumes. This places dataview in a single AZ.
*/
public var azMode: aws.sdk.kotlin.services.finspace.model.KxAzMode? = null
/**
* A unique identifier of the changeset that you want to use to ingest data.
*/
public var changesetId: kotlin.String? = null
/**
* A token that ensures idempotency. This token expires in 10 minutes.
*/
public var clientToken: kotlin.String? = null
/**
* The name of the database where you want to create a dataview.
*/
public var databaseName: kotlin.String? = null
/**
* A unique identifier for the dataview.
*/
public var dataviewName: kotlin.String? = null
/**
* A description of the dataview.
*/
public var description: kotlin.String? = null
/**
* A unique identifier for the kdb environment, where you want to create the dataview.
*/
public var environmentId: kotlin.String? = null
/**
* The option to specify whether you want to make the dataview writable to perform database maintenance. The following are some considerations related to writable dataviews.
* + You cannot create partial writable dataviews. When you create writeable dataviews you must provide the entire database path.
* + You cannot perform updates on a writeable dataview. Hence, `autoUpdate` must be set as **False** if `readWrite` is **True** for a dataview.
* + You must also use a unique volume for creating a writeable dataview. So, if you choose a volume that is already in use by another dataview, the dataview creation fails.
* + Once you create a dataview as writeable, you cannot change it to read-only. So, you cannot update the `readWrite` parameter later.
*/
public var readWrite: kotlin.Boolean? = null
/**
* The configuration that contains the database path of the data that you want to place on each selected volume. Each segment must have a unique database path for each volume. If you do not explicitly specify any database path for a volume, they are accessible from the cluster through the default S3/object store segment.
*/
public var segmentConfigurations: List? = null
/**
* A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
*/
public var tags: Map? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.finspace.model.CreateKxDataviewRequest) : this() {
this.autoUpdate = x.autoUpdate
this.availabilityZoneId = x.availabilityZoneId
this.azMode = x.azMode
this.changesetId = x.changesetId
this.clientToken = x.clientToken
this.databaseName = x.databaseName
this.dataviewName = x.dataviewName
this.description = x.description
this.environmentId = x.environmentId
this.readWrite = x.readWrite
this.segmentConfigurations = x.segmentConfigurations
this.tags = x.tags
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.finspace.model.CreateKxDataviewRequest = CreateKxDataviewRequest(this)
internal fun correctErrors(): Builder {
return this
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy