CreateChangesetRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.finspacedata.model.FinspaceDataRequest
    - - software.amazon.awssdk.services.finspacedata.model.CreateChangesetRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<CreateChangesetRequest.Builder,CreateChangesetRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class CreateChangesetRequest
extends FinspaceDataRequest
implements ToCopyableBuilder<CreateChangesetRequest.Builder,CreateChangesetRequest>

The request for a CreateChangeset operation.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface CreateChangesetRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CreateChangesetRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static CreateChangesetRequest.Builder`	`builder()`
`ChangeType`	`changeType()` The option to indicate how a Changeset will be applied to a Dataset.
`String`	`changeTypeAsString()` The option to indicate how a Changeset will be applied to a Dataset.
`String`	`clientToken()` A token that ensures idempotency.
`String`	`datasetId()` The unique identifier for the FinSpace Dataset where the Changeset will be 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 CreateChangesetRequest.Builder>`	`serializableBuilderClass()`
`Map<String,String>`	`sourceParams()` Options that define the location of the data being ingested (`s3SourcePath`) and the source of the changeset (`sourceType`).
`CreateChangesetRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - clientToken
```
public final String clientToken()
```
    A token that ensures idempotency. This token expires in 10 minutes.
    
    Returns:
    
    A token that ensures idempotency. This token expires in 10 minutes.
  - datasetId
```
public final String datasetId()
```
    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.
  - changeType
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, changeType will return ChangeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from changeTypeAsString().
    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
  - changeTypeAsString
```
public final String changeTypeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, changeType will return ChangeType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from changeTypeAsString().
    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
  - hasSourceParams
```
public final boolean hasSourceParams()
```
    For responses, this returns true if the service returned a value for the SourceParams property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - sourceParams
```
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 API section.
    
    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.
    
    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.
  - hasFormatParams
```
public final boolean hasFormatParams()
```
    For responses, this returns true if the service returned a value for the FormatParams property. This DOES NOT check that the value is non-empty (for which, you should check the 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.
  - formatParams
```
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.
    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.
  - toBuilder
```
public CreateChangesetRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<CreateChangesetRequest.Builder,CreateChangesetRequest>
    
    Specified by:
    
    toBuilder in class FinspaceDataRequest
  - builder
```
public static CreateChangesetRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends CreateChangesetRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final 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
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class CreateChangesetRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

clientToken

datasetId

changeType

changeTypeAsString

hasSourceParams

sourceParams

hasFormatParams

formatParams

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields