@Generated(value="software.amazon.awssdk:codegen") public final class UpdateChangesetRequest extends FinspaceDataRequest implements ToCopyableBuilder<UpdateChangesetRequest.Builder,UpdateChangesetRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
UpdateChangesetRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static UpdateChangesetRequest.Builder |
builder() |
String |
changesetId()
The unique identifier for the Changeset to update.
|
String |
clientToken()
A token that ensures idempotency.
|
String |
datasetId()
The unique identifier for the FinSpace Dataset in which the Changeset is created.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
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). |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasFormatParams()
For responses, this returns true if the service returned a value for the FormatParams property.
|
int |
hashCode() |
boolean |
hasSourceParams()
For responses, this returns true if the service returned a value for the SourceParams property.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends UpdateChangesetRequest.Builder> |
serializableBuilderClass() |
Map<String,String> |
sourceParams()
Options that define the location of the data being ingested (
s3SourcePath) and the source of the
changeset (sourceType). |
UpdateChangesetRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String clientToken()
A token that ensures idempotency. This token expires in 10 minutes.
public final String datasetId()
The unique identifier for the FinSpace Dataset in which the Changeset is created.
public final String changesetId()
The unique identifier for the Changeset to update.
public final boolean hasSourceParams()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSourceParams() method.
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.
public final boolean hasFormatParams()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasFormatParams() method.
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.
public UpdateChangesetRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<UpdateChangesetRequest.Builder,UpdateChangesetRequest>toBuilder in class FinspaceDataRequestpublic static UpdateChangesetRequest.Builder builder()
public static Class<? extends UpdateChangesetRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.