com.amazonaws.services.finspacedata.model

Class CreateChangesetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.finspacedata.model.CreateChangesetRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateChangesetRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

The request for a CreateChangeset operation.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateChangesetRequest()

Method Summary

Modifier and Type	Method and Description
CreateChangesetRequest	addFormatParamsEntry(String key, String value) Add a single FormatParams entry
CreateChangesetRequest	addSourceParamsEntry(String key, String value) Add a single SourceParams entry
CreateChangesetRequest	clearFormatParamsEntries() Removes all the entries added into FormatParams.
CreateChangesetRequest	clearSourceParamsEntries() Removes all the entries added into SourceParams.
CreateChangesetRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChangeType() The option to indicate how a Changeset will be applied to a Dataset.
String	getClientToken() A token that ensures idempotency.
String	getDatasetId() The unique identifier for the FinSpace Dataset where the Changeset will be created.
Map<String,String>	getFormatParams() 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).
Map<String,String>	getSourceParams() Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).
int	hashCode()
void	setChangeType(String changeType) The option to indicate how a Changeset will be applied to a Dataset.
void	setClientToken(String clientToken) A token that ensures idempotency.
void	setDatasetId(String datasetId) The unique identifier for the FinSpace Dataset where the Changeset will be created.
void	setFormatParams(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).
void	setSourceParams(Map<String,String> sourceParams) Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).
String	toString() Returns a string representation of this object.
CreateChangesetRequest	withChangeType(ChangeType changeType) The option to indicate how a Changeset will be applied to a Dataset.
CreateChangesetRequest	withChangeType(String changeType) The option to indicate how a Changeset will be applied to a Dataset.
CreateChangesetRequest	withClientToken(String clientToken) A token that ensures idempotency.
CreateChangesetRequest	withDatasetId(String datasetId) The unique identifier for the FinSpace Dataset where the Changeset will be created.
CreateChangesetRequest	withFormatParams(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).
CreateChangesetRequest	withSourceParams(Map<String,String> sourceParams) Options that define the location of the data being ingested (s3SourcePath) and the source of the changeset (sourceType).

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateChangesetRequest

public CreateChangesetRequest()

Method Detail

setClientToken

public void setClientToken(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.

getClientToken

public String getClientToken()

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

Returns:

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

withClientToken

public CreateChangesetRequest withClientToken(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.

setDatasetId

public void setDatasetId(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.

getDatasetId

public String getDatasetId()

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

Returns:

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

withDatasetId

public CreateChangesetRequest withDatasetId(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.

setChangeType

public void setChangeType(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.

See Also:

ChangeType

getChangeType

public String getChangeType()

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:

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.

See Also:

ChangeType

withChangeType

public CreateChangesetRequest withChangeType(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

withChangeType

public CreateChangesetRequest withChangeType(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:

ChangeType

getSourceParams

public Map<String,String> getSourceParams()

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:

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.

setSourceParams

public void setSourceParams(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.

withSourceParams

public CreateChangesetRequest withSourceParams(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.

addSourceParamsEntry

public CreateChangesetRequest addSourceParamsEntry(String key,
                                                   String value)

Add a single SourceParams entry

See Also:

withSourceParams(java.util.Map<java.lang.String, java.lang.String>)

clearSourceParamsEntries

public CreateChangesetRequest clearSourceParamsEntries()

Removes all the entries added into SourceParams.

Returns:

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

getFormatParams

public Map<String,String> getFormatParams()

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:

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.

setFormatParams

public void setFormatParams(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.

withFormatParams

public CreateChangesetRequest withFormatParams(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.

addFormatParamsEntry

public CreateChangesetRequest addFormatParamsEntry(String key,
                                                   String value)

Add a single FormatParams entry

See Also:

withFormatParams(java.util.Map<java.lang.String, java.lang.String>)

clearFormatParamsEntries

public CreateChangesetRequest clearFormatParamsEntries()

Removes all the entries added into FormatParams.

Returns:

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

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateChangesetRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()