@Generated(value="software.amazon.awssdk:codegen") public final class CreateKxChangesetRequest extends FinspaceRequest implements ToCopyableBuilder<CreateKxChangesetRequest.Builder,CreateKxChangesetRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateKxChangesetRequest.Builder |
| Modifier and Type | Method and 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.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final String environmentId()
A unique identifier of the kdb environment.
public final String databaseName()
The name of the kdb database.
public final boolean hasChangeRequests()
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 List<ChangeRequest> changeRequests()
A list of change request objects that are run in order. A change request object consists of changeType , s3Path, and a 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. The s3Path attribute defines the s3 source file path and is required for a PUT change type.
Here is an example of how you can use the change request object:
[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]
In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.
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.
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. The s3Path attribute defines the s3 source file path and is required for a PUT change type.
Here is an example of how you can use the change request object:
[ { "changeType": "PUT", "s3Path":"s3://bucket/db/2020.01.02/", "dbPath":"/2020.01.02/"}, { "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}, { "changeType": "DELETE", "dbPath": "/2020.01.01/"} ]
In this example, the first request with PUT change type allows you to add files in the given s3Path under the 2020.01.02 partition of the database. The second request with PUT change type allows you to add a single sym file at database root location. The last request with DELETE change type allows you to delete the files under the 2020.01.01 partition of the database.
public final String clientToken()
A token that ensures idempotency. This token expires in 10 minutes.
public CreateKxChangesetRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateKxChangesetRequest.Builder,CreateKxChangesetRequest>toBuilder in class FinspaceRequestpublic static CreateKxChangesetRequest.Builder builder()
public static Class<? extends CreateKxChangesetRequest.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.