Interface CreateKxChangesetRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CreateKxChangesetRequest.Builder,
,CreateKxChangesetRequest> FinspaceRequest.Builder
,SdkBuilder<CreateKxChangesetRequest.Builder,
,CreateKxChangesetRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateKxChangesetRequest
-
Method Summary
Modifier and TypeMethodDescriptionchangeRequests
(Collection<ChangeRequest> changeRequests) A list of change request objects that are run in order.changeRequests
(Consumer<ChangeRequest.Builder>... changeRequests) A list of change request objects that are run in order.changeRequests
(ChangeRequest... changeRequests) A list of change request objects that are run in order.clientToken
(String clientToken) A token that ensures idempotency.databaseName
(String databaseName) The name of the kdb database.environmentId
(String environmentId) A unique identifier of the kdb environment.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.finspace.model.FinspaceRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
environmentId
A unique identifier of the kdb environment.
- Parameters:
environmentId
- A unique identifier of the kdb environment.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
databaseName
The name of the kdb database.
- Parameters:
databaseName
- The name of the kdb database.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
changeRequests
A list of change request objects that are run in order. A change request object consists of
changeType
,s3Path
, anddbPath
. 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 /. Thes3Path
attribute defines the s3 source file path and is required for a PUT change type. Thes3path
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:
-
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
-
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/"}
-
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/"}]
-
This request deletes the 2020.01.02 partition of the database.
[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]
-
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/"}]
- Parameters:
changeRequests
- A list of change request objects that are run in order. A change request object consists ofchangeType
,s3Path
, anddbPath
. 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 /. Thes3Path
attribute defines the s3 source file path and is required for a PUT change type. Thes3path
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:
-
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
-
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/"}
-
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/"}]
-
This request deletes the 2020.01.02 partition of the database.
[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]
-
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/"}]
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
changeRequests
A list of change request objects that are run in order. A change request object consists of
changeType
,s3Path
, anddbPath
. 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 /. Thes3Path
attribute defines the s3 source file path and is required for a PUT change type. Thes3path
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:
-
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
-
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/"}
-
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/"}]
-
This request deletes the 2020.01.02 partition of the database.
[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]
-
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/"}]
- Parameters:
changeRequests
- A list of change request objects that are run in order. A change request object consists ofchangeType
,s3Path
, anddbPath
. 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 /. Thes3Path
attribute defines the s3 source file path and is required for a PUT change type. Thes3path
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:
-
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
-
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/"}
-
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/"}]
-
This request deletes the 2020.01.02 partition of the database.
[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]
-
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/"}]
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
changeRequests
A list of change request objects that are run in order. A change request object consists of
changeType
,s3Path
, anddbPath
. 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 /. Thes3Path
attribute defines the s3 source file path and is required for a PUT change type. Thes3path
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:
-
This request adds a single sym file at database root location.
{ "changeType": "PUT", "s3Path":"s3://bucket/db/sym", "dbPath":"/"}
-
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/"}
-
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/"}]
-
This request deletes the 2020.01.02 partition of the database.
[{ "changeType": "DELETE", "dbPath": "/2020.01.02/"} ]
-
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/"}]
ChangeRequest.Builder
avoiding the need to create one manually viaChangeRequest.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tochangeRequests(List<ChangeRequest>)
.- Parameters:
changeRequests
- a consumer that will call methods onChangeRequest.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
clientToken
A token that ensures idempotency. This token expires in 10 minutes.
- Parameters:
clientToken
- A token that ensures idempotency. This token expires in 10 minutes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
CreateKxChangesetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateKxChangesetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-