Package software.amazon.awssdk.services.finspace.model

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>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateKxChangesetRequest.Builder

Method Summary

Modifier and Type	Method	Description
static CreateKxChangesetRequest.Builder	builder()
List<ChangeRequest>	changeRequests()	A list of change request objects that are run in order.
String	clientToken()	A token that ensures idempotency.
String	databaseName()	The name of the kdb database.
String	environmentId()	A unique identifier of the kdb environment.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
boolean	hasChangeRequests()	For responses, this returns true if the service returned a value for the ChangeRequests property.
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends CreateKxChangesetRequest.Builder>	serializableBuilderClass()
CreateKxChangesetRequest.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

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 has 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 has 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()

Specified by:

toBuilder in interface ToCopyableBuilder<CreateKxChangesetRequest.Builder,CreateKxChangesetRequest>

Specified by:

toBuilder in class FinspaceRequest

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)

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