pub struct Client { /* private fields */ }
Expand description
Client for FinSpace User Environment Management service
Client for invoking operations on FinSpace User Environment Management service. Each operation on FinSpace User Environment Management service is a method on this
this struct. .send()
MUST be invoked on the generated operations to dispatch the request to the service.
§Constructing a Client
A Config
is required to construct a client. For most use cases, the aws-config
crate should be used to automatically resolve this config using
aws_config::load_from_env()
, since this will resolve an SdkConfig
which can be shared
across multiple different AWS SDK clients. This config resolution process can be customized
by calling aws_config::from_env()
instead, which returns a ConfigLoader
that uses
the builder pattern to customize the default config.
In the simplest case, creating a client looks as follows:
let config = aws_config::load_from_env().await;
let client = aws_sdk_finspace::Client::new(&config);
Occasionally, SDKs may have additional service-specific values that can be set on the Config
that
is absent from SdkConfig
, or slightly different settings for a specific client may be desired.
The Builder
struct implements From<&SdkConfig>
, so setting these specific settings can be
done as follows:
let sdk_config = ::aws_config::load_from_env().await;
let config = aws_sdk_finspace::config::Builder::from(&sdk_config)
.some_service_specific_setting("value")
.build();
See the aws-config
docs and Config
for more information on customizing configuration.
Note: Client construction is expensive due to connection thread pool initialization, and should be done once at application start-up.
§Using the Client
A client has a function for every operation that can be performed by the service.
For example, the CreateEnvironment
operation has
a Client::create_environment
, function which returns a builder for that operation.
The fluent builder ultimately has a send()
function that returns an async future that
returns a result, as illustrated below:
let result = client.create_environment()
.name("example")
.send()
.await;
The underlying HTTP requests that get made by this can be modified with the customize_operation
function on the fluent builder. See the customize
module for more
information.
Implementations§
Source§impl Client
impl Client
Sourcepub fn create_environment(&self) -> CreateEnvironmentFluentBuilder
👎Deprecated: This method will be discontinued.
pub fn create_environment(&self) -> CreateEnvironmentFluentBuilder
Constructs a fluent builder for the CreateEnvironment
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the FinSpace environment to be created.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the FinSpace environment to be created.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: falseThe KMS key id to encrypt your data in the FinSpace environment.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseAdd tags to your FinSpace environment.
federation_mode(FederationMode)
/set_federation_mode(Option<FederationMode>)
:
required: falseAuthentication mode for the environment.
-
FEDERATED
- Users access FinSpace through Single Sign On (SSO) via your Identity provider. -
LOCAL
- Users access FinSpace via email and password managed within the FinSpace environment.
-
federation_parameters(FederationParameters)
/set_federation_parameters(Option<FederationParameters>)
:
required: falseConfiguration information when authentication mode is FEDERATED.
superuser_parameters(SuperuserParameters)
/set_superuser_parameters(Option<SuperuserParameters>)
:
required: falseConfiguration information for the superuser.
data_bundles(impl Into<String>)
/set_data_bundles(Option<Vec::<String>>)
:
required: falseThe list of Amazon Resource Names (ARN) of the data bundles to install. Currently supported data bundle ARNs:
-
arn:aws:finspace:${Region}::data-bundle/capital-markets-sample
- Contains sample Capital Markets datasets, categories and controlled vocabularies. -
arn:aws:finspace:${Region}::data-bundle/taq
(default) - Contains trades and quotes data in addition to sample Capital Markets data.
-
- On success, responds with
CreateEnvironmentOutput
with field(s):environment_id(Option<String>)
:The unique identifier for FinSpace environment that you created.
environment_arn(Option<String>)
:The Amazon Resource Name (ARN) of the FinSpace environment that you created.
environment_url(Option<String>)
:The sign-in URL for the web application of the FinSpace environment you created.
- On failure, responds with
SdkError<CreateEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn create_kx_changeset(&self) -> CreateKxChangesetFluentBuilder
pub fn create_kx_changeset(&self) -> CreateKxChangesetFluentBuilder
Constructs a fluent builder for the CreateKxChangeset
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier of the kdb environment.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the kdb database.
change_requests(ChangeRequest)
/set_change_requests(Option<Vec::<ChangeRequest>>)
:
required: trueA list of change request objects that are run in order. A change request object consists of
changeType
,s3Path
, anddbPath
. A changeType can have the following values:-
PUT – Adds or updates files in a database.
-
DELETE – Deletes files in a database.
All the change requests require a mandatory
dbPath
attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. Thes3Path
attribute defines the s3 source file path and is required for a PUT change type. Thes3path
must end with a trailing / if it is a directory and must end without a trailing / if it is a file.Here are few examples of how you can use the change request object:
-
This request adds a single sym file at database root location.
{ “changeType”: “PUT”, “s3Path”:“s3://bucket/db/sym”, “dbPath”:“/”}
-
This request adds files in the given
s3Path
under the 2020.01.02 partition of the database.{ “changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/”, “dbPath”:“/2020.01.02/”}
-
This request adds files in the given
s3Path
under the taq table partition of the database.[ { “changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/taq/”, “dbPath”:“/2020.01.02/taq/”}]
-
This request deletes the 2020.01.02 partition of the database.
[{ “changeType”: “DELETE”, “dbPath”: “/2020.01.02/”} ]
-
The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.
[ {“changeType”: “DELETE”, “dbPath”:“/2020.01.02/”}, {“changeType”: “PUT”, “s3Path”:“s3://bucket/db/2020.01.02/taq/”, “dbPath”:“/2020.01.02/taq/”}]
-
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
CreateKxChangesetOutput
with field(s):changeset_id(Option<String>)
:A unique identifier for the changeset.
database_name(Option<String>)
:The name of the kdb database.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
change_requests(Option<Vec::<ChangeRequest>>)
:A list of change requests.
created_timestamp(Option<DateTime>)
:The timestamp at which the changeset 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 timestamp at which the changeset 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<ChangesetStatus>)
:Status of the changeset creation process.
-
Pending – Changeset creation is pending.
-
Processing – Changeset creation is running.
-
Failed – Changeset creation has failed.
-
Complete – Changeset creation has succeeded.
-
error_info(Option<ErrorInfo>)
:The details of the error that you receive when creating a changeset. It consists of the type of error and the error message.
- On failure, responds with
SdkError<CreateKxChangesetError>
Source§impl Client
impl Client
Sourcepub fn create_kx_cluster(&self) -> CreateKxClusterFluentBuilder
pub fn create_kx_cluster(&self) -> CreateKxClusterFluentBuilder
Constructs a fluent builder for the CreateKxCluster
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
cluster_name(impl Into<String>)
/set_cluster_name(Option<String>)
:
required: trueA unique name for the cluster that you want to create.
cluster_type(KxClusterType)
/set_cluster_type(Option<KxClusterType>)
:
required: trueSpecifies the type of KDB database that is being created. The following types are available:
-
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
-
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the
savedownStorageConfiguration
parameter. -
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
-
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only
SINGLE
AZ mode. -
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
-
tickerplant_log_configuration(TickerplantLogConfiguration)
/set_tickerplant_log_configuration(Option<TickerplantLogConfiguration>)
:
required: falseA configuration to store Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type
Tickerplant
, the location of the TP volume on the cluster will be available by using the global variable.aws.tp_log_path
.databases(KxDatabaseConfiguration)
/set_databases(Option<Vec::<KxDatabaseConfiguration>>)
:
required: falseA list of databases that will be available for querying.
cache_storage_configurations(KxCacheStorageConfiguration)
/set_cache_storage_configurations(Option<Vec::<KxCacheStorageConfiguration>>)
:
required: falseThe configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
auto_scaling_configuration(AutoScalingConfiguration)
/set_auto_scaling_configuration(Option<AutoScalingConfiguration>)
:
required: falseThe configuration based on which FinSpace will scale in or scale out nodes in your cluster.
cluster_description(impl Into<String>)
/set_cluster_description(Option<String>)
:
required: falseA description of the cluster.
capacity_configuration(CapacityConfiguration)
/set_capacity_configuration(Option<CapacityConfiguration>)
:
required: falseA structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
release_label(impl Into<String>)
/set_release_label(Option<String>)
:
required: trueThe version of FinSpace managed kdb to run.
vpc_configuration(VpcConfiguration)
/set_vpc_configuration(Option<VpcConfiguration>)
:
required: trueConfiguration details about the network where the Privatelink endpoint of the cluster resides.
initialization_script(impl Into<String>)
/set_initialization_script(Option<String>)
:
required: falseSpecifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example,
somedir/init.q
.command_line_arguments(KxCommandLineArgument)
/set_command_line_arguments(Option<Vec::<KxCommandLineArgument>>)
:
required: falseDefines the key-value pairs to make them available inside the cluster.
code(CodeConfiguration)
/set_code(Option<CodeConfiguration>)
:
required: falseThe details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
execution_role(impl Into<String>)
/set_execution_role(Option<String>)
:
required: falseAn IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
savedown_storage_configuration(KxSavedownStorageConfiguration)
/set_savedown_storage_configuration(Option<KxSavedownStorageConfiguration>)
:
required: falseThe size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose
clusterType
as RDB. All the data written to this storage space is lost when the cluster node is restarted.az_mode(KxAzMode)
/set_az_mode(Option<KxAzMode>)
:
required: trueThe 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(impl Into<String>)
/set_availability_zone_id(Option<String>)
:
required: falseThe availability zone identifiers for the requested regions.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pairs to label the cluster. You can add up to 50 tags to a cluster.
scaling_group_configuration(KxScalingGroupConfiguration)
/set_scaling_group_configuration(Option<KxScalingGroupConfiguration>)
:
required: falseThe structure that stores the configuration details of a scaling group.
- On success, responds with
CreateKxClusterOutput
with field(s):environment_id(Option<String>)
:A unique identifier for the kdb environment.
status(Option<KxClusterStatus>)
:The status of cluster creation.
-
PENDING – The cluster is pending creation.
-
CREATING – The cluster creation process is in progress.
-
CREATE_FAILED – The cluster creation process has failed.
-
RUNNING – The cluster creation process is running.
-
UPDATING – The cluster is in the process of being updated.
-
DELETING – The cluster is in the process of being deleted.
-
DELETED – The cluster has been deleted.
-
DELETE_FAILED – The cluster failed to delete.
-
status_reason(Option<String>)
:The error message when a failed state occurs.
cluster_name(Option<String>)
:A unique name for the cluster.
cluster_type(Option<KxClusterType>)
:Specifies the type of KDB database that is being created. The following types are available:
-
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
-
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the
savedownStorageConfiguration
parameter. -
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
-
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only
SINGLE
AZ mode. -
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
-
tickerplant_log_configuration(Option<TickerplantLogConfiguration>)
:A configuration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type
Tickerplant
, the location of the TP volume on the cluster will be available by using the global variable.aws.tp_log_path
.volumes(Option<Vec::<Volume>>)
:A list of volumes mounted on the cluster.
databases(Option<Vec::<KxDatabaseConfiguration>>)
:A list of databases that will be available for querying.
cache_storage_configurations(Option<Vec::<KxCacheStorageConfiguration>>)
:The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
auto_scaling_configuration(Option<AutoScalingConfiguration>)
:The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
cluster_description(Option<String>)
:A description of the cluster.
capacity_configuration(Option<CapacityConfiguration>)
:A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
release_label(Option<String>)
:A version of the FinSpace managed kdb to run.
vpc_configuration(Option<VpcConfiguration>)
:Configuration details about the network where the Privatelink endpoint of the cluster resides.
initialization_script(Option<String>)
:Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example,
somedir/init.q
.command_line_arguments(Option<Vec::<KxCommandLineArgument>>)
:Defines the key-value pairs to make them available inside the cluster.
code(Option<CodeConfiguration>)
:The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
execution_role(Option<String>)
:An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
last_modified_timestamp(Option<DateTime>)
:The last time that the cluster was modified. 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.
savedown_storage_configuration(Option<KxSavedownStorageConfiguration>)
:The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose
clusterType
as RDB. All the data written to this storage space is lost when the cluster node is restarted.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 availability zone identifiers for the requested regions.
created_timestamp(Option<DateTime>)
:The timestamp at which the cluster 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.
scaling_group_configuration(Option<KxScalingGroupConfiguration>)
:The structure that stores the configuration details of a scaling group.
- On failure, responds with
SdkError<CreateKxClusterError>
Source§impl Client
impl Client
Sourcepub fn create_kx_database(&self) -> CreateKxDatabaseFluentBuilder
pub fn create_kx_database(&self) -> CreateKxDatabaseFluentBuilder
Constructs a fluent builder for the CreateKxDatabase
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the kdb database.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the database.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pairs to label the kdb database. You can add up to 50 tags to your kdb database
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
CreateKxDatabaseOutput
with field(s):database_name(Option<String>)
:The name of the kdb database.
database_arn(Option<String>)
:The ARN identifier of the database.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
description(Option<String>)
:A description of the database.
created_timestamp(Option<DateTime>)
:The timestamp at which the database is 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 database 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.
- On failure, responds with
SdkError<CreateKxDatabaseError>
Source§impl Client
impl Client
Sourcepub fn create_kx_dataview(&self) -> CreateKxDataviewFluentBuilder
pub fn create_kx_dataview(&self) -> CreateKxDataviewFluentBuilder
Constructs a fluent builder for the CreateKxDataview
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, where you want to create the dataview.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where you want to create a dataview.
dataview_name(impl Into<String>)
/set_dataview_name(Option<String>)
:
required: trueA unique identifier for the dataview.
az_mode(KxAzMode)
/set_az_mode(Option<KxAzMode>)
:
required: trueThe 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(impl Into<String>)
/set_availability_zone_id(Option<String>)
:
required: falseThe identifier of the availability zones.
changeset_id(impl Into<String>)
/set_changeset_id(Option<String>)
:
required: falseA unique identifier of the changeset that you want to use to ingest data.
segment_configurations(KxDataviewSegmentConfiguration)
/set_segment_configurations(Option<Vec::<KxDataviewSegmentConfiguration>>)
:
required: falseThe 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(bool)
/set_auto_update(Option<bool>)
:
required: falseThe 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(bool)
/set_read_write(Option<bool>)
:
required: falseThe 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(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the dataview.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pairs to label the dataview. You can add up to 50 tags to a dataview.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
CreateKxDataviewOutput
with field(s):dataview_name(Option<String>)
:A unique identifier for the dataview.
database_name(Option<String>)
:The name of the database where you want to create a dataview.
environment_id(Option<String>)
:A unique identifier for the kdb environment, where you want to create 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 for the changeset.
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.
description(Option<String>)
:A description of the dataview.
auto_update(bool)
:The option to select 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(bool)
:Returns True if the dataview is created as writeable and False otherwise.
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.
-
- On failure, responds with
SdkError<CreateKxDataviewError>
Source§impl Client
impl Client
Sourcepub fn create_kx_environment(&self) -> CreateKxEnvironmentFluentBuilder
pub fn create_kx_environment(&self) -> CreateKxEnvironmentFluentBuilder
Constructs a fluent builder for the CreateKxEnvironment
operation.
- The fluent builder is configurable:
name(impl Into<String>)
/set_name(Option<String>)
:
required: trueThe name of the kdb environment that you want to create.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description for the kdb environment.
kms_key_id(impl Into<String>)
/set_kms_key_id(Option<String>)
:
required: trueThe KMS key ID to encrypt your data in the FinSpace environment.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pairs to label the kdb environment. You can add up to 50 tags to your kdb environment.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
CreateKxEnvironmentOutput
with field(s):name(Option<String>)
:The name of the kdb environment.
status(Option<EnvironmentStatus>)
:The status of the kdb environment.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
description(Option<String>)
:A description for the kdb environment.
environment_arn(Option<String>)
:The ARN identifier of the environment.
kms_key_id(Option<String>)
:The KMS key ID to encrypt your data in the FinSpace environment.
creation_timestamp(Option<DateTime>)
:The timestamp at which the kdb environment was created in FinSpace.
- On failure, responds with
SdkError<CreateKxEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn create_kx_scaling_group(&self) -> CreateKxScalingGroupFluentBuilder
pub fn create_kx_scaling_group(&self) -> CreateKxScalingGroupFluentBuilder
Constructs a fluent builder for the CreateKxScalingGroup
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA token that ensures idempotency. This token expires in 10 minutes.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, where you want to create the scaling group.
scaling_group_name(impl Into<String>)
/set_scaling_group_name(Option<String>)
:
required: trueA unique identifier for the kdb scaling group.
host_type(impl Into<String>)
/set_host_type(Option<String>)
:
required: trueThe memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
You can add one of the following values:
-
kx.sg.large
– The host type with a configuration of 16 GiB memory and 2 vCPUs. -
kx.sg.xlarge
– The host type with a configuration of 32 GiB memory and 4 vCPUs. -
kx.sg.2xlarge
– The host type with a configuration of 64 GiB memory and 8 vCPUs. -
kx.sg.4xlarge
– The host type with a configuration of 108 GiB memory and 16 vCPUs. -
kx.sg.8xlarge
– The host type with a configuration of 216 GiB memory and 32 vCPUs. -
kx.sg.16xlarge
– The host type with a configuration of 432 GiB memory and 64 vCPUs. -
kx.sg.32xlarge
– The host type with a configuration of 864 GiB memory and 128 vCPUs. -
kx.sg1.16xlarge
– The host type with a configuration of 1949 GiB memory and 64 vCPUs. -
kx.sg1.24xlarge
– The host type with a configuration of 2948 GiB memory and 96 vCPUs.
-
availability_zone_id(impl Into<String>)
/set_availability_zone_id(Option<String>)
:
required: trueThe identifier of the availability zones.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pairs to label the scaling group. You can add up to 50 tags to a scaling group.
- On success, responds with
CreateKxScalingGroupOutput
with field(s):environment_id(Option<String>)
:A unique identifier for the kdb environment, where you create the scaling group.
scaling_group_name(Option<String>)
:A unique identifier for the kdb scaling group.
host_type(Option<String>)
:The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
availability_zone_id(Option<String>)
:The identifier of the availability zones.
status(Option<KxScalingGroupStatus>)
:The status of scaling group.
-
CREATING – The scaling group creation is in progress.
-
CREATE_FAILED – The scaling group creation has failed.
-
ACTIVE – The scaling group is active.
-
UPDATING – The scaling group is in the process of being updated.
-
UPDATE_FAILED – The update action failed.
-
DELETING – The scaling group is in the process of being deleted.
-
DELETE_FAILED – The system failed to delete the scaling group.
-
DELETED – The scaling group is successfully deleted.
-
last_modified_timestamp(Option<DateTime>)
:The last time that the scaling group 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.
created_timestamp(Option<DateTime>)
:The timestamp at which the scaling group 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.
- On failure, responds with
SdkError<CreateKxScalingGroupError>
Source§impl Client
impl Client
Sourcepub fn create_kx_user(&self) -> CreateKxUserFluentBuilder
pub fn create_kx_user(&self) -> CreateKxUserFluentBuilder
Constructs a fluent builder for the CreateKxUser
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment where you want to create a user.
user_name(impl Into<String>)
/set_user_name(Option<String>)
:
required: trueA unique identifier for the user.
iam_role(impl Into<String>)
/set_iam_role(Option<String>)
:
required: trueThe IAM role ARN that will be associated with the user.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pairs to label the user. You can add up to 50 tags to a user.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
CreateKxUserOutput
with field(s):user_name(Option<String>)
:A unique identifier for the user.
user_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
iam_role(Option<String>)
:The IAM role ARN that will be associated with the user.
- On failure, responds with
SdkError<CreateKxUserError>
Source§impl Client
impl Client
Sourcepub fn create_kx_volume(&self) -> CreateKxVolumeFluentBuilder
pub fn create_kx_volume(&self) -> CreateKxVolumeFluentBuilder
Constructs a fluent builder for the CreateKxVolume
operation.
- The fluent builder is configurable:
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, whose clusters can attach to the volume.
volume_type(KxVolumeType)
/set_volume_type(Option<KxVolumeType>)
:
required: trueThe type of file system volume. Currently, FinSpace only supports
NAS_1
volume type. When you selectNAS_1
volume type, you must also providenas1Configuration
.volume_name(impl Into<String>)
/set_volume_name(Option<String>)
:
required: trueA unique identifier for the volume.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the volume.
nas1_configuration(KxNas1Configuration)
/set_nas1_configuration(Option<KxNas1Configuration>)
:
required: falseSpecifies the configuration for the Network attached storage (NAS_1) file system volume. This parameter is required when you choose
volumeType
as NAS_1.az_mode(KxAzMode)
/set_az_mode(Option<KxAzMode>)
:
required: trueThe 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_ids(impl Into<String>)
/set_availability_zone_ids(Option<Vec::<String>>)
:
required: trueThe identifier of the availability zones.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: falseA list of key-value pairs to label the volume. You can add up to 50 tags to a volume.
- On success, responds with
CreateKxVolumeOutput
with field(s):environment_id(Option<String>)
:A unique identifier for the kdb environment, whose clusters can attach to the volume.
volume_name(Option<String>)
:A unique identifier for the volume.
volume_type(Option<KxVolumeType>)
:The type of file system volume. Currently, FinSpace only supports
NAS_1
volume type.volume_arn(Option<String>)
:The ARN identifier of the volume.
nas1_configuration(Option<KxNas1Configuration>)
:Specifies the configuration for the Network attached storage (NAS_1) file system volume.
status(Option<KxVolumeStatus>)
:The status of volume creation.
-
CREATING – The volume creation is in progress.
-
CREATE_FAILED – The volume creation has failed.
-
ACTIVE – The volume is active.
-
UPDATING – The volume is in the process of being updated.
-
UPDATE_FAILED – The update action failed.
-
UPDATED – The volume is successfully updated.
-
DELETING – The volume is in the process of being deleted.
-
DELETE_FAILED – The system failed to delete the volume.
-
DELETED – The volume is successfully deleted.
-
status_reason(Option<String>)
:The error message when a failed state occurs.
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.description(Option<String>)
:A description of the volume.
availability_zone_ids(Option<Vec::<String>>)
:The identifier of the availability zones.
created_timestamp(Option<DateTime>)
:The timestamp at which the volume 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.
- On failure, responds with
SdkError<CreateKxVolumeError>
Source§impl Client
impl Client
Sourcepub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder
👎Deprecated: This method will be discontinued.
pub fn delete_environment(&self) -> DeleteEnvironmentFluentBuilder
Constructs a fluent builder for the DeleteEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe identifier for the FinSpace environment.
- On success, responds with
DeleteEnvironmentOutput
- On failure, responds with
SdkError<DeleteEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn delete_kx_cluster(&self) -> DeleteKxClusterFluentBuilder
pub fn delete_kx_cluster(&self) -> DeleteKxClusterFluentBuilder
Constructs a fluent builder for the DeleteKxCluster
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
cluster_name(impl Into<String>)
/set_cluster_name(Option<String>)
:
required: trueThe name of the cluster that you want to delete.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
DeleteKxClusterOutput
- On failure, responds with
SdkError<DeleteKxClusterError>
Source§impl Client
impl Client
Sourcepub fn delete_kx_cluster_node(&self) -> DeleteKxClusterNodeFluentBuilder
pub fn delete_kx_cluster_node(&self) -> DeleteKxClusterNodeFluentBuilder
Constructs a fluent builder for the DeleteKxClusterNode
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
cluster_name(impl Into<String>)
/set_cluster_name(Option<String>)
:
required: trueThe name of the cluster, for which you want to delete the nodes.
node_id(impl Into<String>)
/set_node_id(Option<String>)
:
required: trueA unique identifier for the node that you want to delete.
- On success, responds with
DeleteKxClusterNodeOutput
- On failure, responds with
SdkError<DeleteKxClusterNodeError>
Source§impl Client
impl Client
Sourcepub fn delete_kx_database(&self) -> DeleteKxDatabaseFluentBuilder
pub fn delete_kx_database(&self) -> DeleteKxDatabaseFluentBuilder
Constructs a fluent builder for the DeleteKxDatabase
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the kdb database that you want to delete.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
DeleteKxDatabaseOutput
- On failure, responds with
SdkError<DeleteKxDatabaseError>
Source§impl Client
impl Client
Sourcepub fn delete_kx_dataview(&self) -> DeleteKxDataviewFluentBuilder
pub fn delete_kx_dataview(&self) -> DeleteKxDataviewFluentBuilder
Constructs a fluent builder for the DeleteKxDataview
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, from where you want to delete the dataview.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database whose dataview you want to delete.
dataview_name(impl Into<String>)
/set_dataview_name(Option<String>)
:
required: trueThe name of the dataview that you want to delete.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
DeleteKxDataviewOutput
- On failure, responds with
SdkError<DeleteKxDataviewError>
Source§impl Client
impl Client
Sourcepub fn delete_kx_environment(&self) -> DeleteKxEnvironmentFluentBuilder
pub fn delete_kx_environment(&self) -> DeleteKxEnvironmentFluentBuilder
Constructs a fluent builder for the DeleteKxEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
DeleteKxEnvironmentOutput
- On failure, responds with
SdkError<DeleteKxEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn delete_kx_scaling_group(&self) -> DeleteKxScalingGroupFluentBuilder
pub fn delete_kx_scaling_group(&self) -> DeleteKxScalingGroupFluentBuilder
Constructs a fluent builder for the DeleteKxScalingGroup
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, from where you want to delete the dataview.
scaling_group_name(impl Into<String>)
/set_scaling_group_name(Option<String>)
:
required: trueA unique identifier for the kdb scaling group.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
DeleteKxScalingGroupOutput
- On failure, responds with
SdkError<DeleteKxScalingGroupError>
Source§impl Client
impl Client
Sourcepub fn delete_kx_user(&self) -> DeleteKxUserFluentBuilder
pub fn delete_kx_user(&self) -> DeleteKxUserFluentBuilder
Constructs a fluent builder for the DeleteKxUser
operation.
- The fluent builder is configurable:
user_name(impl Into<String>)
/set_user_name(Option<String>)
:
required: trueA unique identifier for the user that you want to delete.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
DeleteKxUserOutput
- On failure, responds with
SdkError<DeleteKxUserError>
Source§impl Client
impl Client
Sourcepub fn delete_kx_volume(&self) -> DeleteKxVolumeFluentBuilder
pub fn delete_kx_volume(&self) -> DeleteKxVolumeFluentBuilder
Constructs a fluent builder for the DeleteKxVolume
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, whose clusters can attach to the volume.
volume_name(impl Into<String>)
/set_volume_name(Option<String>)
:
required: trueThe name of the volume that you want to delete.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
DeleteKxVolumeOutput
- On failure, responds with
SdkError<DeleteKxVolumeError>
Source§impl Client
impl Client
Sourcepub fn get_environment(&self) -> GetEnvironmentFluentBuilder
👎Deprecated: This method will be discontinued.
pub fn get_environment(&self) -> GetEnvironmentFluentBuilder
Constructs a fluent builder for the GetEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe identifier of the FinSpace environment.
- On success, responds with
GetEnvironmentOutput
with field(s):environment(Option<Environment>)
:The name of the FinSpace environment.
- On failure, responds with
SdkError<GetEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn get_kx_changeset(&self) -> GetKxChangesetFluentBuilder
pub fn get_kx_changeset(&self) -> GetKxChangesetFluentBuilder
Constructs a fluent builder for the GetKxChangeset
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the kdb database.
changeset_id(impl Into<String>)
/set_changeset_id(Option<String>)
:
required: trueA unique identifier of the changeset for which you want to retrieve data.
- On success, responds with
GetKxChangesetOutput
with field(s):changeset_id(Option<String>)
:A unique identifier for the changeset.
database_name(Option<String>)
:The name of the kdb database.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
change_requests(Option<Vec::<ChangeRequest>>)
:A list of change request objects that are run in order.
created_timestamp(Option<DateTime>)
:The timestamp at which the changeset 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.
active_from_timestamp(Option<DateTime>)
:Beginning time from which the changeset is active. 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 timestamp at which the changeset 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<ChangesetStatus>)
:Status of the changeset creation process.
-
Pending – Changeset creation is pending.
-
Processing – Changeset creation is running.
-
Failed – Changeset creation has failed.
-
Complete – Changeset creation has succeeded.
-
error_info(Option<ErrorInfo>)
:Provides details in the event of a failed flow, including the error type and the related error message.
- On failure, responds with
SdkError<GetKxChangesetError>
Source§impl Client
impl Client
Sourcepub fn get_kx_cluster(&self) -> GetKxClusterFluentBuilder
pub fn get_kx_cluster(&self) -> GetKxClusterFluentBuilder
Constructs a fluent builder for the GetKxCluster
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
cluster_name(impl Into<String>)
/set_cluster_name(Option<String>)
:
required: trueThe name of the cluster that you want to retrieve.
- On success, responds with
GetKxClusterOutput
with field(s):status(Option<KxClusterStatus>)
:The status of cluster creation.
-
PENDING – The cluster is pending creation.
-
CREATING – The cluster creation process is in progress.
-
CREATE_FAILED – The cluster creation process has failed.
-
RUNNING – The cluster creation process is running.
-
UPDATING – The cluster is in the process of being updated.
-
DELETING – The cluster is in the process of being deleted.
-
DELETED – The cluster has been deleted.
-
DELETE_FAILED – The cluster failed to delete.
-
status_reason(Option<String>)
:The error message when a failed state occurs.
cluster_name(Option<String>)
:A unique name for the cluster.
cluster_type(Option<KxClusterType>)
:Specifies the type of KDB database that is being created. The following types are available:
-
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
-
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the
savedownStorageConfiguration
parameter. -
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
-
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only
SINGLE
AZ mode. -
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
-
tickerplant_log_configuration(Option<TickerplantLogConfiguration>)
:A configuration to store the Tickerplant logs. It consists of a list of volumes that will be mounted to your cluster. For the cluster type
Tickerplant
, the location of the TP volume on the cluster will be available by using the global variable.aws.tp_log_path
.volumes(Option<Vec::<Volume>>)
:A list of volumes attached to the cluster.
databases(Option<Vec::<KxDatabaseConfiguration>>)
:A list of databases mounted on the cluster.
cache_storage_configurations(Option<Vec::<KxCacheStorageConfiguration>>)
:The configurations for a read only cache storage associated with a cluster. This cache will be stored as an FSx Lustre that reads from the S3 store.
auto_scaling_configuration(Option<AutoScalingConfiguration>)
:The configuration based on which FinSpace will scale in or scale out nodes in your cluster.
cluster_description(Option<String>)
:A description of the cluster.
capacity_configuration(Option<CapacityConfiguration>)
:A structure for the metadata of a cluster. It includes information like the CPUs needed, memory of instances, and number of instances.
release_label(Option<String>)
:The version of FinSpace managed kdb to run.
vpc_configuration(Option<VpcConfiguration>)
:Configuration details about the network where the Privatelink endpoint of the cluster resides.
initialization_script(Option<String>)
:Specifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example,
somedir/init.q
.command_line_arguments(Option<Vec::<KxCommandLineArgument>>)
:Defines key-value pairs to make them available inside the cluster.
code(Option<CodeConfiguration>)
:The details of the custom code that you want to use inside a cluster when analyzing a data. It consists of the S3 source bucket, location, S3 object version, and the relative path from where the custom code is loaded into the cluster.
execution_role(Option<String>)
:An IAM role that defines a set of permissions associated with a cluster. These permissions are assumed when a cluster attempts to access another cluster.
last_modified_timestamp(Option<DateTime>)
:The last time that the cluster was modified. 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.
savedown_storage_configuration(Option<KxSavedownStorageConfiguration>)
:The size and type of the temporary storage that is used to hold data during the savedown process. This parameter is required when you choose
clusterType
as RDB. All the data written to this storage space is lost when the cluster node is restarted.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 availability zone identifiers for the requested regions.
created_timestamp(Option<DateTime>)
:The timestamp at which the cluster 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.
scaling_group_configuration(Option<KxScalingGroupConfiguration>)
:The structure that stores the capacity configuration details of a scaling group.
- On failure, responds with
SdkError<GetKxClusterError>
Source§impl Client
impl Client
Sourcepub fn get_kx_connection_string(&self) -> GetKxConnectionStringFluentBuilder
pub fn get_kx_connection_string(&self) -> GetKxConnectionStringFluentBuilder
Constructs a fluent builder for the GetKxConnectionString
operation.
- The fluent builder is configurable:
user_arn(impl Into<String>)
/set_user_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
cluster_name(impl Into<String>)
/set_cluster_name(Option<String>)
:
required: trueA name of the kdb cluster.
- On success, responds with
GetKxConnectionStringOutput
with field(s):signed_connection_string(Option<String>)
:The signed connection string that you can use to connect to clusters.
- On failure, responds with
SdkError<GetKxConnectionStringError>
Source§impl Client
impl Client
Sourcepub fn get_kx_database(&self) -> GetKxDatabaseFluentBuilder
pub fn get_kx_database(&self) -> GetKxDatabaseFluentBuilder
Constructs a fluent builder for the GetKxDatabase
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the kdb database.
- On success, responds with
GetKxDatabaseOutput
with field(s):database_name(Option<String>)
:The name of the kdb database for which the information is retrieved.
database_arn(Option<String>)
:The ARN identifier of the database.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
description(Option<String>)
:A description of the database.
created_timestamp(Option<DateTime>)
:The timestamp at which the database is 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 database was modified. 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_completed_changeset_id(Option<String>)
:A unique identifier for the changeset.
num_bytes(i64)
:The total number of bytes in the database.
num_changesets(i32)
:The total number of changesets in the database.
num_files(i32)
:The total number of files in the database.
- On failure, responds with
SdkError<GetKxDatabaseError>
Source§impl Client
impl Client
Sourcepub fn get_kx_dataview(&self) -> GetKxDataviewFluentBuilder
pub fn get_kx_dataview(&self) -> GetKxDataviewFluentBuilder
Constructs a fluent builder for the GetKxDataview
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, from where you want to retrieve the dataview details.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where you created the dataview.
dataview_name(impl Into<String>)
/set_dataview_name(Option<String>)
:
required: trueA unique identifier for the dataview.
- On success, responds with
GetKxDataviewOutput
with field(s):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 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.
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.
read_write(bool)
:Returns True if the dataview is created as writeable and False otherwise.
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.
- On failure, responds with
SdkError<GetKxDataviewError>
Source§impl Client
impl Client
Sourcepub fn get_kx_environment(&self) -> GetKxEnvironmentFluentBuilder
pub fn get_kx_environment(&self) -> GetKxEnvironmentFluentBuilder
Constructs a fluent builder for the GetKxEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
- On success, responds with
GetKxEnvironmentOutput
with field(s):name(Option<String>)
:The name of the kdb environment.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
aws_account_id(Option<String>)
:The unique identifier of the AWS account that is used to create the kdb environment.
status(Option<EnvironmentStatus>)
:The status of the kdb environment.
tgw_status(Option<TgwStatus>)
:The status of the network configuration.
dns_status(Option<DnsStatus>)
:The status of DNS configuration.
error_message(Option<String>)
:Specifies the error message that appears if a flow fails.
description(Option<String>)
:A description for the kdb environment.
environment_arn(Option<String>)
:The ARN identifier of the environment.
kms_key_id(Option<String>)
:The KMS key ID to encrypt your data in the FinSpace environment.
dedicated_service_account_id(Option<String>)
:A unique identifier for the AWS environment infrastructure account.
transit_gateway_configuration(Option<TransitGatewayConfiguration>)
:The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
custom_dns_configuration(Option<Vec::<CustomDnsServer>>)
:A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
creation_timestamp(Option<DateTime>)
:The timestamp at which the kdb environment was created in FinSpace.
update_timestamp(Option<DateTime>)
:The timestamp at which the kdb environment was updated.
availability_zone_ids(Option<Vec::<String>>)
:The identifier of the availability zones where subnets for the environment are created.
certificate_authority_arn(Option<String>)
:The Amazon Resource Name (ARN) of the certificate authority of the kdb environment.
- On failure, responds with
SdkError<GetKxEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn get_kx_scaling_group(&self) -> GetKxScalingGroupFluentBuilder
pub fn get_kx_scaling_group(&self) -> GetKxScalingGroupFluentBuilder
Constructs a fluent builder for the GetKxScalingGroup
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
scaling_group_name(impl Into<String>)
/set_scaling_group_name(Option<String>)
:
required: trueA unique identifier for the kdb scaling group.
- On success, responds with
GetKxScalingGroupOutput
with field(s):scaling_group_name(Option<String>)
:A unique identifier for the kdb scaling group.
scaling_group_arn(Option<String>)
:The ARN identifier for the scaling group.
host_type(Option<String>)
:The memory and CPU capabilities of the scaling group host on which FinSpace Managed kdb clusters will be placed.
It can have one of the following values:
-
kx.sg.large
– The host type with a configuration of 16 GiB memory and 2 vCPUs. -
kx.sg.xlarge
– The host type with a configuration of 32 GiB memory and 4 vCPUs. -
kx.sg.2xlarge
– The host type with a configuration of 64 GiB memory and 8 vCPUs. -
kx.sg.4xlarge
– The host type with a configuration of 108 GiB memory and 16 vCPUs. -
kx.sg.8xlarge
– The host type with a configuration of 216 GiB memory and 32 vCPUs. -
kx.sg.16xlarge
– The host type with a configuration of 432 GiB memory and 64 vCPUs. -
kx.sg.32xlarge
– The host type with a configuration of 864 GiB memory and 128 vCPUs. -
kx.sg1.16xlarge
– The host type with a configuration of 1949 GiB memory and 64 vCPUs. -
kx.sg1.24xlarge
– The host type with a configuration of 2948 GiB memory and 96 vCPUs.
-
clusters(Option<Vec::<String>>)
:The list of Managed kdb clusters that are currently active in the given scaling group.
availability_zone_id(Option<String>)
:The identifier of the availability zones.
status(Option<KxScalingGroupStatus>)
:The status of scaling group.
-
CREATING – The scaling group creation is in progress.
-
CREATE_FAILED – The scaling group creation has failed.
-
ACTIVE – The scaling group is active.
-
UPDATING – The scaling group is in the process of being updated.
-
UPDATE_FAILED – The update action failed.
-
DELETING – The scaling group is in the process of being deleted.
-
DELETE_FAILED – The system failed to delete the scaling group.
-
DELETED – The scaling group is successfully deleted.
-
status_reason(Option<String>)
:The error message when a failed state occurs.
last_modified_timestamp(Option<DateTime>)
:The last time that the scaling group 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.
created_timestamp(Option<DateTime>)
:The timestamp at which the scaling group 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.
- On failure, responds with
SdkError<GetKxScalingGroupError>
Source§impl Client
impl Client
Sourcepub fn get_kx_user(&self) -> GetKxUserFluentBuilder
pub fn get_kx_user(&self) -> GetKxUserFluentBuilder
Constructs a fluent builder for the GetKxUser
operation.
- The fluent builder is configurable:
user_name(impl Into<String>)
/set_user_name(Option<String>)
:
required: trueA unique identifier for the user.
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
- On success, responds with
GetKxUserOutput
with field(s):user_name(Option<String>)
:A unique identifier for the user.
user_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
iam_role(Option<String>)
:The IAM role ARN that is associated with the user.
- On failure, responds with
SdkError<GetKxUserError>
Source§impl Client
impl Client
Sourcepub fn get_kx_volume(&self) -> GetKxVolumeFluentBuilder
pub fn get_kx_volume(&self) -> GetKxVolumeFluentBuilder
Constructs a fluent builder for the GetKxVolume
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, whose clusters can attach to the volume.
volume_name(impl Into<String>)
/set_volume_name(Option<String>)
:
required: trueA unique identifier for the volume.
- On success, responds with
GetKxVolumeOutput
with field(s):environment_id(Option<String>)
:A unique identifier for the kdb environment, whose clusters can attach to the volume.
volume_name(Option<String>)
:A unique identifier for the volume.
volume_type(Option<KxVolumeType>)
:The type of file system volume. Currently, FinSpace only supports
NAS_1
volume type.volume_arn(Option<String>)
:The ARN identifier of the volume.
nas1_configuration(Option<KxNas1Configuration>)
:Specifies the configuration for the Network attached storage (NAS_1) file system volume.
status(Option<KxVolumeStatus>)
:The status of volume creation.
-
CREATING – The volume creation is in progress.
-
CREATE_FAILED – The volume creation has failed.
-
ACTIVE – The volume is active.
-
UPDATING – The volume is in the process of being updated.
-
UPDATE_FAILED – The update action failed.
-
UPDATED – The volume is successfully updated.
-
DELETING – The volume is in the process of being deleted.
-
DELETE_FAILED – The system failed to delete the volume.
-
DELETED – The volume is successfully deleted.
-
status_reason(Option<String>)
:The error message when a failed state occurs.
created_timestamp(Option<DateTime>)
:The timestamp at which the volume 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.
description(Option<String>)
:A description of the volume.
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_ids(Option<Vec::<String>>)
:The identifier of the availability zones.
last_modified_timestamp(Option<DateTime>)
:The last time that the volume 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.
attached_clusters(Option<Vec::<KxAttachedCluster>>)
:A list of cluster identifiers that a volume is attached to.
- On failure, responds with
SdkError<GetKxVolumeError>
Source§impl Client
impl Client
Sourcepub fn list_environments(&self) -> ListEnvironmentsFluentBuilder
👎Deprecated: This method will be discontinued.
pub fn list_environments(&self) -> ListEnvironmentsFluentBuilder
Constructs a fluent builder for the ListEnvironments
operation.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token generated by FinSpace that specifies where to continue pagination if a previous request was truncated. To get the next set of pages, pass in the
nextToken
nextToken value from the response object of the previous page call.max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
- On success, responds with
ListEnvironmentsOutput
with field(s):environments(Option<Vec::<Environment>>)
:A list of all of your FinSpace environments.
next_token(Option<String>)
:A token that you can use in a subsequent call to retrieve the next set of results.
- On failure, responds with
SdkError<ListEnvironmentsError>
Source§impl Client
impl Client
Sourcepub fn list_kx_changesets(&self) -> ListKxChangesetsFluentBuilder
pub fn list_kx_changesets(&self) -> ListKxChangesetsFluentBuilder
Constructs a fluent builder for the ListKxChangesets
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the kdb database.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
- On success, responds with
ListKxChangesetsOutput
with field(s):kx_changesets(Option<Vec::<KxChangesetListEntry>>)
:A list of changesets for a database.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxChangesetsError>
Source§impl Client
impl Client
Sourcepub fn list_kx_cluster_nodes(&self) -> ListKxClusterNodesFluentBuilder
pub fn list_kx_cluster_nodes(&self) -> ListKxClusterNodesFluentBuilder
Constructs a fluent builder for the ListKxClusterNodes
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
cluster_name(impl Into<String>)
/set_cluster_name(Option<String>)
:
required: trueA unique name for the cluster.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
- On success, responds with
ListKxClusterNodesOutput
with field(s):nodes(Option<Vec::<KxNode>>)
:A list of nodes associated with the cluster.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxClusterNodesError>
Source§impl Client
impl Client
Sourcepub fn list_kx_clusters(&self) -> ListKxClustersFluentBuilder
pub fn list_kx_clusters(&self) -> ListKxClustersFluentBuilder
Constructs a fluent builder for the ListKxClusters
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
cluster_type(KxClusterType)
/set_cluster_type(Option<KxClusterType>)
:
required: falseSpecifies the type of KDB database that is being created. The following types are available:
-
HDB – A Historical Database. The data is only accessible with read-only permissions from one of the FinSpace managed kdb databases mounted to the cluster.
-
RDB – A Realtime Database. This type of database captures all the data from a ticker plant and stores it in memory until the end of day, after which it writes all of its data to a disk and reloads the HDB. This cluster type requires local storage for temporary storage of data during the savedown process. If you specify this field in your request, you must provide the
savedownStorageConfiguration
parameter. -
GATEWAY – A gateway cluster allows you to access data across processes in kdb systems. It allows you to create your own routing logic using the initialization scripts and custom code. This type of cluster does not require a writable local storage.
-
GP – A general purpose cluster allows you to quickly iterate on code during development by granting greater access to system commands and enabling a fast reload of custom code. This cluster type can optionally mount databases including cache and savedown storage. For this cluster type, the node count is fixed at 1. It does not support autoscaling and supports only
SINGLE
AZ mode. -
Tickerplant – A tickerplant cluster allows you to subscribe to feed handlers based on IAM permissions. It can publish to RDBs, other Tickerplants, and real-time subscribers (RTS). Tickerplants can persist messages to log, which is readable by any RDB environment. It supports only single-node that is only one kdb process.
-
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
- On success, responds with
ListKxClustersOutput
with field(s):kx_cluster_summaries(Option<Vec::<KxCluster>>)
:Lists the cluster details.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxClustersError>
Source§impl Client
impl Client
Sourcepub fn list_kx_databases(&self) -> ListKxDatabasesFluentBuilder
pub fn list_kx_databases(&self) -> ListKxDatabasesFluentBuilder
Constructs a fluent builder for the ListKxDatabases
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
- On success, responds with
ListKxDatabasesOutput
with field(s):kx_databases(Option<Vec::<KxDatabaseListEntry>>)
:A list of databases in the kdb environment.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxDatabasesError>
Source§impl Client
impl Client
Sourcepub fn list_kx_dataviews(&self) -> ListKxDataviewsFluentBuilder
pub fn list_kx_dataviews(&self) -> ListKxDataviewsFluentBuilder
Constructs a fluent builder for the ListKxDataviews
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, for which you want to retrieve a list of dataviews.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database where the dataviews were created.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
- On success, responds with
ListKxDataviewsOutput
with field(s):kx_dataviews(Option<Vec::<KxDataviewListEntry>>)
:The list of kdb dataviews that are currently active for the given database.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxDataviewsError>
Source§impl Client
impl Client
Sourcepub fn list_kx_environments(&self) -> ListKxEnvironmentsFluentBuilder
pub fn list_kx_environments(&self) -> ListKxEnvironmentsFluentBuilder
Constructs a fluent builder for the ListKxEnvironments
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
- On success, responds with
ListKxEnvironmentsOutput
with field(s):environments(Option<Vec::<KxEnvironment>>)
:A list of environments in an account.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxEnvironmentsError>
Source§impl Client
impl Client
Sourcepub fn list_kx_scaling_groups(&self) -> ListKxScalingGroupsFluentBuilder
pub fn list_kx_scaling_groups(&self) -> ListKxScalingGroupsFluentBuilder
Constructs a fluent builder for the ListKxScalingGroups
operation.
This operation supports pagination; See into_paginator()
.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, for which you want to retrieve a list of scaling groups.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
- On success, responds with
ListKxScalingGroupsOutput
with field(s):scaling_groups(Option<Vec::<KxScalingGroup>>)
:A list of scaling groups available in a kdb environment.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxScalingGroupsError>
Source§impl Client
impl Client
Sourcepub fn list_kx_users(&self) -> ListKxUsersFluentBuilder
pub fn list_kx_users(&self) -> ListKxUsersFluentBuilder
Constructs a fluent builder for the ListKxUsers
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
- On success, responds with
ListKxUsersOutput
with field(s):users(Option<Vec::<KxUser>>)
:A list of users in a kdb environment.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxUsersError>
Source§impl Client
impl Client
Sourcepub fn list_kx_volumes(&self) -> ListKxVolumesFluentBuilder
pub fn list_kx_volumes(&self) -> ListKxVolumesFluentBuilder
Constructs a fluent builder for the ListKxVolumes
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, whose clusters can attach to the volume.
max_results(i32)
/set_max_results(Option<i32>)
:
required: falseThe maximum number of results to return in this request.
next_token(impl Into<String>)
/set_next_token(Option<String>)
:
required: falseA token that indicates where a results page should begin.
volume_type(KxVolumeType)
/set_volume_type(Option<KxVolumeType>)
:
required: falseThe type of file system volume. Currently, FinSpace only supports
NAS_1
volume type.
- On success, responds with
ListKxVolumesOutput
with field(s):kx_volume_summaries(Option<Vec::<KxVolume>>)
:A summary of volumes.
next_token(Option<String>)
:A token that indicates where a results page should begin.
- On failure, responds with
SdkError<ListKxVolumesError>
Source§impl Client
impl Client
Constructs a fluent builder for the ListTagsForResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name of the resource.
- On success, responds with
ListTagsForResourceOutput
with field(s):tags(Option<HashMap::<String, String>>)
:A list of all tags for a resource.
- On failure, responds with
SdkError<ListTagsForResourceError>
Source§impl Client
impl Client
Sourcepub fn tag_resource(&self) -> TagResourceFluentBuilder
pub fn tag_resource(&self) -> TagResourceFluentBuilder
Constructs a fluent builder for the TagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueThe Amazon Resource Name (ARN) for the resource.
tags(impl Into<String>, impl Into<String>)
/set_tags(Option<HashMap::<String, String>>)
:
required: trueOne or more tags to be assigned to the resource.
- On success, responds with
TagResourceOutput
- On failure, responds with
SdkError<TagResourceError>
Source§impl Client
impl Client
Sourcepub fn untag_resource(&self) -> UntagResourceFluentBuilder
pub fn untag_resource(&self) -> UntagResourceFluentBuilder
Constructs a fluent builder for the UntagResource
operation.
- The fluent builder is configurable:
resource_arn(impl Into<String>)
/set_resource_arn(Option<String>)
:
required: trueA FinSpace resource from which you want to remove a tag or tags. The value for this parameter is an Amazon Resource Name (ARN).
tag_keys(impl Into<String>)
/set_tag_keys(Option<Vec::<String>>)
:
required: trueThe tag keys (names) of one or more tags to be removed.
- On success, responds with
UntagResourceOutput
- On failure, responds with
SdkError<UntagResourceError>
Source§impl Client
impl Client
Sourcepub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder
👎Deprecated: This method will be discontinued.
pub fn update_environment(&self) -> UpdateEnvironmentFluentBuilder
Constructs a fluent builder for the UpdateEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe identifier of the FinSpace environment.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the environment.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description of the environment.
federation_mode(FederationMode)
/set_federation_mode(Option<FederationMode>)
:
required: falseAuthentication mode for the environment.
-
FEDERATED
- Users access FinSpace through Single Sign On (SSO) via your Identity provider. -
LOCAL
- Users access FinSpace via email and password managed within the FinSpace environment.
-
federation_parameters(FederationParameters)
/set_federation_parameters(Option<FederationParameters>)
:
required: falseConfiguration information when authentication mode is FEDERATED.
- On success, responds with
UpdateEnvironmentOutput
with field(s):environment(Option<Environment>)
:Returns the FinSpace environment object.
- On failure, responds with
SdkError<UpdateEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn update_kx_cluster_code_configuration(
&self,
) -> UpdateKxClusterCodeConfigurationFluentBuilder
pub fn update_kx_cluster_code_configuration( &self, ) -> UpdateKxClusterCodeConfigurationFluentBuilder
Constructs a fluent builder for the UpdateKxClusterCodeConfiguration
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier of the kdb environment.
cluster_name(impl Into<String>)
/set_cluster_name(Option<String>)
:
required: trueThe name of the cluster.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
code(CodeConfiguration)
/set_code(Option<CodeConfiguration>)
:
required: trueThe structure of the customer code available within the running cluster.
initialization_script(impl Into<String>)
/set_initialization_script(Option<String>)
:
required: falseSpecifies a Q program that will be run at launch of a cluster. It is a relative path within .zip file that contains the custom code, which will be loaded on the cluster. It must include the file name itself. For example,
somedir/init.q
.You cannot update this parameter for a
NO_RESTART
deployment.command_line_arguments(KxCommandLineArgument)
/set_command_line_arguments(Option<Vec::<KxCommandLineArgument>>)
:
required: falseSpecifies the key-value pairs to make them available inside the cluster.
You cannot update this parameter for a
NO_RESTART
deployment.deployment_configuration(KxClusterCodeDeploymentConfiguration)
/set_deployment_configuration(Option<KxClusterCodeDeploymentConfiguration>)
:
required: falseThe configuration that allows you to choose how you want to update the code on a cluster.
- On success, responds with
UpdateKxClusterCodeConfigurationOutput
- On failure, responds with
SdkError<UpdateKxClusterCodeConfigurationError>
Source§impl Client
impl Client
Sourcepub fn update_kx_cluster_databases(
&self,
) -> UpdateKxClusterDatabasesFluentBuilder
pub fn update_kx_cluster_databases( &self, ) -> UpdateKxClusterDatabasesFluentBuilder
Constructs a fluent builder for the UpdateKxClusterDatabases
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueThe unique identifier of a kdb environment.
cluster_name(impl Into<String>)
/set_cluster_name(Option<String>)
:
required: trueA unique name for the cluster that you want to modify.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
databases(KxDatabaseConfiguration)
/set_databases(Option<Vec::<KxDatabaseConfiguration>>)
:
required: trueThe structure of databases mounted on the cluster.
deployment_configuration(KxDeploymentConfiguration)
/set_deployment_configuration(Option<KxDeploymentConfiguration>)
:
required: falseThe configuration that allows you to choose how you want to update the databases on a cluster.
- On success, responds with
UpdateKxClusterDatabasesOutput
- On failure, responds with
SdkError<UpdateKxClusterDatabasesError>
Source§impl Client
impl Client
Sourcepub fn update_kx_database(&self) -> UpdateKxDatabaseFluentBuilder
pub fn update_kx_database(&self) -> UpdateKxDatabaseFluentBuilder
Constructs a fluent builder for the UpdateKxDatabase
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the kdb database.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the database.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
UpdateKxDatabaseOutput
with field(s):database_name(Option<String>)
:The name of the kdb database.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
description(Option<String>)
:A description of the database.
last_modified_timestamp(Option<DateTime>)
:The last time that the database was modified. 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.
- On failure, responds with
SdkError<UpdateKxDatabaseError>
Source§impl Client
impl Client
Sourcepub fn update_kx_dataview(&self) -> UpdateKxDataviewFluentBuilder
pub fn update_kx_dataview(&self) -> UpdateKxDataviewFluentBuilder
Constructs a fluent builder for the UpdateKxDataview
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment, where you want to update the dataview.
database_name(impl Into<String>)
/set_database_name(Option<String>)
:
required: trueThe name of the database.
dataview_name(impl Into<String>)
/set_dataview_name(Option<String>)
:
required: trueThe name of the dataview that you want to update.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseThe description for a dataview.
changeset_id(impl Into<String>)
/set_changeset_id(Option<String>)
:
required: falseA unique identifier for the changeset.
segment_configurations(KxDataviewSegmentConfiguration)
/set_segment_configurations(Option<Vec::<KxDataviewSegmentConfiguration>>)
:
required: falseThe 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.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: trueA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
UpdateKxDataviewOutput
with field(s):environment_id(Option<String>)
:A unique identifier for the kdb environment, where you want to update the dataview.
database_name(Option<String>)
:The name of the database.
dataview_name(Option<String>)
:The name of the database under which the dataview was created.
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 for the changeset.
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.
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.
-
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.
read_write(bool)
:Returns True if the dataview is created as writeable and False otherwise.
description(Option<String>)
:A description of the dataview.
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.
- On failure, responds with
SdkError<UpdateKxDataviewError>
Source§impl Client
impl Client
Sourcepub fn update_kx_environment(&self) -> UpdateKxEnvironmentFluentBuilder
pub fn update_kx_environment(&self) -> UpdateKxEnvironmentFluentBuilder
Constructs a fluent builder for the UpdateKxEnvironment
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
name(impl Into<String>)
/set_name(Option<String>)
:
required: falseThe name of the kdb environment.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the kdb environment.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
UpdateKxEnvironmentOutput
with field(s):name(Option<String>)
:The name of the kdb environment.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
aws_account_id(Option<String>)
:The unique identifier of the AWS account that is used to create the kdb environment.
status(Option<EnvironmentStatus>)
:The status of the kdb environment.
tgw_status(Option<TgwStatus>)
:The status of the network configuration.
dns_status(Option<DnsStatus>)
:The status of DNS configuration.
error_message(Option<String>)
:Specifies the error message that appears if a flow fails.
description(Option<String>)
:The description of the environment.
environment_arn(Option<String>)
:The ARN identifier of the environment.
kms_key_id(Option<String>)
:The KMS key ID to encrypt your data in the FinSpace environment.
dedicated_service_account_id(Option<String>)
:A unique identifier for the AWS environment infrastructure account.
transit_gateway_configuration(Option<TransitGatewayConfiguration>)
:The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
custom_dns_configuration(Option<Vec::<CustomDnsServer>>)
:A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
creation_timestamp(Option<DateTime>)
:The timestamp at which the kdb environment was created in FinSpace.
update_timestamp(Option<DateTime>)
:The timestamp at which the kdb environment was updated.
availability_zone_ids(Option<Vec::<String>>)
:The identifier of the availability zones where subnets for the environment are created.
- On failure, responds with
SdkError<UpdateKxEnvironmentError>
Source§impl Client
impl Client
Sourcepub fn update_kx_environment_network(
&self,
) -> UpdateKxEnvironmentNetworkFluentBuilder
pub fn update_kx_environment_network( &self, ) -> UpdateKxEnvironmentNetworkFluentBuilder
Constructs a fluent builder for the UpdateKxEnvironmentNetwork
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
transit_gateway_configuration(TransitGatewayConfiguration)
/set_transit_gateway_configuration(Option<TransitGatewayConfiguration>)
:
required: falseSpecifies the transit gateway and network configuration to connect the kdb environment to an internal network.
custom_dns_configuration(CustomDnsServer)
/set_custom_dns_configuration(Option<Vec::<CustomDnsServer>>)
:
required: falseA list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
UpdateKxEnvironmentNetworkOutput
with field(s):name(Option<String>)
:The name of the kdb environment.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
aws_account_id(Option<String>)
:The unique identifier of the AWS account that is used to create the kdb environment.
status(Option<EnvironmentStatus>)
:The status of the kdb environment.
tgw_status(Option<TgwStatus>)
:The status of the network configuration.
dns_status(Option<DnsStatus>)
:The status of DNS configuration.
error_message(Option<String>)
:Specifies the error message that appears if a flow fails.
description(Option<String>)
:The description of the environment.
environment_arn(Option<String>)
:The ARN identifier of the environment.
kms_key_id(Option<String>)
:The KMS key ID to encrypt your data in the FinSpace environment.
dedicated_service_account_id(Option<String>)
:A unique identifier for the AWS environment infrastructure account.
transit_gateway_configuration(Option<TransitGatewayConfiguration>)
:The structure of the transit gateway and network configuration that is used to connect the kdb environment to an internal network.
custom_dns_configuration(Option<Vec::<CustomDnsServer>>)
:A list of DNS server name and server IP. This is used to set up Route-53 outbound resolvers.
creation_timestamp(Option<DateTime>)
:The timestamp at which the kdb environment was created in FinSpace.
update_timestamp(Option<DateTime>)
:The timestamp at which the kdb environment was updated.
availability_zone_ids(Option<Vec::<String>>)
:The identifier of the availability zones where subnets for the environment are created.
- On failure, responds with
SdkError<UpdateKxEnvironmentNetworkError>
Source§impl Client
impl Client
Sourcepub fn update_kx_user(&self) -> UpdateKxUserFluentBuilder
pub fn update_kx_user(&self) -> UpdateKxUserFluentBuilder
Constructs a fluent builder for the UpdateKxUser
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment.
user_name(impl Into<String>)
/set_user_name(Option<String>)
:
required: trueA unique identifier for the user.
iam_role(impl Into<String>)
/set_iam_role(Option<String>)
:
required: trueThe IAM role ARN that is associated with the user.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
- On success, responds with
UpdateKxUserOutput
with field(s):user_name(Option<String>)
:A unique identifier for the user.
user_arn(Option<String>)
:The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
environment_id(Option<String>)
:A unique identifier for the kdb environment.
iam_role(Option<String>)
:The IAM role ARN that is associated with the user.
- On failure, responds with
SdkError<UpdateKxUserError>
Source§impl Client
impl Client
Sourcepub fn update_kx_volume(&self) -> UpdateKxVolumeFluentBuilder
pub fn update_kx_volume(&self) -> UpdateKxVolumeFluentBuilder
Constructs a fluent builder for the UpdateKxVolume
operation.
- The fluent builder is configurable:
environment_id(impl Into<String>)
/set_environment_id(Option<String>)
:
required: trueA unique identifier for the kdb environment where you created the storage volume.
volume_name(impl Into<String>)
/set_volume_name(Option<String>)
:
required: trueA unique identifier for the volume.
description(impl Into<String>)
/set_description(Option<String>)
:
required: falseA description of the volume.
client_token(impl Into<String>)
/set_client_token(Option<String>)
:
required: falseA token that ensures idempotency. This token expires in 10 minutes.
nas1_configuration(KxNas1Configuration)
/set_nas1_configuration(Option<KxNas1Configuration>)
:
required: falseSpecifies the configuration for the Network attached storage (NAS_1) file system volume.
- On success, responds with
UpdateKxVolumeOutput
with field(s):environment_id(Option<String>)
:A unique identifier for the kdb environment where you want to update the volume.
volume_name(Option<String>)
:A unique identifier for the volume that you want to update.
volume_type(Option<KxVolumeType>)
:The type of file system volume. Currently, FinSpace only supports
NAS_1
volume type.volume_arn(Option<String>)
:The ARN identifier of the volume.
nas1_configuration(Option<KxNas1Configuration>)
:Specifies the configuration for the Network attached storage (NAS_1) file system volume.
status(Option<KxVolumeStatus>)
:The status of the volume.
-
CREATING – The volume creation is in progress.
-
CREATE_FAILED – The volume creation has failed.
-
ACTIVE – The volume is active.
-
UPDATING – The volume is in the process of being updated.
-
UPDATE_FAILED – The update action failed.
-
UPDATED – The volume is successfully updated.
-
DELETING – The volume is in the process of being deleted.
-
DELETE_FAILED – The system failed to delete the volume.
-
DELETED – The volume is successfully deleted.
-
description(Option<String>)
:The description for the volume.
status_reason(Option<String>)
:The error message when a failed state occurs.
created_timestamp(Option<DateTime>)
:The timestamp at which the volume 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.
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_ids(Option<Vec::<String>>)
:The identifier of the availability zones.
last_modified_timestamp(Option<DateTime>)
:The last time that the volume 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.
attached_clusters(Option<Vec::<KxAttachedCluster>>)
:Specifies the clusters that a volume is attached to.
- On failure, responds with
SdkError<UpdateKxVolumeError>
Source§impl Client
impl Client
Sourcepub fn from_conf(conf: Config) -> Self
pub fn from_conf(conf: Config) -> Self
Creates a new client from the service Config
.
§Panics
This method will panic in the following cases:
- Retries or timeouts are enabled without a
sleep_impl
configured. - Identity caching is enabled without a
sleep_impl
andtime_source
configured. - No
behavior_version
is provided.
The panic message for each of these will have instructions on how to resolve them.
Source§impl Client
impl Client
Sourcepub fn new(sdk_config: &SdkConfig) -> Self
pub fn new(sdk_config: &SdkConfig) -> Self
Creates a new client from an SDK Config.
§Panics
- This method will panic if the
sdk_config
is missing an async sleep implementation. If you experience this panic, set thesleep_impl
on the Config passed into this function to fix it. - This method will panic if the
sdk_config
is missing an HTTP connector. If you experience this panic, set thehttp_connector
on the Config passed into this function to fix it. - This method will panic if no
BehaviorVersion
is provided. If you experience this panic, setbehavior_version
on the Config or enable thebehavior-version-latest
Cargo feature.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for Client
impl !RefUnwindSafe for Client
impl Send for Client
impl Sync for Client
impl Unpin for Client
impl !UnwindSafe for Client
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);