Struct aws_sdk_finspace::operation::get_kx_dataview::GetKxDataviewOutput

#[non_exhaustive]
pub struct GetKxDataviewOutput {

    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 active_versions: Option<Vec<KxDataviewActiveVersion>>,
    pub description: Option<String>,
    pub auto_update: bool,
    pub environment_id: Option<String>,
    pub created_timestamp: Option<DateTime>,
    pub last_modified_timestamp: Option<DateTime>,
    pub status: Option<KxDataviewStatus>,
    pub status_reason: Option<String>,
    /* private fields */
}

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.

database_name: Option<String>

The name of the database where you created the 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 cluster. This can be one of the following

• SINGLE – Assigns one availability zone per cluster.

• MULTI – Assigns all the availability zones per cluster.

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.

active_versions: Option<Vec<KxDataviewActiveVersion>>

The current active changeset versions of the database on the given dataview.

description: Option<String>

A description of the dataview.

auto_update: bool

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.

environment_id: Option<String>

A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

created_timestamp: Option<DateTime>

The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

last_modified_timestamp: Option<DateTime>

The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

status: Option<KxDataviewStatus>

The status of dataview creation.

• CREATING – The dataview creation is in progress.

• UPDATING – The dataview is in the process of being updated.

• ACTIVE – The dataview is active.

status_reason: Option<String>

The error message when a failed state occurs.

Implementations

impl GetKxDataviewOutput

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

The name of the database where you created the 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 cluster. This can be one of the following

• SINGLE – Assigns one availability zone per cluster.

• MULTI – Assigns all the availability zones per cluster.

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 active_versions(&self) -> &[KxDataviewActiveVersion]

The current active changeset versions of the database on the given dataview.

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

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

A description of the dataview.

pub fn auto_update(&self) -> bool

The option to specify whether you want to apply all the future additions and corrections automatically to the dataview when new changesets are ingested. The default value is false.

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

A unique identifier for the kdb environment, from where you want to retrieve the dataview details.

pub fn created_timestamp(&self) -> Option<&DateTime>

The timestamp at which the dataview was created in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

pub fn last_modified_timestamp(&self) -> Option<&DateTime>

The last time that the dataview was updated in FinSpace. The value is determined as epoch time in milliseconds. For example, the value for Monday, November 1, 2021 12:00:00 PM UTC is specified as 1635768000000.

pub fn status(&self) -> Option<&KxDataviewStatus>

The status of dataview creation.

• CREATING – The dataview creation is in progress.

• UPDATING – The dataview is in the process of being updated.

• ACTIVE – The dataview is active.

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

The error message when a failed state occurs.

impl GetKxDataviewOutput

pub fn builder() -> GetKxDataviewOutputBuilder

Creates a new builder-style object to manufacture GetKxDataviewOutput.

Trait Implementations

impl Clone for GetKxDataviewOutput

fn clone(&self) -> GetKxDataviewOutput

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GetKxDataviewOutput

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

Formats the value using the given formatter.

impl PartialEq for GetKxDataviewOutput

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl RequestId for GetKxDataviewOutput

fn request_id(&self) -> Option<&str>

Returns the request ID, or None if the service could not be reached.

impl StructuralPartialEq for GetKxDataviewOutput