Struct CreateChangesetInput 

#[non_exhaustive]
pub struct CreateChangesetInput {
    pub client_token: Option<String>,
    pub dataset_id: Option<String>,
    pub change_type: Option<ChangeType>,
    pub source_params: Option<HashMap<String, String>>,
    pub format_params: Option<HashMap<String, String>>,
}

The request for a CreateChangeset operation.

Fields (Non-exhaustive)

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

client_token: Option<String>

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

dataset_id: Option<String>

The unique identifier for the FinSpace Dataset where the Changeset will be created.

change_type: Option<ChangeType>

The option to indicate how a Changeset will be applied to a Dataset.

• REPLACE – Changeset will be considered as a replacement to all prior loaded Changesets.

• APPEND – Changeset will be considered as an addition to the end of all prior loaded Changesets.

• MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

source_params: Option<HashMap<String, String>>

Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

Both s3SourcePath and sourceType are required attributes.

Here is an example of how you could specify the sourceParams:

"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }

The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.

format_params: Option<HashMap<String, String>>

Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).

formatType is a required attribute and can have the following values:

• PARQUET – Parquet source file format.

• CSV – CSV source file format.

• JSON – JSON source file format.

• XML – XML source file format.

Here is an example of how you could specify the formatParams:

"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

{ "withHeader": "true", "separator": "," }

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

Implementations

impl CreateChangesetInput

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

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

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

The unique identifier for the FinSpace Dataset where the Changeset will be created.

pub fn change_type(&self) -> Option<&ChangeType>

The option to indicate how a Changeset will be applied to a Dataset.

• REPLACE – Changeset will be considered as a replacement to all prior loaded Changesets.

• APPEND – Changeset will be considered as an addition to the end of all prior loaded Changesets.

• MODIFY – Changeset is considered as a replacement to a specific prior ingested Changeset.

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

Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

Both s3SourcePath and sourceType are required attributes.

Here is an example of how you could specify the sourceParams:

"sourceParams": { "s3SourcePath": "s3://finspace-landing-us-east-2-bk7gcfvitndqa6ebnvys4d/scratch/wr5hh8pwkpqqkxa4sxrmcw/ingestion/equity.csv", "sourceType": "S3" }

The S3 path that you specify must allow the FinSpace role access. To do that, you first need to configure the IAM policy on S3 bucket. For more information, see Loading data from an Amazon S3 Bucket using the FinSpace API section.

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

Options that define the structure of the source file(s) including the format type (formatType), header row (withHeader), data separation character (separator) and the type of compression (compression).

formatType is a required attribute and can have the following values:

• PARQUET – Parquet source file format.

• CSV – CSV source file format.

• JSON – JSON source file format.

• XML – XML source file format.

Here is an example of how you could specify the formatParams:

"formatParams": { "formatType": "CSV", "withHeader": "true", "separator": ",", "compression":"None" }

Note that if you only provide formatType as CSV, the rest of the attributes will automatically default to CSV values as following:

{ "withHeader": "true", "separator": "," }

For more information about supported file formats, see Supported Data Types and File Formats in the FinSpace User Guide.

impl CreateChangesetInput

pub fn builder() -> CreateChangesetInputBuilder

Creates a new builder-style object to manufacture CreateChangesetInput.

Trait Implementations

impl Clone for CreateChangesetInput

fn clone(&self) -> CreateChangesetInput

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CreateChangesetInput

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

Formats the value using the given formatter.

impl PartialEq for CreateChangesetInput

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

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

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

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

impl StructuralPartialEq for CreateChangesetInput