/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include namespace Aws { namespace FinSpaceData { namespace Model { /** * The request for a CreateChangeset operation.

*/ class CreateChangesetRequest : public FinSpaceDataRequest { public: AWS_FINSPACEDATA_API CreateChangesetRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "CreateChangeset"; } AWS_FINSPACEDATA_API Aws::String SerializePayload() const override; /** *

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

*/ inline const Aws::String& GetClientToken() const{ return m_clientToken; } /** *

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

*/ inline bool ClientTokenHasBeenSet() const { return m_clientTokenHasBeenSet; } /** *

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

*/ inline void SetClientToken(const Aws::String& value) { m_clientTokenHasBeenSet = true; m_clientToken = value; } /** *

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

*/ inline void SetClientToken(Aws::String&& value) { m_clientTokenHasBeenSet = true; m_clientToken = std::move(value); } /** *

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

*/ inline void SetClientToken(const char* value) { m_clientTokenHasBeenSet = true; m_clientToken.assign(value); } /** *

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

*/ inline CreateChangesetRequest& WithClientToken(const Aws::String& value) { SetClientToken(value); return *this;} /** *

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

*/ inline CreateChangesetRequest& WithClientToken(Aws::String&& value) { SetClientToken(std::move(value)); return *this;} /** *

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

*/ inline CreateChangesetRequest& WithClientToken(const char* value) { SetClientToken(value); return *this;} /** *

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

*/ inline const Aws::String& GetDatasetId() const{ return m_datasetId; } /** *

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

*/ inline bool DatasetIdHasBeenSet() const { return m_datasetIdHasBeenSet; } /** *

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

*/ inline void SetDatasetId(const Aws::String& value) { m_datasetIdHasBeenSet = true; m_datasetId = value; } /** *

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

*/ inline void SetDatasetId(Aws::String&& value) { m_datasetIdHasBeenSet = true; m_datasetId = std::move(value); } /** *

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

*/ inline void SetDatasetId(const char* value) { m_datasetIdHasBeenSet = true; m_datasetId.assign(value); } /** *

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

*/ inline CreateChangesetRequest& WithDatasetId(const Aws::String& value) { SetDatasetId(value); return *this;} /** *

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

*/ inline CreateChangesetRequest& WithDatasetId(Aws::String&& value) { SetDatasetId(std::move(value)); return *this;} /** *

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

*/ inline CreateChangesetRequest& WithDatasetId(const char* value) { SetDatasetId(value); return *this;} /** *

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.

*/ inline const ChangeType& GetChangeType() const{ return m_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.

*/ inline bool ChangeTypeHasBeenSet() const { return m_changeTypeHasBeenSet; } /** *

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.

*/ inline void SetChangeType(const ChangeType& value) { m_changeTypeHasBeenSet = true; m_changeType = value; } /** *

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.

*/ inline void SetChangeType(ChangeType&& value) { m_changeTypeHasBeenSet = true; m_changeType = std::move(value); } /** *

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.

*/ inline CreateChangesetRequest& WithChangeType(const ChangeType& value) { SetChangeType(value); return *this;} /** *

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.

*/ inline CreateChangesetRequest& WithChangeType(ChangeType&& value) { SetChangeType(std::move(value)); return *this;} /** *

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.

*/ inline const Aws::Map& GetSourceParams() const{ return m_sourceParams; } /** *

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" }

*/ inline bool SourceParamsHasBeenSet() const { return m_sourceParamsHasBeenSet; } /** *

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" }

*/ inline void SetSourceParams(const Aws::Map& value) { m_sourceParamsHasBeenSet = true; m_sourceParams = value; } /** *

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" }

*/ inline void SetSourceParams(Aws::Map&& value) { m_sourceParamsHasBeenSet = true; m_sourceParams = std::move(value); } /** *

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" }

*/ inline CreateChangesetRequest& WithSourceParams(const Aws::Map& value) { SetSourceParams(value); return *this;} /** *

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" }

*/ inline CreateChangesetRequest& WithSourceParams(Aws::Map&& value) { SetSourceParams(std::move(value)); return *this;} /** *

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" }

*/ inline CreateChangesetRequest& AddSourceParams(const Aws::String& key, const Aws::String& value) { m_sourceParamsHasBeenSet = true; m_sourceParams.emplace(key, value); return *this; } /** *

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" }

*/ inline CreateChangesetRequest& AddSourceParams(Aws::String&& key, const Aws::String& value) { m_sourceParamsHasBeenSet = true; m_sourceParams.emplace(std::move(key), value); return *this; } /** *

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" }

*/ inline CreateChangesetRequest& AddSourceParams(const Aws::String& key, Aws::String&& value) { m_sourceParamsHasBeenSet = true; m_sourceParams.emplace(key, std::move(value)); return *this; } /** *

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" }

*/ inline CreateChangesetRequest& AddSourceParams(Aws::String&& key, Aws::String&& value) { m_sourceParamsHasBeenSet = true; m_sourceParams.emplace(std::move(key), std::move(value)); return *this; } /** *

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" }

*/ inline CreateChangesetRequest& AddSourceParams(const char* key, Aws::String&& value) { m_sourceParamsHasBeenSet = true; m_sourceParams.emplace(key, std::move(value)); return *this; } /** *

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" }

*/ inline CreateChangesetRequest& AddSourceParams(Aws::String&& key, const char* value) { m_sourceParamsHasBeenSet = true; m_sourceParams.emplace(std::move(key), value); return *this; } /** *

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" }

*/ inline CreateChangesetRequest& AddSourceParams(const char* key, const char* value) { m_sourceParamsHasBeenSet = true; m_sourceParams.emplace(key, value); return *this; } /** *

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.

*/ inline const Aws::Map& GetFormatParams() const{ return m_formatParams; } /** *

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.

*/ inline bool FormatParamsHasBeenSet() const { return m_formatParamsHasBeenSet; } /** *

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.

*/ inline void SetFormatParams(const Aws::Map& value) { m_formatParamsHasBeenSet = true; m_formatParams = value; } /** *

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.

*/ inline void SetFormatParams(Aws::Map&& value) { m_formatParamsHasBeenSet = true; m_formatParams = std::move(value); } /** *

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.

*/ inline CreateChangesetRequest& WithFormatParams(const Aws::Map& value) { SetFormatParams(value); return *this;} /** *

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.

*/ inline CreateChangesetRequest& WithFormatParams(Aws::Map&& value) { SetFormatParams(std::move(value)); return *this;} /** *

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.

*/ inline CreateChangesetRequest& AddFormatParams(const Aws::String& key, const Aws::String& value) { m_formatParamsHasBeenSet = true; m_formatParams.emplace(key, value); return *this; } /** *

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.

*/ inline CreateChangesetRequest& AddFormatParams(Aws::String&& key, const Aws::String& value) { m_formatParamsHasBeenSet = true; m_formatParams.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline CreateChangesetRequest& AddFormatParams(const Aws::String& key, Aws::String&& value) { m_formatParamsHasBeenSet = true; m_formatParams.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline CreateChangesetRequest& AddFormatParams(Aws::String&& key, Aws::String&& value) { m_formatParamsHasBeenSet = true; m_formatParams.emplace(std::move(key), std::move(value)); return *this; } /** *

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.

*/ inline CreateChangesetRequest& AddFormatParams(const char* key, Aws::String&& value) { m_formatParamsHasBeenSet = true; m_formatParams.emplace(key, std::move(value)); return *this; } /** *

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.

*/ inline CreateChangesetRequest& AddFormatParams(Aws::String&& key, const char* value) { m_formatParamsHasBeenSet = true; m_formatParams.emplace(std::move(key), value); return *this; } /** *

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.

*/ inline CreateChangesetRequest& AddFormatParams(const char* key, const char* value) { m_formatParamsHasBeenSet = true; m_formatParams.emplace(key, value); return *this; } private: Aws::String m_clientToken; bool m_clientTokenHasBeenSet = false; Aws::String m_datasetId; bool m_datasetIdHasBeenSet = false; ChangeType m_changeType; bool m_changeTypeHasBeenSet = false; Aws::Map m_sourceParams; bool m_sourceParamsHasBeenSet = false; Aws::Map m_formatParams; bool m_formatParamsHasBeenSet = false; }; } // namespace Model } // namespace FinSpaceData } // namespace Aws

See Also: