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 |
Updates a FinSpace Changeset.
Synopsis
- data UpdateChangeset = UpdateChangeset' {}
- newUpdateChangeset :: Text -> Text -> UpdateChangeset
- updateChangeset_clientToken :: Lens' UpdateChangeset (Maybe Text)
- updateChangeset_datasetId :: Lens' UpdateChangeset Text
- updateChangeset_changesetId :: Lens' UpdateChangeset Text
- updateChangeset_sourceParams :: Lens' UpdateChangeset (HashMap Text Text)
- updateChangeset_formatParams :: Lens' UpdateChangeset (HashMap Text Text)
- data UpdateChangesetResponse = UpdateChangesetResponse' {
- changesetId :: Maybe Text
- datasetId :: Maybe Text
- httpStatus :: Int
- newUpdateChangesetResponse :: Int -> UpdateChangesetResponse
- updateChangesetResponse_changesetId :: Lens' UpdateChangesetResponse (Maybe Text)
- updateChangesetResponse_datasetId :: Lens' UpdateChangesetResponse (Maybe Text)
- updateChangesetResponse_httpStatus :: Lens' UpdateChangesetResponse Int
Creating a Request
data UpdateChangeset Source #
Request to update an existing changeset.
See: newUpdateChangeset
smart constructor.
UpdateChangeset' | |
|
Instances
Create a value of UpdateChangeset
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:UpdateChangeset'
, updateChangeset_clientToken
- A token that ensures idempotency. This token expires in 10 minutes.
UpdateChangeset
, updateChangeset_datasetId
- The unique identifier for the FinSpace Dataset in which the Changeset is
created.
UpdateChangeset
, updateChangeset_changesetId
- The unique identifier for the Changeset to update.
UpdateChangeset
, updateChangeset_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 APIsection.
UpdateChangeset
, updateChangeset_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
updateChangeset_clientToken :: Lens' UpdateChangeset (Maybe Text) Source #
A token that ensures idempotency. This token expires in 10 minutes.
updateChangeset_datasetId :: Lens' UpdateChangeset Text Source #
The unique identifier for the FinSpace Dataset in which the Changeset is created.
updateChangeset_changesetId :: Lens' UpdateChangeset Text Source #
The unique identifier for the Changeset to update.
updateChangeset_sourceParams :: Lens' UpdateChangeset (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 APIsection.
updateChangeset_formatParams :: Lens' UpdateChangeset (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 UpdateChangesetResponse Source #
The response from a update changeset operation.
See: newUpdateChangesetResponse
smart constructor.
UpdateChangesetResponse' | |
|
Instances
newUpdateChangesetResponse Source #
Create a value of UpdateChangesetResponse
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:
UpdateChangeset
, updateChangesetResponse_changesetId
- The unique identifier for the Changeset to update.
UpdateChangeset
, updateChangesetResponse_datasetId
- The unique identifier for the FinSpace Dataset in which the Changeset is
created.
$sel:httpStatus:UpdateChangesetResponse'
, updateChangesetResponse_httpStatus
- The response's http status code.
Response Lenses
updateChangesetResponse_changesetId :: Lens' UpdateChangesetResponse (Maybe Text) Source #
The unique identifier for the Changeset to update.
updateChangesetResponse_datasetId :: Lens' UpdateChangesetResponse (Maybe Text) Source #
The unique identifier for the FinSpace Dataset in which the Changeset is created.
updateChangesetResponse_httpStatus :: Lens' UpdateChangesetResponse Int Source #
The response's http status code.