Interface FinspaceAsyncClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.The asynchronous client performs non-blocking I/O when configured with any SdkAsyncHttpClient
supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
some cases such as credentials retrieval and endpoint discovery as part of the async API call.
The FinSpace management service provides the APIs for managing FinSpace environments.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic FinspaceAsyncClientBuilder
builder()
Create a builder that can be used to configure and create aFinspaceAsyncClient
.static FinspaceAsyncClient
create()
Create aFinspaceAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.createEnvironment
(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Deprecated.This method will be discontinued.createEnvironment
(CreateEnvironmentRequest createEnvironmentRequest) Deprecated.This method will be discontinued.createKxChangeset
(Consumer<CreateKxChangesetRequest.Builder> createKxChangesetRequest) Creates a changeset for a kdb database.createKxChangeset
(CreateKxChangesetRequest createKxChangesetRequest) Creates a changeset for a kdb database.default CompletableFuture
<CreateKxClusterResponse> createKxCluster
(Consumer<CreateKxClusterRequest.Builder> createKxClusterRequest) Creates a new kdb cluster.default CompletableFuture
<CreateKxClusterResponse> createKxCluster
(CreateKxClusterRequest createKxClusterRequest) Creates a new kdb cluster.createKxDatabase
(Consumer<CreateKxDatabaseRequest.Builder> createKxDatabaseRequest) Creates a new kdb database in the environment.createKxDatabase
(CreateKxDatabaseRequest createKxDatabaseRequest) Creates a new kdb database in the environment.createKxDataview
(Consumer<CreateKxDataviewRequest.Builder> createKxDataviewRequest) Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters.createKxDataview
(CreateKxDataviewRequest createKxDataviewRequest) Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters.createKxEnvironment
(Consumer<CreateKxEnvironmentRequest.Builder> createKxEnvironmentRequest) Creates a managed kdb environment for the account.createKxEnvironment
(CreateKxEnvironmentRequest createKxEnvironmentRequest) Creates a managed kdb environment for the account.createKxScalingGroup
(Consumer<CreateKxScalingGroupRequest.Builder> createKxScalingGroupRequest) Creates a new scaling group.createKxScalingGroup
(CreateKxScalingGroupRequest createKxScalingGroupRequest) Creates a new scaling group.default CompletableFuture
<CreateKxUserResponse> createKxUser
(Consumer<CreateKxUserRequest.Builder> createKxUserRequest) Creates a user in FinSpace kdb environment with an associated IAM role.default CompletableFuture
<CreateKxUserResponse> createKxUser
(CreateKxUserRequest createKxUserRequest) Creates a user in FinSpace kdb environment with an associated IAM role.default CompletableFuture
<CreateKxVolumeResponse> createKxVolume
(Consumer<CreateKxVolumeRequest.Builder> createKxVolumeRequest) Creates a new volume with a specific amount of throughput and storage capacity.default CompletableFuture
<CreateKxVolumeResponse> createKxVolume
(CreateKxVolumeRequest createKxVolumeRequest) Creates a new volume with a specific amount of throughput and storage capacity.deleteEnvironment
(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deprecated.This method will be discontinued.deleteEnvironment
(DeleteEnvironmentRequest deleteEnvironmentRequest) Deprecated.This method will be discontinued.default CompletableFuture
<DeleteKxClusterResponse> deleteKxCluster
(Consumer<DeleteKxClusterRequest.Builder> deleteKxClusterRequest) Deletes a kdb cluster.default CompletableFuture
<DeleteKxClusterResponse> deleteKxCluster
(DeleteKxClusterRequest deleteKxClusterRequest) Deletes a kdb cluster.deleteKxClusterNode
(Consumer<DeleteKxClusterNodeRequest.Builder> deleteKxClusterNodeRequest) Deletes the specified nodes from a cluster.deleteKxClusterNode
(DeleteKxClusterNodeRequest deleteKxClusterNodeRequest) Deletes the specified nodes from a cluster.deleteKxDatabase
(Consumer<DeleteKxDatabaseRequest.Builder> deleteKxDatabaseRequest) Deletes the specified database and all of its associated data.deleteKxDatabase
(DeleteKxDatabaseRequest deleteKxDatabaseRequest) Deletes the specified database and all of its associated data.deleteKxDataview
(Consumer<DeleteKxDataviewRequest.Builder> deleteKxDataviewRequest) Deletes the specified dataview.deleteKxDataview
(DeleteKxDataviewRequest deleteKxDataviewRequest) Deletes the specified dataview.deleteKxEnvironment
(Consumer<DeleteKxEnvironmentRequest.Builder> deleteKxEnvironmentRequest) Deletes the kdb environment.deleteKxEnvironment
(DeleteKxEnvironmentRequest deleteKxEnvironmentRequest) Deletes the kdb environment.deleteKxScalingGroup
(Consumer<DeleteKxScalingGroupRequest.Builder> deleteKxScalingGroupRequest) Deletes the specified scaling group.deleteKxScalingGroup
(DeleteKxScalingGroupRequest deleteKxScalingGroupRequest) Deletes the specified scaling group.default CompletableFuture
<DeleteKxUserResponse> deleteKxUser
(Consumer<DeleteKxUserRequest.Builder> deleteKxUserRequest) Deletes a user in the specified kdb environment.default CompletableFuture
<DeleteKxUserResponse> deleteKxUser
(DeleteKxUserRequest deleteKxUserRequest) Deletes a user in the specified kdb environment.default CompletableFuture
<DeleteKxVolumeResponse> deleteKxVolume
(Consumer<DeleteKxVolumeRequest.Builder> deleteKxVolumeRequest) Deletes a volume.default CompletableFuture
<DeleteKxVolumeResponse> deleteKxVolume
(DeleteKxVolumeRequest deleteKxVolumeRequest) Deletes a volume.default CompletableFuture
<GetEnvironmentResponse> getEnvironment
(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Deprecated.This method will be discontinued.default CompletableFuture
<GetEnvironmentResponse> getEnvironment
(GetEnvironmentRequest getEnvironmentRequest) Deprecated.This method will be discontinued.default CompletableFuture
<GetKxChangesetResponse> getKxChangeset
(Consumer<GetKxChangesetRequest.Builder> getKxChangesetRequest) Returns information about a kdb changeset.default CompletableFuture
<GetKxChangesetResponse> getKxChangeset
(GetKxChangesetRequest getKxChangesetRequest) Returns information about a kdb changeset.default CompletableFuture
<GetKxClusterResponse> getKxCluster
(Consumer<GetKxClusterRequest.Builder> getKxClusterRequest) Retrieves information about a kdb cluster.default CompletableFuture
<GetKxClusterResponse> getKxCluster
(GetKxClusterRequest getKxClusterRequest) Retrieves information about a kdb cluster.getKxConnectionString
(Consumer<GetKxConnectionStringRequest.Builder> getKxConnectionStringRequest) Retrieves a connection string for a user to connect to a kdb cluster.getKxConnectionString
(GetKxConnectionStringRequest getKxConnectionStringRequest) Retrieves a connection string for a user to connect to a kdb cluster.default CompletableFuture
<GetKxDatabaseResponse> getKxDatabase
(Consumer<GetKxDatabaseRequest.Builder> getKxDatabaseRequest) Returns database information for the specified environment ID.default CompletableFuture
<GetKxDatabaseResponse> getKxDatabase
(GetKxDatabaseRequest getKxDatabaseRequest) Returns database information for the specified environment ID.default CompletableFuture
<GetKxDataviewResponse> getKxDataview
(Consumer<GetKxDataviewRequest.Builder> getKxDataviewRequest) Retrieves details of the dataview.default CompletableFuture
<GetKxDataviewResponse> getKxDataview
(GetKxDataviewRequest getKxDataviewRequest) Retrieves details of the dataview.getKxEnvironment
(Consumer<GetKxEnvironmentRequest.Builder> getKxEnvironmentRequest) Retrieves all the information for the specified kdb environment.getKxEnvironment
(GetKxEnvironmentRequest getKxEnvironmentRequest) Retrieves all the information for the specified kdb environment.getKxScalingGroup
(Consumer<GetKxScalingGroupRequest.Builder> getKxScalingGroupRequest) Retrieves details of a scaling group.getKxScalingGroup
(GetKxScalingGroupRequest getKxScalingGroupRequest) Retrieves details of a scaling group.default CompletableFuture
<GetKxUserResponse> getKxUser
(Consumer<GetKxUserRequest.Builder> getKxUserRequest) Retrieves information about the specified kdb user.default CompletableFuture
<GetKxUserResponse> getKxUser
(GetKxUserRequest getKxUserRequest) Retrieves information about the specified kdb user.default CompletableFuture
<GetKxVolumeResponse> getKxVolume
(Consumer<GetKxVolumeRequest.Builder> getKxVolumeRequest) Retrieves the information about the volume.default CompletableFuture
<GetKxVolumeResponse> getKxVolume
(GetKxVolumeRequest getKxVolumeRequest) Retrieves the information about the volume.listEnvironments
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Deprecated.This method will be discontinued.listEnvironments
(ListEnvironmentsRequest listEnvironmentsRequest) Deprecated.This method will be discontinued.listKxChangesets
(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest) Returns a list of all the changesets for a database.listKxChangesets
(ListKxChangesetsRequest listKxChangesetsRequest) Returns a list of all the changesets for a database.default ListKxChangesetsPublisher
listKxChangesetsPaginator
(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest) This is a variant oflistKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest)
operation.default ListKxChangesetsPublisher
listKxChangesetsPaginator
(ListKxChangesetsRequest listKxChangesetsRequest) This is a variant oflistKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest)
operation.listKxClusterNodes
(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest) Lists all the nodes in a kdb cluster.listKxClusterNodes
(ListKxClusterNodesRequest listKxClusterNodesRequest) Lists all the nodes in a kdb cluster.default ListKxClusterNodesPublisher
listKxClusterNodesPaginator
(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest) This is a variant oflistKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest)
operation.default ListKxClusterNodesPublisher
listKxClusterNodesPaginator
(ListKxClusterNodesRequest listKxClusterNodesRequest) This is a variant oflistKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest)
operation.default CompletableFuture
<ListKxClustersResponse> listKxClusters
(Consumer<ListKxClustersRequest.Builder> listKxClustersRequest) Returns a list of clusters.default CompletableFuture
<ListKxClustersResponse> listKxClusters
(ListKxClustersRequest listKxClustersRequest) Returns a list of clusters.default CompletableFuture
<ListKxDatabasesResponse> listKxDatabases
(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest) Returns a list of all the databases in the kdb environment.default CompletableFuture
<ListKxDatabasesResponse> listKxDatabases
(ListKxDatabasesRequest listKxDatabasesRequest) Returns a list of all the databases in the kdb environment.default ListKxDatabasesPublisher
listKxDatabasesPaginator
(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest) This is a variant oflistKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest)
operation.default ListKxDatabasesPublisher
listKxDatabasesPaginator
(ListKxDatabasesRequest listKxDatabasesRequest) This is a variant oflistKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest)
operation.default CompletableFuture
<ListKxDataviewsResponse> listKxDataviews
(Consumer<ListKxDataviewsRequest.Builder> listKxDataviewsRequest) Returns a list of all the dataviews in the database.default CompletableFuture
<ListKxDataviewsResponse> listKxDataviews
(ListKxDataviewsRequest listKxDataviewsRequest) Returns a list of all the dataviews in the database.default ListKxDataviewsPublisher
listKxDataviewsPaginator
(Consumer<ListKxDataviewsRequest.Builder> listKxDataviewsRequest) This is a variant oflistKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
operation.default ListKxDataviewsPublisher
listKxDataviewsPaginator
(ListKxDataviewsRequest listKxDataviewsRequest) This is a variant oflistKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
operation.listKxEnvironments
(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest) Returns a list of kdb environments created in an account.listKxEnvironments
(ListKxEnvironmentsRequest listKxEnvironmentsRequest) Returns a list of kdb environments created in an account.default ListKxEnvironmentsPublisher
listKxEnvironmentsPaginator
(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest) This is a variant oflistKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest)
operation.default ListKxEnvironmentsPublisher
listKxEnvironmentsPaginator
(ListKxEnvironmentsRequest listKxEnvironmentsRequest) This is a variant oflistKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest)
operation.listKxScalingGroups
(Consumer<ListKxScalingGroupsRequest.Builder> listKxScalingGroupsRequest) Returns a list of scaling groups in a kdb environment.listKxScalingGroups
(ListKxScalingGroupsRequest listKxScalingGroupsRequest) Returns a list of scaling groups in a kdb environment.default ListKxScalingGroupsPublisher
listKxScalingGroupsPaginator
(Consumer<ListKxScalingGroupsRequest.Builder> listKxScalingGroupsRequest) This is a variant oflistKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
operation.default ListKxScalingGroupsPublisher
listKxScalingGroupsPaginator
(ListKxScalingGroupsRequest listKxScalingGroupsRequest) This is a variant oflistKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
operation.default CompletableFuture
<ListKxUsersResponse> listKxUsers
(Consumer<ListKxUsersRequest.Builder> listKxUsersRequest) Lists all the users in a kdb environment.default CompletableFuture
<ListKxUsersResponse> listKxUsers
(ListKxUsersRequest listKxUsersRequest) Lists all the users in a kdb environment.default CompletableFuture
<ListKxVolumesResponse> listKxVolumes
(Consumer<ListKxVolumesRequest.Builder> listKxVolumesRequest) Lists all the volumes in a kdb environment.default CompletableFuture
<ListKxVolumesResponse> listKxVolumes
(ListKxVolumesRequest listKxVolumesRequest) Lists all the volumes in a kdb environment.listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) A list of all tags for a resource.listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) A list of all tags for a resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture
<TagResourceResponse> tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds metadata tags to a FinSpace resource.default CompletableFuture
<TagResourceResponse> tagResource
(TagResourceRequest tagResourceRequest) Adds metadata tags to a FinSpace resource.default CompletableFuture
<UntagResourceResponse> untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes metadata tags from a FinSpace resource.default CompletableFuture
<UntagResourceResponse> untagResource
(UntagResourceRequest untagResourceRequest) Removes metadata tags from a FinSpace resource.updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Deprecated.This method will be discontinued.updateEnvironment
(UpdateEnvironmentRequest updateEnvironmentRequest) Deprecated.This method will be discontinued.updateKxClusterCodeConfiguration
(Consumer<UpdateKxClusterCodeConfigurationRequest.Builder> updateKxClusterCodeConfigurationRequest) Allows you to update code configuration on a running cluster.updateKxClusterCodeConfiguration
(UpdateKxClusterCodeConfigurationRequest updateKxClusterCodeConfigurationRequest) Allows you to update code configuration on a running cluster.updateKxClusterDatabases
(Consumer<UpdateKxClusterDatabasesRequest.Builder> updateKxClusterDatabasesRequest) Updates the databases mounted on a kdb cluster, which includes thechangesetId
and all the dbPaths to be cached.updateKxClusterDatabases
(UpdateKxClusterDatabasesRequest updateKxClusterDatabasesRequest) Updates the databases mounted on a kdb cluster, which includes thechangesetId
and all the dbPaths to be cached.updateKxDatabase
(Consumer<UpdateKxDatabaseRequest.Builder> updateKxDatabaseRequest) Updates information for the given kdb database.updateKxDatabase
(UpdateKxDatabaseRequest updateKxDatabaseRequest) Updates information for the given kdb database.updateKxDataview
(Consumer<UpdateKxDataviewRequest.Builder> updateKxDataviewRequest) Updates the specified dataview.updateKxDataview
(UpdateKxDataviewRequest updateKxDataviewRequest) Updates the specified dataview.updateKxEnvironment
(Consumer<UpdateKxEnvironmentRequest.Builder> updateKxEnvironmentRequest) Updates information for the given kdb environment.updateKxEnvironment
(UpdateKxEnvironmentRequest updateKxEnvironmentRequest) Updates information for the given kdb environment.updateKxEnvironmentNetwork
(Consumer<UpdateKxEnvironmentNetworkRequest.Builder> updateKxEnvironmentNetworkRequest) Updates environment network to connect to your internal network by using a transit gateway.updateKxEnvironmentNetwork
(UpdateKxEnvironmentNetworkRequest updateKxEnvironmentNetworkRequest) Updates environment network to connect to your internal network by using a transit gateway.default CompletableFuture
<UpdateKxUserResponse> updateKxUser
(Consumer<UpdateKxUserRequest.Builder> updateKxUserRequest) Updates the user details.default CompletableFuture
<UpdateKxUserResponse> updateKxUser
(UpdateKxUserRequest updateKxUserRequest) Updates the user details.default CompletableFuture
<UpdateKxVolumeResponse> updateKxVolume
(Consumer<UpdateKxVolumeRequest.Builder> updateKxVolumeRequest) Updates the throughput or capacity of a volume.default CompletableFuture
<UpdateKxVolumeResponse> updateKxVolume
(UpdateKxVolumeRequest updateKxVolumeRequest) Updates the throughput or capacity of a volume.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
createEnvironment
@Deprecated default CompletableFuture<CreateEnvironmentResponse> createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) Deprecated.This method will be discontinued.Create a new FinSpace environment.
- Parameters:
createEnvironmentRequest
-- Returns:
- A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
- LimitExceededException A service limit or quota is exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createEnvironment
@Deprecated default CompletableFuture<CreateEnvironmentResponse> createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Deprecated.This method will be discontinued.Create a new FinSpace environment.
This is a convenience which creates an instance of the
CreateEnvironmentRequest.Builder
avoiding the need to create one manually viaCreateEnvironmentRequest.builder()
- Parameters:
createEnvironmentRequest
- AConsumer
that will call methods onCreateEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
- LimitExceededException A service limit or quota is exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxChangeset
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.
- Parameters:
createKxChangesetRequest
-- Returns:
- A Java Future containing the result of the CreateKxChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- LimitExceededException A service limit or quota is exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxChangeset
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 viaCreateKxChangesetRequest.builder()
- Parameters:
createKxChangesetRequest
- AConsumer
that will call methods onCreateKxChangesetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKxChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- LimitExceededException A service limit or quota is exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxCluster
default CompletableFuture<CreateKxClusterResponse> createKxCluster(CreateKxClusterRequest createKxClusterRequest) Creates a new kdb cluster.
- Parameters:
createKxClusterRequest
-- Returns:
- A Java Future containing the result of the CreateKxCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxCluster
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 viaCreateKxClusterRequest.builder()
- Parameters:
createKxClusterRequest
- AConsumer
that will call methods onCreateKxClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKxCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxDatabase
default CompletableFuture<CreateKxDatabaseResponse> createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest) Creates a new kdb database in the environment.
- Parameters:
createKxDatabaseRequest
-- Returns:
- A Java Future containing the result of the CreateKxDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceAlreadyExistsException The specified resource group already exists.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A service limit or quota is exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxDatabase
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 viaCreateKxDatabaseRequest.builder()
- Parameters:
createKxDatabaseRequest
- AConsumer
that will call methods onCreateKxDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKxDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceAlreadyExistsException The specified resource group already exists.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A service limit or quota is exceeded.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxDataview
default CompletableFuture<CreateKxDataviewResponse> createKxDataview(CreateKxDataviewRequest createKxDataviewRequest) Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.
- Parameters:
createKxDataviewRequest
-- Returns:
- A Java Future containing the result of the CreateKxDataview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- LimitExceededException A service limit or quota is exceeded.
- ResourceAlreadyExistsException The specified resource group already exists.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxDataview
default CompletableFuture<CreateKxDataviewResponse> createKxDataview(Consumer<CreateKxDataviewRequest.Builder> createKxDataviewRequest) Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on kdb clusters. Dataviews are only available for clusters running on a scaling group. They are not supported on dedicated clusters.
This is a convenience which creates an instance of the
CreateKxDataviewRequest.Builder
avoiding the need to create one manually viaCreateKxDataviewRequest.builder()
- Parameters:
createKxDataviewRequest
- AConsumer
that will call methods onCreateKxDataviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKxDataview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- LimitExceededException A service limit or quota is exceeded.
- ResourceAlreadyExistsException The specified resource group already exists.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxEnvironment
default CompletableFuture<CreateKxEnvironmentResponse> createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest) Creates a managed kdb environment for the account.
- Parameters:
createKxEnvironmentRequest
-- Returns:
- A Java Future containing the result of the CreateKxEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxEnvironment
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 viaCreateKxEnvironmentRequest.builder()
- Parameters:
createKxEnvironmentRequest
- AConsumer
that will call methods onCreateKxEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKxEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ServiceQuotaExceededException You have exceeded your service quota. To perform the requested action, remove some of the relevant resources, or use Service Quotas to request a service quota increase.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxScalingGroup
default CompletableFuture<CreateKxScalingGroupResponse> createKxScalingGroup(CreateKxScalingGroupRequest createKxScalingGroupRequest) Creates a new scaling group.
- Parameters:
createKxScalingGroupRequest
-- Returns:
- A Java Future containing the result of the CreateKxScalingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxScalingGroup
default CompletableFuture<CreateKxScalingGroupResponse> createKxScalingGroup(Consumer<CreateKxScalingGroupRequest.Builder> createKxScalingGroupRequest) Creates a new scaling group.
This is a convenience which creates an instance of the
CreateKxScalingGroupRequest.Builder
avoiding the need to create one manually viaCreateKxScalingGroupRequest.builder()
- Parameters:
createKxScalingGroupRequest
- AConsumer
that will call methods onCreateKxScalingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKxScalingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxUser
default CompletableFuture<CreateKxUserResponse> createKxUser(CreateKxUserRequest createKxUserRequest) Creates a user in FinSpace kdb environment with an associated IAM role.
- Parameters:
createKxUserRequest
-- Returns:
- A Java Future containing the result of the CreateKxUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceAlreadyExistsException The specified resource group already exists.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxUser
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 viaCreateKxUserRequest.builder()
- Parameters:
createKxUserRequest
- AConsumer
that will call methods onCreateKxUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKxUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceAlreadyExistsException The specified resource group already exists.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxVolume
default CompletableFuture<CreateKxVolumeResponse> createKxVolume(CreateKxVolumeRequest createKxVolumeRequest) Creates a new volume with a specific amount of throughput and storage capacity.
- Parameters:
createKxVolumeRequest
-- Returns:
- A Java Future containing the result of the CreateKxVolume operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- ResourceAlreadyExistsException The specified resource group already exists.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createKxVolume
default CompletableFuture<CreateKxVolumeResponse> createKxVolume(Consumer<CreateKxVolumeRequest.Builder> createKxVolumeRequest) Creates a new volume with a specific amount of throughput and storage capacity.
This is a convenience which creates an instance of the
CreateKxVolumeRequest.Builder
avoiding the need to create one manually viaCreateKxVolumeRequest.builder()
- Parameters:
createKxVolumeRequest
- AConsumer
that will call methods onCreateKxVolumeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the CreateKxVolume operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- ResourceAlreadyExistsException The specified resource group already exists.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
@Deprecated default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) Deprecated.This method will be discontinued.Delete an FinSpace environment.
- Parameters:
deleteEnvironmentRequest
-- Returns:
- A Java Future containing the result of the DeleteEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteEnvironment
@Deprecated default CompletableFuture<DeleteEnvironmentResponse> deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deprecated.This method will be discontinued.Delete an FinSpace environment.
This is a convenience which creates an instance of the
DeleteEnvironmentRequest.Builder
avoiding the need to create one manually viaDeleteEnvironmentRequest.builder()
- Parameters:
deleteEnvironmentRequest
- AConsumer
that will call methods onDeleteEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxCluster
default CompletableFuture<DeleteKxClusterResponse> deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest) Deletes a kdb cluster.
- Parameters:
deleteKxClusterRequest
-- Returns:
- A Java Future containing the result of the DeleteKxCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxCluster
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 viaDeleteKxClusterRequest.builder()
- Parameters:
deleteKxClusterRequest
- AConsumer
that will call methods onDeleteKxClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKxCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxClusterNode
default CompletableFuture<DeleteKxClusterNodeResponse> deleteKxClusterNode(DeleteKxClusterNodeRequest deleteKxClusterNodeRequest) Deletes the specified nodes from a cluster.
- Parameters:
deleteKxClusterNodeRequest
-- Returns:
- A Java Future containing the result of the DeleteKxClusterNode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxClusterNode
default CompletableFuture<DeleteKxClusterNodeResponse> deleteKxClusterNode(Consumer<DeleteKxClusterNodeRequest.Builder> deleteKxClusterNodeRequest) Deletes the specified nodes from a cluster.
This is a convenience which creates an instance of the
DeleteKxClusterNodeRequest.Builder
avoiding the need to create one manually viaDeleteKxClusterNodeRequest.builder()
- Parameters:
deleteKxClusterNodeRequest
- AConsumer
that will call methods onDeleteKxClusterNodeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKxClusterNode operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxDatabase
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.
- Parameters:
deleteKxDatabaseRequest
-- Returns:
- A Java Future containing the result of the DeleteKxDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxDatabase
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 viaDeleteKxDatabaseRequest.builder()
- Parameters:
deleteKxDatabaseRequest
- AConsumer
that will call methods onDeleteKxDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKxDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxDataview
default CompletableFuture<DeleteKxDataviewResponse> deleteKxDataview(DeleteKxDataviewRequest deleteKxDataviewRequest) Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
- Parameters:
deleteKxDataviewRequest
-- Returns:
- A Java Future containing the result of the DeleteKxDataview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxDataview
default CompletableFuture<DeleteKxDataviewResponse> deleteKxDataview(Consumer<DeleteKxDataviewRequest.Builder> deleteKxDataviewRequest) Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
This is a convenience which creates an instance of the
DeleteKxDataviewRequest.Builder
avoiding the need to create one manually viaDeleteKxDataviewRequest.builder()
- Parameters:
deleteKxDataviewRequest
- AConsumer
that will call methods onDeleteKxDataviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKxDataview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxEnvironment
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.
- Parameters:
deleteKxEnvironmentRequest
-- Returns:
- A Java Future containing the result of the DeleteKxEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxEnvironment
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 viaDeleteKxEnvironmentRequest.builder()
- Parameters:
deleteKxEnvironmentRequest
- AConsumer
that will call methods onDeleteKxEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKxEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxScalingGroup
default CompletableFuture<DeleteKxScalingGroupResponse> deleteKxScalingGroup(DeleteKxScalingGroupRequest deleteKxScalingGroupRequest) Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.
- Parameters:
deleteKxScalingGroupRequest
-- Returns:
- A Java Future containing the result of the DeleteKxScalingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxScalingGroup
default CompletableFuture<DeleteKxScalingGroupResponse> deleteKxScalingGroup(Consumer<DeleteKxScalingGroupRequest.Builder> deleteKxScalingGroupRequest) Deletes the specified scaling group. This action is irreversible. You cannot delete a scaling group until all the clusters running on it have been deleted.
This is a convenience which creates an instance of the
DeleteKxScalingGroupRequest.Builder
avoiding the need to create one manually viaDeleteKxScalingGroupRequest.builder()
- Parameters:
deleteKxScalingGroupRequest
- AConsumer
that will call methods onDeleteKxScalingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKxScalingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxUser
default CompletableFuture<DeleteKxUserResponse> deleteKxUser(DeleteKxUserRequest deleteKxUserRequest) Deletes a user in the specified kdb environment.
- Parameters:
deleteKxUserRequest
-- Returns:
- A Java Future containing the result of the DeleteKxUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxUser
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 viaDeleteKxUserRequest.builder()
- Parameters:
deleteKxUserRequest
- AConsumer
that will call methods onDeleteKxUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKxUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxVolume
default CompletableFuture<DeleteKxVolumeResponse> deleteKxVolume(DeleteKxVolumeRequest deleteKxVolumeRequest) Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.
- Parameters:
deleteKxVolumeRequest
-- Returns:
- A Java Future containing the result of the DeleteKxVolume operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteKxVolume
default CompletableFuture<DeleteKxVolumeResponse> deleteKxVolume(Consumer<DeleteKxVolumeRequest.Builder> deleteKxVolumeRequest) Deletes a volume. You can only delete a volume if it's not attached to a cluster or a dataview. When a volume is deleted, any data on the volume is lost. This action is irreversible.
This is a convenience which creates an instance of the
DeleteKxVolumeRequest.Builder
avoiding the need to create one manually viaDeleteKxVolumeRequest.builder()
- Parameters:
deleteKxVolumeRequest
- AConsumer
that will call methods onDeleteKxVolumeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the DeleteKxVolume operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
@Deprecated default CompletableFuture<GetEnvironmentResponse> getEnvironment(GetEnvironmentRequest getEnvironmentRequest) Deprecated.This method will be discontinued.Returns the FinSpace environment object.
- Parameters:
getEnvironmentRequest
-- Returns:
- A Java Future containing the result of the GetEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getEnvironment
@Deprecated default CompletableFuture<GetEnvironmentResponse> getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Deprecated.This method will be discontinued.Returns the FinSpace environment object.
This is a convenience which creates an instance of the
GetEnvironmentRequest.Builder
avoiding the need to create one manually viaGetEnvironmentRequest.builder()
- Parameters:
getEnvironmentRequest
- AConsumer
that will call methods onGetEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxChangeset
default CompletableFuture<GetKxChangesetResponse> getKxChangeset(GetKxChangesetRequest getKxChangesetRequest) Returns information about a kdb changeset.
- Parameters:
getKxChangesetRequest
-- Returns:
- A Java Future containing the result of the GetKxChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxChangeset
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 viaGetKxChangesetRequest.builder()
- Parameters:
getKxChangesetRequest
- AConsumer
that will call methods onGetKxChangesetRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxCluster
default CompletableFuture<GetKxClusterResponse> getKxCluster(GetKxClusterRequest getKxClusterRequest) Retrieves information about a kdb cluster.
- Parameters:
getKxClusterRequest
-- Returns:
- A Java Future containing the result of the GetKxCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxCluster
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 viaGetKxClusterRequest.builder()
- Parameters:
getKxClusterRequest
- AConsumer
that will call methods onGetKxClusterRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxCluster operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxConnectionString
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.
- Parameters:
getKxConnectionStringRequest
-- Returns:
- A Java Future containing the result of the GetKxConnectionString operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxConnectionString
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 viaGetKxConnectionStringRequest.builder()
- Parameters:
getKxConnectionStringRequest
- AConsumer
that will call methods onGetKxConnectionStringRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxConnectionString operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxDatabase
default CompletableFuture<GetKxDatabaseResponse> getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest) Returns database information for the specified environment ID.
- Parameters:
getKxDatabaseRequest
-- Returns:
- A Java Future containing the result of the GetKxDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxDatabase
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 viaGetKxDatabaseRequest.builder()
- Parameters:
getKxDatabaseRequest
- AConsumer
that will call methods onGetKxDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxDataview
default CompletableFuture<GetKxDataviewResponse> getKxDataview(GetKxDataviewRequest getKxDataviewRequest) Retrieves details of the dataview.
- Parameters:
getKxDataviewRequest
-- Returns:
- A Java Future containing the result of the GetKxDataview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxDataview
default CompletableFuture<GetKxDataviewResponse> getKxDataview(Consumer<GetKxDataviewRequest.Builder> getKxDataviewRequest) Retrieves details of the dataview.
This is a convenience which creates an instance of the
GetKxDataviewRequest.Builder
avoiding the need to create one manually viaGetKxDataviewRequest.builder()
- Parameters:
getKxDataviewRequest
- AConsumer
that will call methods onGetKxDataviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxDataview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxEnvironment
default CompletableFuture<GetKxEnvironmentResponse> getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest) Retrieves all the information for the specified kdb environment.
- Parameters:
getKxEnvironmentRequest
-- Returns:
- A Java Future containing the result of the GetKxEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxEnvironment
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 viaGetKxEnvironmentRequest.builder()
- Parameters:
getKxEnvironmentRequest
- AConsumer
that will call methods onGetKxEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxScalingGroup
default CompletableFuture<GetKxScalingGroupResponse> getKxScalingGroup(GetKxScalingGroupRequest getKxScalingGroupRequest) Retrieves details of a scaling group.
- Parameters:
getKxScalingGroupRequest
-- Returns:
- A Java Future containing the result of the GetKxScalingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxScalingGroup
default CompletableFuture<GetKxScalingGroupResponse> getKxScalingGroup(Consumer<GetKxScalingGroupRequest.Builder> getKxScalingGroupRequest) Retrieves details of a scaling group.
This is a convenience which creates an instance of the
GetKxScalingGroupRequest.Builder
avoiding the need to create one manually viaGetKxScalingGroupRequest.builder()
- Parameters:
getKxScalingGroupRequest
- AConsumer
that will call methods onGetKxScalingGroupRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxScalingGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxUser
Retrieves information about the specified kdb user.
- Parameters:
getKxUserRequest
-- Returns:
- A Java Future containing the result of the GetKxUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxUser
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 viaGetKxUserRequest.builder()
- Parameters:
getKxUserRequest
- AConsumer
that will call methods onGetKxUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxVolume
Retrieves the information about the volume.
- Parameters:
getKxVolumeRequest
-- Returns:
- A Java Future containing the result of the GetKxVolume operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getKxVolume
default CompletableFuture<GetKxVolumeResponse> getKxVolume(Consumer<GetKxVolumeRequest.Builder> getKxVolumeRequest) Retrieves the information about the volume.
This is a convenience which creates an instance of the
GetKxVolumeRequest.Builder
avoiding the need to create one manually viaGetKxVolumeRequest.builder()
- Parameters:
getKxVolumeRequest
- AConsumer
that will call methods onGetKxVolumeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the GetKxVolume operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
@Deprecated default CompletableFuture<ListEnvironmentsResponse> listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) Deprecated.This method will be discontinued.A list of all of your FinSpace environments.
- Parameters:
listEnvironmentsRequest
-- Returns:
- A Java Future containing the result of the ListEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listEnvironments
@Deprecated default CompletableFuture<ListEnvironmentsResponse> listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Deprecated.This method will be discontinued.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 viaListEnvironmentsRequest.builder()
- Parameters:
listEnvironmentsRequest
- AConsumer
that will call methods onListEnvironmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxChangesets
default CompletableFuture<ListKxChangesetsResponse> listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest) Returns a list of all the changesets for a database.
- Parameters:
listKxChangesetsRequest
-- Returns:
- A Java Future containing the result of the ListKxChangesets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxChangesets
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 viaListKxChangesetsRequest.builder()
- Parameters:
listKxChangesetsRequest
- AConsumer
that will call methods onListKxChangesetsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxChangesets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxChangesetsPaginator
default ListKxChangesetsPublisher listKxChangesetsPaginator(ListKxChangesetsRequest listKxChangesetsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxChangesetsPublisher publisher = client.listKxChangesetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listKxChangesetsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxChangesetsPaginator
default ListKxChangesetsPublisher listKxChangesetsPaginator(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxChangesetsPublisher publisher = client.listKxChangesetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListKxChangesetsRequest.builder()
- Parameters:
listKxChangesetsRequest
- AConsumer
that will call methods onListKxChangesetsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxClusterNodes
default CompletableFuture<ListKxClusterNodesResponse> listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest) Lists all the nodes in a kdb cluster.
- Parameters:
listKxClusterNodesRequest
-- Returns:
- A Java Future containing the result of the ListKxClusterNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxClusterNodes
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 viaListKxClusterNodesRequest.builder()
- Parameters:
listKxClusterNodesRequest
- AConsumer
that will call methods onListKxClusterNodesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxClusterNodes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxClusterNodesPaginator
default ListKxClusterNodesPublisher listKxClusterNodesPaginator(ListKxClusterNodesRequest listKxClusterNodesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesPublisher publisher = client.listKxClusterNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listKxClusterNodesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxClusterNodesPaginator
default ListKxClusterNodesPublisher listKxClusterNodesPaginator(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesPublisher publisher = client.listKxClusterNodesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListKxClusterNodesRequest.builder()
- Parameters:
listKxClusterNodesRequest
- AConsumer
that will call methods onListKxClusterNodesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxClusters
default CompletableFuture<ListKxClustersResponse> listKxClusters(ListKxClustersRequest listKxClustersRequest) Returns a list of clusters.
- Parameters:
listKxClustersRequest
-- Returns:
- A Java Future containing the result of the ListKxClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxClusters
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 viaListKxClustersRequest.builder()
- Parameters:
listKxClustersRequest
- AConsumer
that will call methods onListKxClustersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxClusters operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxDatabases
default CompletableFuture<ListKxDatabasesResponse> listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest) Returns a list of all the databases in the kdb environment.
- Parameters:
listKxDatabasesRequest
-- Returns:
- A Java Future containing the result of the ListKxDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxDatabases
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 viaListKxDatabasesRequest.builder()
- Parameters:
listKxDatabasesRequest
- AConsumer
that will call methods onListKxDatabasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxDatabasesPaginator
default ListKxDatabasesPublisher listKxDatabasesPaginator(ListKxDatabasesRequest listKxDatabasesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxDatabasesPublisher publisher = client.listKxDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listKxDatabasesRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxDatabasesPaginator
default ListKxDatabasesPublisher listKxDatabasesPaginator(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxDatabasesPublisher publisher = client.listKxDatabasesPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListKxDatabasesRequest.builder()
- Parameters:
listKxDatabasesRequest
- AConsumer
that will call methods onListKxDatabasesRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxDataviews
default CompletableFuture<ListKxDataviewsResponse> listKxDataviews(ListKxDataviewsRequest listKxDataviewsRequest) Returns a list of all the dataviews in the database.
- Parameters:
listKxDataviewsRequest
-- Returns:
- A Java Future containing the result of the ListKxDataviews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxDataviews
default CompletableFuture<ListKxDataviewsResponse> listKxDataviews(Consumer<ListKxDataviewsRequest.Builder> listKxDataviewsRequest) Returns a list of all the dataviews in the database.
This is a convenience which creates an instance of the
ListKxDataviewsRequest.Builder
avoiding the need to create one manually viaListKxDataviewsRequest.builder()
- Parameters:
listKxDataviewsRequest
- AConsumer
that will call methods onListKxDataviewsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxDataviews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxDataviewsPaginator
default ListKxDataviewsPublisher listKxDataviewsPaginator(ListKxDataviewsRequest listKxDataviewsRequest) This is a variant of
listKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxDataviewsPublisher publisher = client.listKxDataviewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.finspace.paginators.ListKxDataviewsPublisher publisher = client.listKxDataviewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxDataviewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspace.model.ListKxDataviewsResponse response) { //... }; });
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
listKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
operation.- Parameters:
listKxDataviewsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxDataviewsPaginator
default ListKxDataviewsPublisher listKxDataviewsPaginator(Consumer<ListKxDataviewsRequest.Builder> listKxDataviewsRequest) This is a variant of
listKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxDataviewsPublisher publisher = client.listKxDataviewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.finspace.paginators.ListKxDataviewsPublisher publisher = client.listKxDataviewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxDataviewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspace.model.ListKxDataviewsResponse response) { //... }; });
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
listKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
operation.
This is a convenience which creates an instance of the
ListKxDataviewsRequest.Builder
avoiding the need to create one manually viaListKxDataviewsRequest.builder()
- Parameters:
listKxDataviewsRequest
- AConsumer
that will call methods onListKxDataviewsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxEnvironments
default CompletableFuture<ListKxEnvironmentsResponse> listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest) Returns a list of kdb environments created in an account.
- Parameters:
listKxEnvironmentsRequest
-- Returns:
- A Java Future containing the result of the ListKxEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxEnvironments
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 viaListKxEnvironmentsRequest.builder()
- Parameters:
listKxEnvironmentsRequest
- AConsumer
that will call methods onListKxEnvironmentsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxEnvironments operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxEnvironmentsPaginator
default ListKxEnvironmentsPublisher listKxEnvironmentsPaginator(ListKxEnvironmentsRequest listKxEnvironmentsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsPublisher publisher = client.listKxEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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.- Parameters:
listKxEnvironmentsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxEnvironmentsPaginator
default ListKxEnvironmentsPublisher listKxEnvironmentsPaginator(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest) 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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsPublisher publisher = client.listKxEnvironmentsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
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) { //... }; });
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 viaListKxEnvironmentsRequest.builder()
- Parameters:
listKxEnvironmentsRequest
- AConsumer
that will call methods onListKxEnvironmentsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxScalingGroups
default CompletableFuture<ListKxScalingGroupsResponse> listKxScalingGroups(ListKxScalingGroupsRequest listKxScalingGroupsRequest) Returns a list of scaling groups in a kdb environment.
- Parameters:
listKxScalingGroupsRequest
-- Returns:
- A Java Future containing the result of the ListKxScalingGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxScalingGroups
default CompletableFuture<ListKxScalingGroupsResponse> listKxScalingGroups(Consumer<ListKxScalingGroupsRequest.Builder> listKxScalingGroupsRequest) Returns a list of scaling groups in a kdb environment.
This is a convenience which creates an instance of the
ListKxScalingGroupsRequest.Builder
avoiding the need to create one manually viaListKxScalingGroupsRequest.builder()
- Parameters:
listKxScalingGroupsRequest
- AConsumer
that will call methods onListKxScalingGroupsRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxScalingGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxScalingGroupsPaginator
default ListKxScalingGroupsPublisher listKxScalingGroupsPaginator(ListKxScalingGroupsRequest listKxScalingGroupsRequest) This is a variant of
listKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsPublisher publisher = client.listKxScalingGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsPublisher publisher = client.listKxScalingGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsResponse response) { //... }; });
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
listKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
operation.- Parameters:
listKxScalingGroupsRequest
-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxScalingGroupsPaginator
default ListKxScalingGroupsPublisher listKxScalingGroupsPaginator(Consumer<ListKxScalingGroupsRequest.Builder> listKxScalingGroupsRequest) This is a variant of
listKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
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 newSubscription
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 methodsoftware.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsPublisher publisher = client.listKxScalingGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
software.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsPublisher publisher = client.listKxScalingGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsResponse response) { //... }; });
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
listKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
operation.
This is a convenience which creates an instance of the
ListKxScalingGroupsRequest.Builder
avoiding the need to create one manually viaListKxScalingGroupsRequest.builder()
- Parameters:
listKxScalingGroupsRequest
- AConsumer
that will call methods onListKxScalingGroupsRequest.Builder
to create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxUsers
Lists all the users in a kdb environment.
- Parameters:
listKxUsersRequest
-- Returns:
- A Java Future containing the result of the ListKxUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxUsers
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 viaListKxUsersRequest.builder()
- Parameters:
listKxUsersRequest
- AConsumer
that will call methods onListKxUsersRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxVolumes
default CompletableFuture<ListKxVolumesResponse> listKxVolumes(ListKxVolumesRequest listKxVolumesRequest) Lists all the volumes in a kdb environment.
- Parameters:
listKxVolumesRequest
-- Returns:
- A Java Future containing the result of the ListKxVolumes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listKxVolumes
default CompletableFuture<ListKxVolumesResponse> listKxVolumes(Consumer<ListKxVolumesRequest.Builder> listKxVolumesRequest) Lists all the volumes in a kdb environment.
This is a convenience which creates an instance of the
ListKxVolumesRequest.Builder
avoiding the need to create one manually viaListKxVolumesRequest.builder()
- Parameters:
listKxVolumesRequest
- AConsumer
that will call methods onListKxVolumesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListKxVolumes operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) A list of all tags for a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- InvalidRequestException The request is invalid. Something is wrong with the input to the request.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listTagsForResource
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 viaListTagsForResourceRequest.builder()
- Parameters:
listTagsForResourceRequest
- AConsumer
that will call methods onListTagsForResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the ListTagsForResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- InvalidRequestException The request is invalid. Something is wrong with the input to the request.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
Adds metadata tags to a FinSpace resource.
- Parameters:
tagResourceRequest
-- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- InvalidRequestException The request is invalid. Something is wrong with the input to the request.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
tagResource
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 viaTagResourceRequest.builder()
- Parameters:
tagResourceRequest
- AConsumer
that will call methods onTagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the TagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- InvalidRequestException The request is invalid. Something is wrong with the input to the request.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest) Removes metadata tags from a FinSpace resource.
- Parameters:
untagResourceRequest
-- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- InvalidRequestException The request is invalid. Something is wrong with the input to the request.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
untagResource
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 viaUntagResourceRequest.builder()
- Parameters:
untagResourceRequest
- AConsumer
that will call methods onUntagResourceRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UntagResource operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- InvalidRequestException The request is invalid. Something is wrong with the input to the request.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnvironment
@Deprecated default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) Deprecated.This method will be discontinued.Update your FinSpace environment.
- Parameters:
updateEnvironmentRequest
-- Returns:
- A Java Future containing the result of the UpdateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateEnvironment
@Deprecated default CompletableFuture<UpdateEnvironmentResponse> updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Deprecated.This method will be discontinued.Update your FinSpace environment.
This is a convenience which creates an instance of the
UpdateEnvironmentRequest.Builder
avoiding the need to create one manually viaUpdateEnvironmentRequest.builder()
- Parameters:
updateEnvironmentRequest
- AConsumer
that will call methods onUpdateEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxClusterCodeConfiguration
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.
- Parameters:
updateKxClusterCodeConfigurationRequest
-- Returns:
- A Java Future containing the result of the UpdateKxClusterCodeConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxClusterCodeConfiguration
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 viaUpdateKxClusterCodeConfigurationRequest.builder()
- Parameters:
updateKxClusterCodeConfigurationRequest
- AConsumer
that will call methods onUpdateKxClusterCodeConfigurationRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKxClusterCodeConfiguration operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxClusterDatabases
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.
- Parameters:
updateKxClusterDatabasesRequest
-- Returns:
- A Java Future containing the result of the UpdateKxClusterDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxClusterDatabases
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 viaUpdateKxClusterDatabasesRequest.builder()
- Parameters:
updateKxClusterDatabasesRequest
- AConsumer
that will call methods onUpdateKxClusterDatabasesRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKxClusterDatabases operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxDatabase
default CompletableFuture<UpdateKxDatabaseResponse> updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest) Updates information for the given kdb database.
- Parameters:
updateKxDatabaseRequest
-- Returns:
- A Java Future containing the result of the UpdateKxDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxDatabase
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 viaUpdateKxDatabaseRequest.builder()
- Parameters:
updateKxDatabaseRequest
- AConsumer
that will call methods onUpdateKxDatabaseRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKxDatabase operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxDataview
default CompletableFuture<UpdateKxDataviewResponse> updateKxDataview(UpdateKxDataviewRequest updateKxDataviewRequest) Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations
- Parameters:
updateKxDataviewRequest
-- Returns:
- A Java Future containing the result of the UpdateKxDataview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceAlreadyExistsException The specified resource group already exists.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxDataview
default CompletableFuture<UpdateKxDataviewResponse> updateKxDataview(Consumer<UpdateKxDataviewRequest.Builder> updateKxDataviewRequest) Updates the specified dataview. The dataviews get automatically updated when any new changesets are ingested. Each update of the dataview creates a new version, including changeset details and cache configurations
This is a convenience which creates an instance of the
UpdateKxDataviewRequest.Builder
avoiding the need to create one manually viaUpdateKxDataviewRequest.builder()
- Parameters:
updateKxDataviewRequest
- AConsumer
that will call methods onUpdateKxDataviewRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKxDataview operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceAlreadyExistsException The specified resource group already exists.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxEnvironment
default CompletableFuture<UpdateKxEnvironmentResponse> updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest) Updates information for the given kdb environment.
- Parameters:
updateKxEnvironmentRequest
-- Returns:
- A Java Future containing the result of the UpdateKxEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxEnvironment
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 viaUpdateKxEnvironmentRequest.builder()
- Parameters:
updateKxEnvironmentRequest
- AConsumer
that will call methods onUpdateKxEnvironmentRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKxEnvironment operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxEnvironmentNetwork
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.
- Parameters:
updateKxEnvironmentNetworkRequest
-- Returns:
- A Java Future containing the result of the UpdateKxEnvironmentNetwork operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxEnvironmentNetwork
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 viaUpdateKxEnvironmentNetworkRequest.builder()
- Parameters:
updateKxEnvironmentNetworkRequest
- AConsumer
that will call methods onUpdateKxEnvironmentNetworkRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKxEnvironmentNetwork operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxUser
default CompletableFuture<UpdateKxUserResponse> updateKxUser(UpdateKxUserRequest updateKxUserRequest) Updates the user details. You can only update the IAM role associated with a user.
- Parameters:
updateKxUserRequest
-- Returns:
- A Java Future containing the result of the UpdateKxUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxUser
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 viaUpdateKxUserRequest.builder()
- Parameters:
updateKxUserRequest
- AConsumer
that will call methods onUpdateKxUserRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKxUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- LimitExceededException A service limit or quota is exceeded.
- ConflictException There was a conflict with this action, and it could not be completed.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxVolume
default CompletableFuture<UpdateKxVolumeResponse> updateKxVolume(UpdateKxVolumeRequest updateKxVolumeRequest) Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.
- Parameters:
updateKxVolumeRequest
-- Returns:
- A Java Future containing the result of the UpdateKxVolume operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateKxVolume
default CompletableFuture<UpdateKxVolumeResponse> updateKxVolume(Consumer<UpdateKxVolumeRequest.Builder> updateKxVolumeRequest) Updates the throughput or capacity of a volume. During the update process, the filesystem might be unavailable for a few minutes. You can retry any operations after the update is complete.
This is a convenience which creates an instance of the
UpdateKxVolumeRequest.Builder
avoiding the need to create one manually viaUpdateKxVolumeRequest.builder()
- Parameters:
updateKxVolumeRequest
- AConsumer
that will call methods onUpdateKxVolumeRequest.Builder
to create a request.- Returns:
- A Java Future containing the result of the UpdateKxVolume operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions. The exception returned is wrapped with CompletionException, so you need to invokeThrowable.getCause()
to retrieve the underlying exception.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A service limit or quota is exceeded.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException There was a conflict with this action, and it could not be completed.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-
create
Create aFinspaceAsyncClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aFinspaceAsyncClient
.
-