com.amazonaws.services.finspacedata.model

Class UpdateChangesetRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.finspacedata.model.UpdateChangesetRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

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

Request to update an existing changeset.

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
UpdateChangesetRequest()

Method Summary

Modifier and Type	Method and Description
UpdateChangesetRequest	addFormatParamsEntry(String key, String value) Add a single FormatParams entry
UpdateChangesetRequest	addSourceParamsEntry(String key, String value) Add a single SourceParams entry
UpdateChangesetRequest	clearFormatParamsEntries() Removes all the entries added into FormatParams.
UpdateChangesetRequest	clearSourceParamsEntries() Removes all the entries added into SourceParams.
UpdateChangesetRequest	clone()
boolean	equals(Object obj)
String	getChangesetId() The unique identifier for the Changeset to update.
String	getClientToken() A token that ensures idempotency.
String	getDatasetId() The unique identifier for the FinSpace Dataset in which the Changeset is 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	setChangesetId(String changesetId) The unique identifier for the Changeset to update.
void	setClientToken(String clientToken) A token that ensures idempotency.
void	setDatasetId(String datasetId) The unique identifier for the FinSpace Dataset in which the Changeset is 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.
UpdateChangesetRequest	withChangesetId(String changesetId) The unique identifier for the Changeset to update.
UpdateChangesetRequest	withClientToken(String clientToken) A token that ensures idempotency.
UpdateChangesetRequest	withDatasetId(String datasetId) The unique identifier for the FinSpace Dataset in which the Changeset is created.
UpdateChangesetRequest	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).
UpdateChangesetRequest	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, copyBaseTo, 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

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

UpdateChangesetRequest

public UpdateChangesetRequest()

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 UpdateChangesetRequest 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 in which the Changeset is created.

Parameters:

datasetId - The unique identifier for the FinSpace Dataset in which the Changeset is created.

getDatasetId

public String getDatasetId()

The unique identifier for the FinSpace Dataset in which the Changeset is created.

Returns:

The unique identifier for the FinSpace Dataset in which the Changeset is created.

withDatasetId

public UpdateChangesetRequest withDatasetId(String datasetId)

The unique identifier for the FinSpace Dataset in which the Changeset is created.

Parameters:

datasetId - The unique identifier for the FinSpace Dataset in which the Changeset is created.

Returns:

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

setChangesetId

public void setChangesetId(String changesetId)

The unique identifier for the Changeset to update.

Parameters:

changesetId - The unique identifier for the Changeset to update.

getChangesetId

public String getChangesetId()

The unique identifier for the Changeset to update.

Returns:

The unique identifier for the Changeset to update.

withChangesetId

public UpdateChangesetRequest withChangesetId(String changesetId)

The unique identifier for the Changeset to update.

Parameters:

changesetId - The unique identifier for the Changeset to update.

Returns:

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

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

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

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

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

withSourceParams

public UpdateChangesetRequest 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 APIsection.

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

Returns:

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

addSourceParamsEntry

public UpdateChangesetRequest addSourceParamsEntry(String key,
                                                   String value)

Add a single SourceParams entry

See Also:

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

clearSourceParamsEntries

public UpdateChangesetRequest 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 UpdateChangesetRequest 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 UpdateChangesetRequest addFormatParamsEntry(String key,
                                                   String value)

Add a single FormatParams entry

See Also:

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

clearFormatParamsEntries

public UpdateChangesetRequest 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 UpdateChangesetRequest clone()

Overrides:

clone in class AmazonWebServiceRequest