#[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)§
This struct is marked as non-exhaustive
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 ifreadWrite
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.
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§
Source§impl CreateKxDataviewInput
impl CreateKxDataviewInput
Sourcepub fn environment_id(&self) -> Option<&str>
pub fn environment_id(&self) -> Option<&str>
A unique identifier for the kdb environment, where you want to create the dataview.
Sourcepub fn database_name(&self) -> Option<&str>
pub fn database_name(&self) -> Option<&str>
The name of the database where you want to create a dataview.
Sourcepub fn dataview_name(&self) -> Option<&str>
pub fn dataview_name(&self) -> Option<&str>
A unique identifier for the dataview.
Sourcepub fn az_mode(&self) -> Option<&KxAzMode>
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.
Sourcepub fn availability_zone_id(&self) -> Option<&str>
pub fn availability_zone_id(&self) -> Option<&str>
The identifier of the availability zones.
Sourcepub fn changeset_id(&self) -> Option<&str>
pub fn changeset_id(&self) -> Option<&str>
A unique identifier of the changeset that you want to use to ingest data.
Sourcepub fn segment_configurations(&self) -> &[KxDataviewSegmentConfiguration]
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()
.
Sourcepub fn auto_update(&self) -> Option<bool>
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.
Sourcepub fn read_write(&self) -> Option<bool>
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 ifreadWrite
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.
Sourcepub fn description(&self) -> Option<&str>
pub fn description(&self) -> Option<&str>
A description of the dataview.
A list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
Sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
A token that ensures idempotency. This token expires in 10 minutes.
Source§impl CreateKxDataviewInput
impl CreateKxDataviewInput
Sourcepub fn builder() -> CreateKxDataviewInputBuilder
pub fn builder() -> CreateKxDataviewInputBuilder
Creates a new builder-style object to manufacture CreateKxDataviewInput
.
Trait Implementations§
Source§impl Clone for CreateKxDataviewInput
impl Clone for CreateKxDataviewInput
Source§fn clone(&self) -> CreateKxDataviewInput
fn clone(&self) -> CreateKxDataviewInput
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for CreateKxDataviewInput
impl Debug for CreateKxDataviewInput
Source§impl PartialEq for CreateKxDataviewInput
impl PartialEq for CreateKxDataviewInput
impl StructuralPartialEq for CreateKxDataviewInput
Auto Trait Implementations§
impl Freeze for CreateKxDataviewInput
impl RefUnwindSafe for CreateKxDataviewInput
impl Send for CreateKxDataviewInput
impl Sync for CreateKxDataviewInput
impl Unpin for CreateKxDataviewInput
impl UnwindSafe for CreateKxDataviewInput
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);