Struct CreateKxDataviewInput

#[non_exhaustive]
pub struct CreateKxDataviewInput {
    pub environment_id: Option<String>,
    pub database_name: Option<String>,
    pub dataview_name: Option<String>,
    pub az_mode: Option<KxAzMode>,
    pub availability_zone_id: Option<String>,
    pub changeset_id: Option<String>,
    pub segment_configurations: Option<Vec<KxDataviewSegmentConfiguration>>,
    pub auto_update: Option<bool>,
    pub read_write: Option<bool>,
    pub description: Option<String>,
    pub tags: Option<HashMap<String, String>>,
    pub client_token: Option<String>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

environment_id: Option<String>

A unique identifier for the kdb environment, where you want to create the dataview.

database_name: Option<String>

The name of the database where you want to create a dataview.

dataview_name: Option<String>

A unique identifier for the dataview.

az_mode: Option<KxAzMode>

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.

availability_zone_id: Option<String>

The identifier of the availability zones.

changeset_id: Option<String>

A unique identifier of the changeset that you want to use to ingest data.

segment_configurations: Option<Vec<KxDataviewSegmentConfiguration>>

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.

auto_update: Option<bool>

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.

read_write: Option<bool>

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.

description: Option<String>

A description of the dataview.

tags: Option<HashMap<String, String>>

A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.

client_token: Option<String>

A token that ensures idempotency. This token expires in 10 minutes.

Implementations

impl CreateKxDataviewInput

pub fn environment_id(&self) -> Option<&str>

A unique identifier for the kdb environment, where you want to create the dataview.

pub fn database_name(&self) -> Option<&str>

The name of the database where you want to create a dataview.

pub fn dataview_name(&self) -> Option<&str>

A unique identifier for the dataview.

pub fn az_mode(&self) -> Option<&KxAzMode>

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.

pub fn availability_zone_id(&self) -> Option<&str>

The identifier of the availability zones.

pub fn changeset_id(&self) -> Option<&str>

A unique identifier of the changeset that you want to use to ingest data.

pub fn segment_configurations(&self) -> &[KxDataviewSegmentConfiguration]

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.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .segment_configurations.is_none().

pub fn auto_update(&self) -> Option<bool>

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.

pub fn read_write(&self) -> Option<bool>

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.

pub fn description(&self) -> Option<&str>

A description of the dataview.

pub fn tags(&self) -> Option<&HashMap<String, String>>

A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.

pub fn client_token(&self) -> Option<&str>

A token that ensures idempotency. This token expires in 10 minutes.

impl CreateKxDataviewInput

pub fn builder() -> CreateKxDataviewInputBuilder

Creates a new builder-style object to manufacture CreateKxDataviewInput.

Trait Implementations

impl Clone for CreateKxDataviewInput

fn clone(&self) -> CreateKxDataviewInput

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateKxDataviewInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateKxDataviewInput

fn eq(&self, other: &CreateKxDataviewInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateKxDataviewInput