Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Creates a new Changeset in a FinSpace Dataset.
Synopsis
- data CreateChangeset = CreateChangeset' {}
- newCreateChangeset :: Text -> ChangeType -> CreateChangeset
- createChangeset_clientToken :: Lens' CreateChangeset (Maybe Text)
- createChangeset_datasetId :: Lens' CreateChangeset Text
- createChangeset_changeType :: Lens' CreateChangeset ChangeType
- createChangeset_sourceParams :: Lens' CreateChangeset (HashMap Text Text)
- createChangeset_formatParams :: Lens' CreateChangeset (HashMap Text Text)
- data CreateChangesetResponse = CreateChangesetResponse' {
- changesetId :: Maybe Text
- datasetId :: Maybe Text
- httpStatus :: Int
- newCreateChangesetResponse :: Int -> CreateChangesetResponse
- createChangesetResponse_changesetId :: Lens' CreateChangesetResponse (Maybe Text)
- createChangesetResponse_datasetId :: Lens' CreateChangesetResponse (Maybe Text)
- createChangesetResponse_httpStatus :: Lens' CreateChangesetResponse Int
Creating a Request
data CreateChangeset Source #
The request for a CreateChangeset operation.
See: newCreateChangeset
smart constructor.
CreateChangeset' | |
|
Instances
Create a value of CreateChangeset
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:clientToken:CreateChangeset'
, createChangeset_clientToken
- A token that ensures idempotency. This token expires in 10 minutes.
CreateChangeset
, createChangeset_datasetId
- The unique identifier for the FinSpace Dataset where the Changeset will
be created.
CreateChangeset
, createChangeset_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.
CreateChangeset
, createChangeset_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" }
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.
CreateChangeset
, createChangeset_formatParams
- 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.
Request Lenses
createChangeset_clientToken :: Lens' CreateChangeset (Maybe Text) Source #
A token that ensures idempotency. This token expires in 10 minutes.
createChangeset_datasetId :: Lens' CreateChangeset Text Source #
The unique identifier for the FinSpace Dataset where the Changeset will be created.
createChangeset_changeType :: Lens' CreateChangeset ChangeType Source #
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.
createChangeset_sourceParams :: Lens' CreateChangeset (HashMap Text Text) Source #
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.
createChangeset_formatParams :: Lens' CreateChangeset (HashMap Text Text) Source #
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.
Destructuring the Response
data CreateChangesetResponse Source #
The response from a CreateChangeset operation.
See: newCreateChangesetResponse
smart constructor.
CreateChangesetResponse' | |
|
Instances
newCreateChangesetResponse Source #
Create a value of CreateChangesetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateChangesetResponse
, createChangesetResponse_changesetId
- The unique identifier of the Changeset that is created.
CreateChangeset
, createChangesetResponse_datasetId
- The unique identifier for the FinSpace Dataset where the Changeset is
created.
$sel:httpStatus:CreateChangesetResponse'
, createChangesetResponse_httpStatus
- The response's http status code.
Response Lenses
createChangesetResponse_changesetId :: Lens' CreateChangesetResponse (Maybe Text) Source #
The unique identifier of the Changeset that is created.
createChangesetResponse_datasetId :: Lens' CreateChangesetResponse (Maybe Text) Source #
The unique identifier for the FinSpace Dataset where the Changeset is created.
createChangesetResponse_httpStatus :: Lens' CreateChangesetResponse Int Source #
The response's http status code.