/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.finspacedata.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * The request for a CreateChangeset operation. * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class CreateChangesetRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

*/ private String clientToken; /** *

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

*/ private String datasetId; /** *

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

* */ private String changeType; /** *

* 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. *

*/ private java.util.Map sourceParams; /** *

* 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: *

* *

* 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. *

*/ private java.util.Map formatParams; /** *

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

* * @param clientToken * A token that ensures idempotency. This token expires in 10 minutes. */ public void setClientToken(String clientToken) { this.clientToken = clientToken; } /** *

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

* * @return A token that ensures idempotency. This token expires in 10 minutes. */ public String getClientToken() { return this.clientToken; } /** *

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

* * @param clientToken * A token that ensures idempotency. This token expires in 10 minutes. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateChangesetRequest withClientToken(String clientToken) { setClientToken(clientToken); return this; } /** *

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

* * @param datasetId * The unique identifier for the FinSpace Dataset where the Changeset will be created. */ public void setDatasetId(String datasetId) { this.datasetId = datasetId; } /** *

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

* * @return The unique identifier for the FinSpace Dataset where the Changeset will be created. */ public String getDatasetId() { return this.datasetId; } /** *

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

* * @param datasetId * The unique identifier for the FinSpace Dataset where the Changeset will be created. * @return Returns a reference to this object so that method calls can be chained together. */ public CreateChangesetRequest withDatasetId(String datasetId) { setDatasetId(datasetId); return this; } /** *

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

* * * @param changeType * The option to indicate how a Changeset will be applied to a Dataset.

*