KxDataviewArgs class

The set of arguments for KxDataview. The set of arguments for KxDataview.

Constructors

KxDataviewArgs({required Input<bool> autoUpdate, Input<String?>? availabilityZoneId, required Input<String> azMode, Input<String?>? changesetId, required Input<String> databaseName, Input<String?>? description, required Input<String> environmentId, Input<String?>? name, Input<bool?>? readWrite, Input<String?>? region, Input<List<KxDataviewSegmentConfiguration>?>? segmentConfigurations, Input<Map<String, String>?>? tags})
Creates a new KxDataviewArgs. autoUpdate Whether to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. Defaults to false. availabilityZoneId Identifier of the availability zones. If attaching a volume, the volume must be in the same availability zone as the dataview that you are attaching to. azMode Number of availability zones you want to assign per cluster. Valid values are SINGLE (assigns one availability zone per cluster) and MULTI (assigns all the availability zones per cluster). changesetId Unique identifier of the changeset of the database that you want to use to ingest data. databaseName Name of the database where you want to create a dataview. description Description for the dataview. environmentId Unique identifier for the KX environment. name Unique identifier for the dataview. readWrite Whether to make the dataview writable to perform database maintenance. You cannot create partial writable dataviews; you must provide the entire database path and cannot perform updates, so autoUpdate must be false when readWrite is true. You must also use a unique volume, and once a dataview is writable you cannot change it to read-only. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. segmentConfigurations 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. See segmentConfigurations below. tags Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
const
KxDataviewArgs.fromMap(Map<String, dynamic> map)
factory

Properties

autoUpdate → Input<bool>
Whether to apply all the future additions and corrections automatically to the dataview when you ingest new changesets. Defaults to false.
final
availabilityZoneId → Input<String?>?
Identifier of the availability zones. If attaching a volume, the volume must be in the same availability zone as the dataview that you are attaching to.
final
azMode → Input<String>
Number of availability zones you want to assign per cluster. Valid values are SINGLE (assigns one availability zone per cluster) and MULTI (assigns all the availability zones per cluster).
final
changesetId → Input<String?>?
Unique identifier of the changeset of the database that you want to use to ingest data.
final
databaseName → Input<String>
Name of the database where you want to create a dataview.
final
description → Input<String?>?
Description for the dataview.
final
environmentId → Input<String>
Unique identifier for the KX environment.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String?>?
Unique identifier for the dataview.
final
readWrite → Input<bool?>?
Whether to make the dataview writable to perform database maintenance. You cannot create partial writable dataviews; you must provide the entire database path and cannot perform updates, so autoUpdate must be false when readWrite is true. You must also use a unique volume, and once a dataview is writable you cannot change it to read-only.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
segmentConfigurations → Input<List<KxDataviewSegmentConfiguration>?>?
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. See segmentConfigurations below.
final
tags → Input<Map<String, String>?>?
Key-value mapping of resource tags. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited