@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface FinspaceAsyncClient extends AwsClient
builder() method.
The FinSpace management service provides the APIs for managing FinSpace environments.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest)
Create a new FinSpace environment.
createEnvironmentRequest - default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest)
Create a new FinSpace environment.
This is a convenience which creates an instance of the CreateEnvironmentRequest.Builder avoiding the need
to create one manually via CreateEnvironmentRequest.builder()
createEnvironmentRequest - A Consumer that will call methods on
CreateEnvironmentRequest.Builder to create a
request.default CompletableFuture<CreateKxChangesetResponse> createKxChangeset(CreateKxChangesetRequest createKxChangesetRequest)
Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.
createKxChangesetRequest - default CompletableFuture<CreateKxChangesetResponse> createKxChangeset(Consumer<CreateKxChangesetRequest.Builder> createKxChangesetRequest)
Creates a changeset for a kdb database. A changeset allows you to add and delete existing files by using an ordered list of change requests.
This is a convenience which creates an instance of the CreateKxChangesetRequest.Builder avoiding the need
to create one manually via CreateKxChangesetRequest.builder()
createKxChangesetRequest - A Consumer that will call methods on
CreateKxChangesetRequest.Builder to create a
request.default CompletableFuture<CreateKxClusterResponse> createKxCluster(CreateKxClusterRequest createKxClusterRequest)
Creates a new kdb cluster.
createKxClusterRequest - default CompletableFuture<CreateKxClusterResponse> createKxCluster(Consumer<CreateKxClusterRequest.Builder> createKxClusterRequest)
Creates a new kdb cluster.
This is a convenience which creates an instance of the CreateKxClusterRequest.Builder avoiding the need
to create one manually via CreateKxClusterRequest.builder()
createKxClusterRequest - A Consumer that will call methods on
CreateKxClusterRequest.Builder to create a request.default CompletableFuture<CreateKxDatabaseResponse> createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest)
Creates a new kdb database in the environment.
createKxDatabaseRequest - default CompletableFuture<CreateKxDatabaseResponse> createKxDatabase(Consumer<CreateKxDatabaseRequest.Builder> createKxDatabaseRequest)
Creates a new kdb database in the environment.
This is a convenience which creates an instance of the CreateKxDatabaseRequest.Builder avoiding the need
to create one manually via CreateKxDatabaseRequest.builder()
createKxDatabaseRequest - A Consumer that will call methods on
CreateKxDatabaseRequest.Builder to create a
request.default CompletableFuture<CreateKxEnvironmentResponse> createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest)
Creates a managed kdb environment for the account.
createKxEnvironmentRequest - default CompletableFuture<CreateKxEnvironmentResponse> createKxEnvironment(Consumer<CreateKxEnvironmentRequest.Builder> createKxEnvironmentRequest)
Creates a managed kdb environment for the account.
This is a convenience which creates an instance of the CreateKxEnvironmentRequest.Builder avoiding the
need to create one manually via CreateKxEnvironmentRequest.builder()
createKxEnvironmentRequest - A Consumer that will call methods on
CreateKxEnvironmentRequest.Builder to create a
request.default CompletableFuture<CreateKxUserResponse> createKxUser(CreateKxUserRequest createKxUserRequest)
Creates a user in FinSpace kdb environment with an associated IAM role.
createKxUserRequest - default CompletableFuture<CreateKxUserResponse> createKxUser(Consumer<CreateKxUserRequest.Builder> createKxUserRequest)
Creates a user in FinSpace kdb environment with an associated IAM role.
This is a convenience which creates an instance of the CreateKxUserRequest.Builder avoiding the need to
create one manually via CreateKxUserRequest.builder()
createKxUserRequest - A Consumer that will call methods on
CreateKxUserRequest.Builder to create a request.default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest)
Delete an FinSpace environment.
deleteEnvironmentRequest - default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest)
Delete an FinSpace environment.
This is a convenience which creates an instance of the DeleteEnvironmentRequest.Builder avoiding the need
to create one manually via DeleteEnvironmentRequest.builder()
deleteEnvironmentRequest - A Consumer that will call methods on
DeleteEnvironmentRequest.Builder to create a
request.default CompletableFuture<DeleteKxClusterResponse> deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest)
Deletes a kdb cluster.
deleteKxClusterRequest - default CompletableFuture<DeleteKxClusterResponse> deleteKxCluster(Consumer<DeleteKxClusterRequest.Builder> deleteKxClusterRequest)
Deletes a kdb cluster.
This is a convenience which creates an instance of the DeleteKxClusterRequest.Builder avoiding the need
to create one manually via DeleteKxClusterRequest.builder()
deleteKxClusterRequest - A Consumer that will call methods on
DeleteKxClusterRequest.Builder to create a request.default CompletableFuture<DeleteKxDatabaseResponse> deleteKxDatabase(DeleteKxDatabaseRequest deleteKxDatabaseRequest)
Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
deleteKxDatabaseRequest - default CompletableFuture<DeleteKxDatabaseResponse> deleteKxDatabase(Consumer<DeleteKxDatabaseRequest.Builder> deleteKxDatabaseRequest)
Deletes the specified database and all of its associated data. This action is irreversible. You must copy any data out of the database before deleting it if the data is to be retained.
This is a convenience which creates an instance of the DeleteKxDatabaseRequest.Builder avoiding the need
to create one manually via DeleteKxDatabaseRequest.builder()
deleteKxDatabaseRequest - A Consumer that will call methods on
DeleteKxDatabaseRequest.Builder to create a
request.default CompletableFuture<DeleteKxEnvironmentResponse> deleteKxEnvironment(DeleteKxEnvironmentRequest deleteKxEnvironmentRequest)
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
deleteKxEnvironmentRequest - default CompletableFuture<DeleteKxEnvironmentResponse> deleteKxEnvironment(Consumer<DeleteKxEnvironmentRequest.Builder> deleteKxEnvironmentRequest)
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
This is a convenience which creates an instance of the DeleteKxEnvironmentRequest.Builder avoiding the
need to create one manually via DeleteKxEnvironmentRequest.builder()
deleteKxEnvironmentRequest - A Consumer that will call methods on
DeleteKxEnvironmentRequest.Builder to create a
request.default CompletableFuture<DeleteKxUserResponse> deleteKxUser(DeleteKxUserRequest deleteKxUserRequest)
Deletes a user in the specified kdb environment.
deleteKxUserRequest - default CompletableFuture<DeleteKxUserResponse> deleteKxUser(Consumer<DeleteKxUserRequest.Builder> deleteKxUserRequest)
Deletes a user in the specified kdb environment.
This is a convenience which creates an instance of the DeleteKxUserRequest.Builder avoiding the need to
create one manually via DeleteKxUserRequest.builder()
deleteKxUserRequest - A Consumer that will call methods on
DeleteKxUserRequest.Builder to create a request.default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest)
Returns the FinSpace environment object.
getEnvironmentRequest - default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest)
Returns the FinSpace environment object.
This is a convenience which creates an instance of the GetEnvironmentRequest.Builder avoiding the need to
create one manually via GetEnvironmentRequest.builder()
getEnvironmentRequest - A Consumer that will call methods on
GetEnvironmentRequest.Builder to create a request.default CompletableFuture<GetKxChangesetResponse> getKxChangeset(GetKxChangesetRequest getKxChangesetRequest)
Returns information about a kdb changeset.
getKxChangesetRequest - default CompletableFuture<GetKxChangesetResponse> getKxChangeset(Consumer<GetKxChangesetRequest.Builder> getKxChangesetRequest)
Returns information about a kdb changeset.
This is a convenience which creates an instance of the GetKxChangesetRequest.Builder avoiding the need to
create one manually via GetKxChangesetRequest.builder()
getKxChangesetRequest - A Consumer that will call methods on
GetKxChangesetRequest.Builder to create a request.default CompletableFuture<GetKxClusterResponse> getKxCluster(GetKxClusterRequest getKxClusterRequest)
Retrieves information about a kdb cluster.
getKxClusterRequest - default CompletableFuture<GetKxClusterResponse> getKxCluster(Consumer<GetKxClusterRequest.Builder> getKxClusterRequest)
Retrieves information about a kdb cluster.
This is a convenience which creates an instance of the GetKxClusterRequest.Builder avoiding the need to
create one manually via GetKxClusterRequest.builder()
getKxClusterRequest - A Consumer that will call methods on
GetKxClusterRequest.Builder to create a request.default CompletableFuture<GetKxConnectionStringResponse> getKxConnectionString(GetKxConnectionStringRequest getKxConnectionStringRequest)
Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
getKxConnectionStringRequest - default CompletableFuture<GetKxConnectionStringResponse> getKxConnectionString(Consumer<GetKxConnectionStringRequest.Builder> getKxConnectionStringRequest)
Retrieves a connection string for a user to connect to a kdb cluster. You must call this API using the same role that you have defined while creating a user.
This is a convenience which creates an instance of the GetKxConnectionStringRequest.Builder avoiding the
need to create one manually via GetKxConnectionStringRequest.builder()
getKxConnectionStringRequest - A Consumer that will call methods on
GetKxConnectionStringRequest.Builder to create a
request.default CompletableFuture<GetKxDatabaseResponse> getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest)
Returns database information for the specified environment ID.
getKxDatabaseRequest - default CompletableFuture<GetKxDatabaseResponse> getKxDatabase(Consumer<GetKxDatabaseRequest.Builder> getKxDatabaseRequest)
Returns database information for the specified environment ID.
This is a convenience which creates an instance of the GetKxDatabaseRequest.Builder avoiding the need to
create one manually via GetKxDatabaseRequest.builder()
getKxDatabaseRequest - A Consumer that will call methods on
GetKxDatabaseRequest.Builder to create a request.default CompletableFuture<GetKxEnvironmentResponse> getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest)
Retrieves all the information for the specified kdb environment.
getKxEnvironmentRequest - default CompletableFuture<GetKxEnvironmentResponse> getKxEnvironment(Consumer<GetKxEnvironmentRequest.Builder> getKxEnvironmentRequest)
Retrieves all the information for the specified kdb environment.
This is a convenience which creates an instance of the GetKxEnvironmentRequest.Builder avoiding the need
to create one manually via GetKxEnvironmentRequest.builder()
getKxEnvironmentRequest - A Consumer that will call methods on
GetKxEnvironmentRequest.Builder to create a
request.default CompletableFuture<GetKxUserResponse> getKxUser(GetKxUserRequest getKxUserRequest)
Retrieves information about the specified kdb user.
getKxUserRequest - default CompletableFuture<GetKxUserResponse> getKxUser(Consumer<GetKxUserRequest.Builder> getKxUserRequest)
Retrieves information about the specified kdb user.
This is a convenience which creates an instance of the GetKxUserRequest.Builder avoiding the need to
create one manually via GetKxUserRequest.builder()
getKxUserRequest - A Consumer that will call methods on
GetKxUserRequest.Builder to create a request.default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest)
A list of all of your FinSpace environments.
listEnvironmentsRequest - default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest)
A list of all of your FinSpace environments.
This is a convenience which creates an instance of the ListEnvironmentsRequest.Builder avoiding the need
to create one manually via ListEnvironmentsRequest.builder()
listEnvironmentsRequest - A Consumer that will call methods on
ListEnvironmentsRequest.Builder to create a
request.default CompletableFuture<ListKxChangesetsResponse> listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest)
Returns a list of all the changesets for a database.
listKxChangesetsRequest - default CompletableFuture<ListKxChangesetsResponse> listKxChangesets(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest)
Returns a list of all the changesets for a database.
This is a convenience which creates an instance of the ListKxChangesetsRequest.Builder avoiding the need
to create one manually via ListKxChangesetsRequest.builder()
listKxChangesetsRequest - A Consumer that will call methods on
ListKxChangesetsRequest.Builder to create a
request.default ListKxChangesetsPublisher listKxChangesetsPaginator(ListKxChangesetsRequest listKxChangesetsRequest)
Returns a list of all the changesets for a database.
This is a variant of
listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsPublisher publisher = client.listKxChangesetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsPublisher publisher = client.listKxChangesetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxChangesetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.finspace.model.ListKxChangesetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest) operation.
listKxChangesetsRequest - default ListKxChangesetsPublisher listKxChangesetsPaginator(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest)
Returns a list of all the changesets for a database.
This is a variant of
listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsPublisher publisher = client.listKxChangesetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsPublisher publisher = client.listKxChangesetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxChangesetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.finspace.model.ListKxChangesetsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest) operation.
This is a convenience which creates an instance of the ListKxChangesetsRequest.Builder avoiding the need
to create one manually via ListKxChangesetsRequest.builder()
listKxChangesetsRequest - A Consumer that will call methods on
ListKxChangesetsRequest.Builder to create a
request.default CompletableFuture<ListKxClusterNodesResponse> listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest)
Lists all the nodes in a kdb cluster.
listKxClusterNodesRequest - default CompletableFuture<ListKxClusterNodesResponse> listKxClusterNodes(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest)
Lists all the nodes in a kdb cluster.
This is a convenience which creates an instance of the ListKxClusterNodesRequest.Builder avoiding the
need to create one manually via ListKxClusterNodesRequest.builder()
listKxClusterNodesRequest - A Consumer that will call methods on
ListKxClusterNodesRequest.Builder to create a
request.default ListKxClusterNodesPublisher listKxClusterNodesPaginator(ListKxClusterNodesRequest listKxClusterNodesRequest)
Lists all the nodes in a kdb cluster.
This is a variant of
listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesPublisher publisher = client.listKxClusterNodesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesPublisher publisher = client.listKxClusterNodesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxClusterNodesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest)
operation.
listKxClusterNodesRequest - default ListKxClusterNodesPublisher listKxClusterNodesPaginator(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest)
Lists all the nodes in a kdb cluster.
This is a variant of
listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesPublisher publisher = client.listKxClusterNodesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesPublisher publisher = client.listKxClusterNodesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxClusterNodesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest)
operation.
This is a convenience which creates an instance of the ListKxClusterNodesRequest.Builder avoiding the
need to create one manually via ListKxClusterNodesRequest.builder()
listKxClusterNodesRequest - A Consumer that will call methods on
ListKxClusterNodesRequest.Builder to create a
request.default CompletableFuture<ListKxClustersResponse> listKxClusters(ListKxClustersRequest listKxClustersRequest)
Returns a list of clusters.
listKxClustersRequest - default CompletableFuture<ListKxClustersResponse> listKxClusters(Consumer<ListKxClustersRequest.Builder> listKxClustersRequest)
Returns a list of clusters.
This is a convenience which creates an instance of the ListKxClustersRequest.Builder avoiding the need to
create one manually via ListKxClustersRequest.builder()
listKxClustersRequest - A Consumer that will call methods on
ListKxClustersRequest.Builder to create a request.default CompletableFuture<ListKxDatabasesResponse> listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest)
Returns a list of all the databases in the kdb environment.
listKxDatabasesRequest - default CompletableFuture<ListKxDatabasesResponse> listKxDatabases(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest)
Returns a list of all the databases in the kdb environment.
This is a convenience which creates an instance of the ListKxDatabasesRequest.Builder avoiding the need
to create one manually via ListKxDatabasesRequest.builder()
listKxDatabasesRequest - A Consumer that will call methods on
ListKxDatabasesRequest.Builder to create a request.default ListKxDatabasesPublisher listKxDatabasesPaginator(ListKxDatabasesRequest listKxDatabasesRequest)
Returns a list of all the databases in the kdb environment.
This is a variant of
listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesPublisher publisher = client.listKxDatabasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesPublisher publisher = client.listKxDatabasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxDatabasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.finspace.model.ListKxDatabasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest) operation.
listKxDatabasesRequest - default ListKxDatabasesPublisher listKxDatabasesPaginator(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest)
Returns a list of all the databases in the kdb environment.
This is a variant of
listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest) operation. The
return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesPublisher publisher = client.listKxDatabasesPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesPublisher publisher = client.listKxDatabasesPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxDatabasesResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.finspace.model.ListKxDatabasesResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest) operation.
This is a convenience which creates an instance of the ListKxDatabasesRequest.Builder avoiding the need
to create one manually via ListKxDatabasesRequest.builder()
listKxDatabasesRequest - A Consumer that will call methods on
ListKxDatabasesRequest.Builder to create a request.default CompletableFuture<ListKxEnvironmentsResponse> listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest)
Returns a list of kdb environments created in an account.
listKxEnvironmentsRequest - default CompletableFuture<ListKxEnvironmentsResponse> listKxEnvironments(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest)
Returns a list of kdb environments created in an account.
This is a convenience which creates an instance of the ListKxEnvironmentsRequest.Builder avoiding the
need to create one manually via ListKxEnvironmentsRequest.builder()
listKxEnvironmentsRequest - A Consumer that will call methods on
ListKxEnvironmentsRequest.Builder to create a
request.default ListKxEnvironmentsPublisher listKxEnvironmentsPaginator(ListKxEnvironmentsRequest listKxEnvironmentsRequest)
Returns a list of kdb environments created in an account.
This is a variant of
listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsPublisher publisher = client.listKxEnvironmentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsPublisher publisher = client.listKxEnvironmentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest)
operation.
listKxEnvironmentsRequest - default ListKxEnvironmentsPublisher listKxEnvironmentsPaginator(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest)
Returns a list of kdb environments created in an account.
This is a variant of
listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest) operation.
The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will
internally handle making service calls for you.
When the operation is called, an instance of this class is returned. At this point, no service calls are made yet
and so there is no guarantee that the request is valid. If there are errors in your request, you will see the
failures only after you start streaming the data. The subscribe method should be called as a request to start
streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe
method will result in a new Subscription i.e., a new contract to stream data from the
starting request.
The following are few ways to use the response class:
1) Using the subscribe helper method
software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsPublisher publisher = client.listKxEnvironmentsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsPublisher publisher = client.listKxEnvironmentsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsResponse response) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest)
operation.
This is a convenience which creates an instance of the ListKxEnvironmentsRequest.Builder avoiding the
need to create one manually via ListKxEnvironmentsRequest.builder()
listKxEnvironmentsRequest - A Consumer that will call methods on
ListKxEnvironmentsRequest.Builder to create a
request.default CompletableFuture<ListKxUsersResponse> listKxUsers(ListKxUsersRequest listKxUsersRequest)
Lists all the users in a kdb environment.
listKxUsersRequest - default CompletableFuture<ListKxUsersResponse> listKxUsers(Consumer<ListKxUsersRequest.Builder> listKxUsersRequest)
Lists all the users in a kdb environment.
This is a convenience which creates an instance of the ListKxUsersRequest.Builder avoiding the need to
create one manually via ListKxUsersRequest.builder()
listKxUsersRequest - A Consumer that will call methods on
ListKxUsersRequest.Builder to create a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
A list of all tags for a resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
A list of all tags for a resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds metadata tags to a FinSpace resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds metadata tags to a FinSpace resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes metadata tags from a FinSpace resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes metadata tags from a FinSpace resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a request.default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest)
Update your FinSpace environment.
updateEnvironmentRequest - default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest)
Update your FinSpace environment.
This is a convenience which creates an instance of the UpdateEnvironmentRequest.Builder avoiding the need
to create one manually via UpdateEnvironmentRequest.builder()
updateEnvironmentRequest - A Consumer that will call methods on
UpdateEnvironmentRequest.Builder to create a
request.default CompletableFuture<UpdateKxClusterCodeConfigurationResponse> updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest updateKxClusterCodeConfigurationRequest)
Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.
updateKxClusterCodeConfigurationRequest - default CompletableFuture<UpdateKxClusterCodeConfigurationResponse> updateKxClusterCodeConfiguration(Consumer<UpdateKxClusterCodeConfigurationRequest.Builder> updateKxClusterCodeConfigurationRequest)
Allows you to update code configuration on a running cluster. By using this API you can update the code, the initialization script path, and the command line arguments for a specific cluster. The configuration that you want to update will override any existing configurations on the cluster.
This is a convenience which creates an instance of the UpdateKxClusterCodeConfigurationRequest.Builder
avoiding the need to create one manually via UpdateKxClusterCodeConfigurationRequest.builder()
updateKxClusterCodeConfigurationRequest - A Consumer that will call methods on
UpdateKxClusterCodeConfigurationRequest.Builder to
create a request.default CompletableFuture<UpdateKxClusterDatabasesResponse> updateKxClusterDatabases(UpdateKxClusterDatabasesRequest updateKxClusterDatabasesRequest)
Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths
to be cached. This API does not allow you to change a database name or add a database if you created a cluster
without one.
Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
updateKxClusterDatabasesRequest - default CompletableFuture<UpdateKxClusterDatabasesResponse> updateKxClusterDatabases(Consumer<UpdateKxClusterDatabasesRequest.Builder> updateKxClusterDatabasesRequest)
Updates the databases mounted on a kdb cluster, which includes the changesetId and all the dbPaths
to be cached. This API does not allow you to change a database name or add a database if you created a cluster
without one.
Using this API you can point a cluster to a different changeset and modify a list of partitions being cached.
This is a convenience which creates an instance of the UpdateKxClusterDatabasesRequest.Builder avoiding
the need to create one manually via UpdateKxClusterDatabasesRequest.builder()
updateKxClusterDatabasesRequest - A Consumer that will call methods on
UpdateKxClusterDatabasesRequest.Builder to create a
request.default CompletableFuture<UpdateKxDatabaseResponse> updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest)
Updates information for the given kdb database.
updateKxDatabaseRequest - default CompletableFuture<UpdateKxDatabaseResponse> updateKxDatabase(Consumer<UpdateKxDatabaseRequest.Builder> updateKxDatabaseRequest)
Updates information for the given kdb database.
This is a convenience which creates an instance of the UpdateKxDatabaseRequest.Builder avoiding the need
to create one manually via UpdateKxDatabaseRequest.builder()
updateKxDatabaseRequest - A Consumer that will call methods on
UpdateKxDatabaseRequest.Builder to create a
request.default CompletableFuture<UpdateKxEnvironmentResponse> updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest)
Updates information for the given kdb environment.
updateKxEnvironmentRequest - default CompletableFuture<UpdateKxEnvironmentResponse> updateKxEnvironment(Consumer<UpdateKxEnvironmentRequest.Builder> updateKxEnvironmentRequest)
Updates information for the given kdb environment.
This is a convenience which creates an instance of the UpdateKxEnvironmentRequest.Builder avoiding the
need to create one manually via UpdateKxEnvironmentRequest.builder()
updateKxEnvironmentRequest - A Consumer that will call methods on
UpdateKxEnvironmentRequest.Builder to create a
request.default CompletableFuture<UpdateKxEnvironmentNetworkResponse> updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest updateKxEnvironmentNetworkRequest)
Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.
Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
updateKxEnvironmentNetworkRequest - default CompletableFuture<UpdateKxEnvironmentNetworkResponse> updateKxEnvironmentNetwork(Consumer<UpdateKxEnvironmentNetworkRequest.Builder> updateKxEnvironmentNetworkRequest)
Updates environment network to connect to your internal network by using a transit gateway. This API supports request to create a transit gateway attachment from FinSpace VPC to your transit gateway ID and create a custom Route-53 outbound resolvers.
Once you send a request to update a network, you cannot change it again. Network update might require termination of any clusters that are running in the existing network.
This is a convenience which creates an instance of the UpdateKxEnvironmentNetworkRequest.Builder avoiding
the need to create one manually via UpdateKxEnvironmentNetworkRequest.builder()
updateKxEnvironmentNetworkRequest - A Consumer that will call methods on
UpdateKxEnvironmentNetworkRequest.Builder to create
a request.default CompletableFuture<UpdateKxUserResponse> updateKxUser(UpdateKxUserRequest updateKxUserRequest)
Updates the user details. You can only update the IAM role associated with a user.
updateKxUserRequest - default CompletableFuture<UpdateKxUserResponse> updateKxUser(Consumer<UpdateKxUserRequest.Builder> updateKxUserRequest)
Updates the user details. You can only update the IAM role associated with a user.
This is a convenience which creates an instance of the UpdateKxUserRequest.Builder avoiding the need to
create one manually via UpdateKxUserRequest.builder()
updateKxUserRequest - A Consumer that will call methods on
UpdateKxUserRequest.Builder to create a request.default FinspaceServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic FinspaceAsyncClient create()
FinspaceAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static FinspaceAsyncClientBuilder builder()
FinspaceAsyncClient.Copyright © 2023. All rights reserved.