Class UpdateChangesetRequest

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.UpdateChangesetRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<UpdateChangesetRequest.Builder,UpdateChangesetRequest>
@Generated("software.amazon.awssdk:codegen") public final class UpdateChangesetRequest extends FinspaceDataRequest implements ToCopyableBuilder<UpdateChangesetRequest.Builder,UpdateChangesetRequest>
Request to update an existing changeset.

  • Method Details

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

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

    • changesetId

      public final String changesetId()

      The unique identifier for the Changeset to update.

      Returns:
      The unique identifier for the Changeset to update.

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

      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.

    • 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 UpdateChangesetRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<UpdateChangesetRequest.Builder,UpdateChangesetRequest>
      Specified by:
      toBuilder in class FinspaceDataRequest
      Returns:
      a builder for type T

    • builder

      public static UpdateChangesetRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdateChangesetRequest.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.