Package software.amazon.awssdk.services.finspacedata.model

Interface CreateChangesetRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreateChangesetRequest.Builder,CreateChangesetRequest>, FinspaceDataRequest.Builder, SdkBuilder<CreateChangesetRequest.Builder,CreateChangesetRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateChangesetRequest
public static interface CreateChangesetRequest.Builder extends FinspaceDataRequest.Builder, SdkPojo, CopyableBuilder<CreateChangesetRequest.Builder,CreateChangesetRequest>

  • Method Details

    • clientToken

      CreateChangesetRequest.Builder clientToken(String clientToken)

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

      Parameters:
      clientToken - A token that ensures idempotency. This token expires in 10 minutes.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • datasetId

      CreateChangesetRequest.Builder datasetId(String datasetId)

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

      Parameters:
      datasetId - The unique identifier for the FinSpace Dataset where the Changeset will be created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • changeType

      CreateChangesetRequest.Builder changeType(String 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • changeType

      CreateChangesetRequest.Builder changeType(ChangeType 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sourceParams

      CreateChangesetRequest.Builder sourceParams(Map<String,String> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • formatParams

      CreateChangesetRequest.Builder formatParams(Map<String,String> 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.

      Parameters:
      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.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateChangesetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      CreateChangesetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.