Class CreateKxChangesetRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.finspace.model.FinspaceRequest
software.amazon.awssdk.services.finspace.model.CreateKxChangesetRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateKxChangesetRequest.Builder,CreateKxChangesetRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateKxChangesetRequest extends FinspaceRequest implements ToCopyableBuilder<CreateKxChangesetRequest.Builder,CreateKxChangesetRequest>

  • Method Details

    • environmentId

      public final String environmentId()

      A unique identifier of the kdb environment.

      Returns:
      A unique identifier of the kdb environment.

    • databaseName

      public final String databaseName()

      The name of the kdb database.

      Returns:
      The name of the kdb database.

    • hasChangeRequests

      public final boolean hasChangeRequests()
      For responses, this returns true if the service returned a value for the ChangeRequests 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.

    • changeRequests

      public final List<ChangeRequest> changeRequests()

      A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. A changeType can have the following values:

      • PUT – Adds or updates files in a database.

      • DELETE – Deletes files in a database.

      All the change requests require a mandatory dbPath attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The s3Path attribute defines the s3 source file path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

      Here are few examples of how you can use the change request object:

      1. This request adds a single sym file at database root location.

        { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}

      2. This request adds files in the given s3Path under the 2020.01.02 partition of the database.

        { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}

      3. This request adds files in the given s3Path under the taq table partition of the database.

        [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]

      4. This request deletes the 2020.01.02 partition of the database.

        [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]

      5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

        [ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]

      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 hasChangeRequests() method.

      Returns:
      A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and dbPath. A changeType can have the following values:

      • PUT – Adds or updates files in a database.

      • DELETE – Deletes files in a database.

      All the change requests require a mandatory dbPath attribute that defines the path within the database directory. All database paths must start with a leading / and end with a trailing /. The s3Path attribute defines the s3 source file path and is required for a PUT change type. The s3path must end with a trailing / if it is a directory and must end without a trailing / if it is a file.

      Here are few examples of how you can use the change request object:

      1. This request adds a single sym file at database root location.

        { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}

      2. This request adds files in the given s3Path under the 2020.01.02 partition of the database.

        { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}

      3. This request adds files in the given s3Path under the taq table partition of the database.

        [ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]

      4. This request deletes the 2020.01.02 partition of the database.

        [{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]

      5. The DELETE request allows you to delete the existing files under the 2020.01.02 partition of the database, and the PUT request adds a new taq table under it.

        [ {"changeType": "DELETE", "dbPath":"/2020.01.02/"}, {"changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/taq/", "dbPath":"/2020.01.02/taq/"}]

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

    • toBuilder

      public CreateKxChangesetRequest.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<CreateKxChangesetRequest.Builder,CreateKxChangesetRequest>
      Specified by:
      toBuilder in class FinspaceRequest
      Returns:
      a builder for type T

    • builder

      public static CreateKxChangesetRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateKxChangesetRequest.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.