Interface FinspaceClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
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 FinspaceClientBuilder
builder()
Create a builder that can be used to configure and create aFinspaceClient
.static FinspaceClient
create()
Create aFinspaceClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateEnvironmentResponse
createEnvironment
(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) Deprecated.This method will be discontinued.default CreateEnvironmentResponse
createEnvironment
(CreateEnvironmentRequest createEnvironmentRequest) Deprecated.This method will be discontinued.default CreateKxChangesetResponse
createKxChangeset
(Consumer<CreateKxChangesetRequest.Builder> createKxChangesetRequest) Creates a changeset for a kdb database.default CreateKxChangesetResponse
createKxChangeset
(CreateKxChangesetRequest createKxChangesetRequest) Creates a changeset for a kdb database.default CreateKxClusterResponse
createKxCluster
(Consumer<CreateKxClusterRequest.Builder> createKxClusterRequest) Creates a new kdb cluster.default CreateKxClusterResponse
createKxCluster
(CreateKxClusterRequest createKxClusterRequest) Creates a new kdb cluster.default CreateKxDatabaseResponse
createKxDatabase
(Consumer<CreateKxDatabaseRequest.Builder> createKxDatabaseRequest) Creates a new kdb database in the environment.default CreateKxDatabaseResponse
createKxDatabase
(CreateKxDatabaseRequest createKxDatabaseRequest) Creates a new kdb database in the environment.default 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.default 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.default CreateKxEnvironmentResponse
createKxEnvironment
(Consumer<CreateKxEnvironmentRequest.Builder> createKxEnvironmentRequest) Creates a managed kdb environment for the account.default CreateKxEnvironmentResponse
createKxEnvironment
(CreateKxEnvironmentRequest createKxEnvironmentRequest) Creates a managed kdb environment for the account.default CreateKxScalingGroupResponse
createKxScalingGroup
(Consumer<CreateKxScalingGroupRequest.Builder> createKxScalingGroupRequest) Creates a new scaling group.default CreateKxScalingGroupResponse
createKxScalingGroup
(CreateKxScalingGroupRequest createKxScalingGroupRequest) Creates a new scaling group.default CreateKxUserResponse
createKxUser
(Consumer<CreateKxUserRequest.Builder> createKxUserRequest) Creates a user in FinSpace kdb environment with an associated IAM role.default CreateKxUserResponse
createKxUser
(CreateKxUserRequest createKxUserRequest) Creates a user in FinSpace kdb environment with an associated IAM role.default CreateKxVolumeResponse
createKxVolume
(Consumer<CreateKxVolumeRequest.Builder> createKxVolumeRequest) Creates a new volume with a specific amount of throughput and storage capacity.default CreateKxVolumeResponse
createKxVolume
(CreateKxVolumeRequest createKxVolumeRequest) Creates a new volume with a specific amount of throughput and storage capacity.default DeleteEnvironmentResponse
deleteEnvironment
(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) Deprecated.This method will be discontinued.default DeleteEnvironmentResponse
deleteEnvironment
(DeleteEnvironmentRequest deleteEnvironmentRequest) Deprecated.This method will be discontinued.default DeleteKxClusterResponse
deleteKxCluster
(Consumer<DeleteKxClusterRequest.Builder> deleteKxClusterRequest) Deletes a kdb cluster.default DeleteKxClusterResponse
deleteKxCluster
(DeleteKxClusterRequest deleteKxClusterRequest) Deletes a kdb cluster.default DeleteKxClusterNodeResponse
deleteKxClusterNode
(Consumer<DeleteKxClusterNodeRequest.Builder> deleteKxClusterNodeRequest) Deletes the specified nodes from a cluster.default DeleteKxClusterNodeResponse
deleteKxClusterNode
(DeleteKxClusterNodeRequest deleteKxClusterNodeRequest) Deletes the specified nodes from a cluster.default DeleteKxDatabaseResponse
deleteKxDatabase
(Consumer<DeleteKxDatabaseRequest.Builder> deleteKxDatabaseRequest) Deletes the specified database and all of its associated data.default DeleteKxDatabaseResponse
deleteKxDatabase
(DeleteKxDatabaseRequest deleteKxDatabaseRequest) Deletes the specified database and all of its associated data.default DeleteKxDataviewResponse
deleteKxDataview
(Consumer<DeleteKxDataviewRequest.Builder> deleteKxDataviewRequest) Deletes the specified dataview.default DeleteKxDataviewResponse
deleteKxDataview
(DeleteKxDataviewRequest deleteKxDataviewRequest) Deletes the specified dataview.default DeleteKxEnvironmentResponse
deleteKxEnvironment
(Consumer<DeleteKxEnvironmentRequest.Builder> deleteKxEnvironmentRequest) Deletes the kdb environment.default DeleteKxEnvironmentResponse
deleteKxEnvironment
(DeleteKxEnvironmentRequest deleteKxEnvironmentRequest) Deletes the kdb environment.default DeleteKxScalingGroupResponse
deleteKxScalingGroup
(Consumer<DeleteKxScalingGroupRequest.Builder> deleteKxScalingGroupRequest) Deletes the specified scaling group.default DeleteKxScalingGroupResponse
deleteKxScalingGroup
(DeleteKxScalingGroupRequest deleteKxScalingGroupRequest) Deletes the specified scaling group.default DeleteKxUserResponse
deleteKxUser
(Consumer<DeleteKxUserRequest.Builder> deleteKxUserRequest) Deletes a user in the specified kdb environment.default DeleteKxUserResponse
deleteKxUser
(DeleteKxUserRequest deleteKxUserRequest) Deletes a user in the specified kdb environment.default DeleteKxVolumeResponse
deleteKxVolume
(Consumer<DeleteKxVolumeRequest.Builder> deleteKxVolumeRequest) Deletes a volume.default DeleteKxVolumeResponse
deleteKxVolume
(DeleteKxVolumeRequest deleteKxVolumeRequest) Deletes a volume.default GetEnvironmentResponse
getEnvironment
(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) Deprecated.This method will be discontinued.default GetEnvironmentResponse
getEnvironment
(GetEnvironmentRequest getEnvironmentRequest) Deprecated.This method will be discontinued.default GetKxChangesetResponse
getKxChangeset
(Consumer<GetKxChangesetRequest.Builder> getKxChangesetRequest) Returns information about a kdb changeset.default GetKxChangesetResponse
getKxChangeset
(GetKxChangesetRequest getKxChangesetRequest) Returns information about a kdb changeset.default GetKxClusterResponse
getKxCluster
(Consumer<GetKxClusterRequest.Builder> getKxClusterRequest) Retrieves information about a kdb cluster.default GetKxClusterResponse
getKxCluster
(GetKxClusterRequest getKxClusterRequest) Retrieves information about a kdb cluster.default GetKxConnectionStringResponse
getKxConnectionString
(Consumer<GetKxConnectionStringRequest.Builder> getKxConnectionStringRequest) Retrieves a connection string for a user to connect to a kdb cluster.default GetKxConnectionStringResponse
getKxConnectionString
(GetKxConnectionStringRequest getKxConnectionStringRequest) Retrieves a connection string for a user to connect to a kdb cluster.default GetKxDatabaseResponse
getKxDatabase
(Consumer<GetKxDatabaseRequest.Builder> getKxDatabaseRequest) Returns database information for the specified environment ID.default GetKxDatabaseResponse
getKxDatabase
(GetKxDatabaseRequest getKxDatabaseRequest) Returns database information for the specified environment ID.default GetKxDataviewResponse
getKxDataview
(Consumer<GetKxDataviewRequest.Builder> getKxDataviewRequest) Retrieves details of the dataview.default GetKxDataviewResponse
getKxDataview
(GetKxDataviewRequest getKxDataviewRequest) Retrieves details of the dataview.default GetKxEnvironmentResponse
getKxEnvironment
(Consumer<GetKxEnvironmentRequest.Builder> getKxEnvironmentRequest) Retrieves all the information for the specified kdb environment.default GetKxEnvironmentResponse
getKxEnvironment
(GetKxEnvironmentRequest getKxEnvironmentRequest) Retrieves all the information for the specified kdb environment.default GetKxScalingGroupResponse
getKxScalingGroup
(Consumer<GetKxScalingGroupRequest.Builder> getKxScalingGroupRequest) Retrieves details of a scaling group.default GetKxScalingGroupResponse
getKxScalingGroup
(GetKxScalingGroupRequest getKxScalingGroupRequest) Retrieves details of a scaling group.default GetKxUserResponse
getKxUser
(Consumer<GetKxUserRequest.Builder> getKxUserRequest) Retrieves information about the specified kdb user.default GetKxUserResponse
getKxUser
(GetKxUserRequest getKxUserRequest) Retrieves information about the specified kdb user.default GetKxVolumeResponse
getKxVolume
(Consumer<GetKxVolumeRequest.Builder> getKxVolumeRequest) Retrieves the information about the volume.default GetKxVolumeResponse
getKxVolume
(GetKxVolumeRequest getKxVolumeRequest) Retrieves the information about the volume.default ListEnvironmentsResponse
listEnvironments
(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) Deprecated.This method will be discontinued.default ListEnvironmentsResponse
listEnvironments
(ListEnvironmentsRequest listEnvironmentsRequest) Deprecated.This method will be discontinued.default ListKxChangesetsResponse
listKxChangesets
(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest) Returns a list of all the changesets for a database.default ListKxChangesetsResponse
listKxChangesets
(ListKxChangesetsRequest listKxChangesetsRequest) Returns a list of all the changesets for a database.default ListKxChangesetsIterable
listKxChangesetsPaginator
(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest) This is a variant oflistKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest)
operation.default ListKxChangesetsIterable
listKxChangesetsPaginator
(ListKxChangesetsRequest listKxChangesetsRequest) This is a variant oflistKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest)
operation.default ListKxClusterNodesResponse
listKxClusterNodes
(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest) Lists all the nodes in a kdb cluster.default ListKxClusterNodesResponse
listKxClusterNodes
(ListKxClusterNodesRequest listKxClusterNodesRequest) Lists all the nodes in a kdb cluster.default ListKxClusterNodesIterable
listKxClusterNodesPaginator
(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest) This is a variant oflistKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest)
operation.default ListKxClusterNodesIterable
listKxClusterNodesPaginator
(ListKxClusterNodesRequest listKxClusterNodesRequest) This is a variant oflistKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest)
operation.default ListKxClustersResponse
listKxClusters
(Consumer<ListKxClustersRequest.Builder> listKxClustersRequest) Returns a list of clusters.default ListKxClustersResponse
listKxClusters
(ListKxClustersRequest listKxClustersRequest) Returns a list of clusters.default ListKxDatabasesResponse
listKxDatabases
(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest) Returns a list of all the databases in the kdb environment.default ListKxDatabasesResponse
listKxDatabases
(ListKxDatabasesRequest listKxDatabasesRequest) Returns a list of all the databases in the kdb environment.default ListKxDatabasesIterable
listKxDatabasesPaginator
(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest) This is a variant oflistKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest)
operation.default ListKxDatabasesIterable
listKxDatabasesPaginator
(ListKxDatabasesRequest listKxDatabasesRequest) This is a variant oflistKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest)
operation.default ListKxDataviewsResponse
listKxDataviews
(Consumer<ListKxDataviewsRequest.Builder> listKxDataviewsRequest) Returns a list of all the dataviews in the database.default ListKxDataviewsResponse
listKxDataviews
(ListKxDataviewsRequest listKxDataviewsRequest) Returns a list of all the dataviews in the database.default ListKxDataviewsIterable
listKxDataviewsPaginator
(Consumer<ListKxDataviewsRequest.Builder> listKxDataviewsRequest) This is a variant oflistKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
operation.default ListKxDataviewsIterable
listKxDataviewsPaginator
(ListKxDataviewsRequest listKxDataviewsRequest) This is a variant oflistKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
operation.default ListKxEnvironmentsResponse
listKxEnvironments
(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest) Returns a list of kdb environments created in an account.default ListKxEnvironmentsResponse
listKxEnvironments
(ListKxEnvironmentsRequest listKxEnvironmentsRequest) Returns a list of kdb environments created in an account.default ListKxEnvironmentsIterable
listKxEnvironmentsPaginator
(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest) This is a variant oflistKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest)
operation.default ListKxEnvironmentsIterable
listKxEnvironmentsPaginator
(ListKxEnvironmentsRequest listKxEnvironmentsRequest) This is a variant oflistKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest)
operation.default ListKxScalingGroupsResponse
listKxScalingGroups
(Consumer<ListKxScalingGroupsRequest.Builder> listKxScalingGroupsRequest) Returns a list of scaling groups in a kdb environment.default ListKxScalingGroupsResponse
listKxScalingGroups
(ListKxScalingGroupsRequest listKxScalingGroupsRequest) Returns a list of scaling groups in a kdb environment.default ListKxScalingGroupsIterable
listKxScalingGroupsPaginator
(Consumer<ListKxScalingGroupsRequest.Builder> listKxScalingGroupsRequest) This is a variant oflistKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
operation.default ListKxScalingGroupsIterable
listKxScalingGroupsPaginator
(ListKxScalingGroupsRequest listKxScalingGroupsRequest) This is a variant oflistKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
operation.default ListKxUsersResponse
listKxUsers
(Consumer<ListKxUsersRequest.Builder> listKxUsersRequest) Lists all the users in a kdb environment.default ListKxUsersResponse
listKxUsers
(ListKxUsersRequest listKxUsersRequest) Lists all the users in a kdb environment.default ListKxVolumesResponse
listKxVolumes
(Consumer<ListKxVolumesRequest.Builder> listKxVolumesRequest) Lists all the volumes in a kdb environment.default ListKxVolumesResponse
listKxVolumes
(ListKxVolumesRequest listKxVolumesRequest) Lists all the volumes in a kdb environment.default ListTagsForResourceResponse
listTagsForResource
(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) A list of all tags for a resource.default ListTagsForResourceResponse
listTagsForResource
(ListTagsForResourceRequest listTagsForResourceRequest) A list of all tags for a resource.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic ServiceMetadata
default TagResourceResponse
tagResource
(Consumer<TagResourceRequest.Builder> tagResourceRequest) Adds metadata tags to a FinSpace resource.default TagResourceResponse
tagResource
(TagResourceRequest tagResourceRequest) Adds metadata tags to a FinSpace resource.default UntagResourceResponse
untagResource
(Consumer<UntagResourceRequest.Builder> untagResourceRequest) Removes metadata tags from a FinSpace resource.default UntagResourceResponse
untagResource
(UntagResourceRequest untagResourceRequest) Removes metadata tags from a FinSpace resource.default UpdateEnvironmentResponse
updateEnvironment
(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) Deprecated.This method will be discontinued.default UpdateEnvironmentResponse
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.default UpdateKxClusterDatabasesResponse
updateKxClusterDatabases
(Consumer<UpdateKxClusterDatabasesRequest.Builder> updateKxClusterDatabasesRequest) Updates the databases mounted on a kdb cluster, which includes thechangesetId
and all the dbPaths to be cached.default UpdateKxClusterDatabasesResponse
updateKxClusterDatabases
(UpdateKxClusterDatabasesRequest updateKxClusterDatabasesRequest) Updates the databases mounted on a kdb cluster, which includes thechangesetId
and all the dbPaths to be cached.default UpdateKxDatabaseResponse
updateKxDatabase
(Consumer<UpdateKxDatabaseRequest.Builder> updateKxDatabaseRequest) Updates information for the given kdb database.default UpdateKxDatabaseResponse
updateKxDatabase
(UpdateKxDatabaseRequest updateKxDatabaseRequest) Updates information for the given kdb database.default UpdateKxDataviewResponse
updateKxDataview
(Consumer<UpdateKxDataviewRequest.Builder> updateKxDataviewRequest) Updates the specified dataview.default UpdateKxDataviewResponse
updateKxDataview
(UpdateKxDataviewRequest updateKxDataviewRequest) Updates the specified dataview.default UpdateKxEnvironmentResponse
updateKxEnvironment
(Consumer<UpdateKxEnvironmentRequest.Builder> updateKxEnvironmentRequest) Updates information for the given kdb environment.default UpdateKxEnvironmentResponse
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 UpdateKxUserResponse
updateKxUser
(Consumer<UpdateKxUserRequest.Builder> updateKxUserRequest) Updates the user details.default UpdateKxUserResponse
updateKxUser
(UpdateKxUserRequest updateKxUserRequest) Updates the user details.default UpdateKxVolumeResponse
updateKxVolume
(Consumer<UpdateKxVolumeRequest.Builder> updateKxVolumeRequest) Updates the throughput or capacity of a volume.default 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 CreateEnvironmentResponse createEnvironment(CreateEnvironmentRequest createEnvironmentRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, LimitExceededException, AwsServiceException, SdkClientException, FinspaceException Deprecated.This method will be discontinued.Create a new FinSpace environment.
- Parameters:
createEnvironmentRequest
-- Returns:
- Result of the CreateEnvironment operation returned by the service.
- See Also:
-
createEnvironment
@Deprecated default CreateEnvironmentResponse createEnvironment(Consumer<CreateEnvironmentRequest.Builder> createEnvironmentRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, LimitExceededException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateEnvironment operation returned by the service.
- See Also:
-
createKxChangeset
default CreateKxChangesetResponse createKxChangeset(CreateKxChangesetRequest createKxChangesetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, LimitExceededException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxChangeset operation returned by the service.
- See Also:
-
createKxChangeset
default CreateKxChangesetResponse createKxChangeset(Consumer<CreateKxChangesetRequest.Builder> createKxChangesetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, LimitExceededException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxChangeset operation returned by the service.
- See Also:
-
createKxCluster
default CreateKxClusterResponse createKxCluster(CreateKxClusterRequest createKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Creates a new kdb cluster.
- Parameters:
createKxClusterRequest
-- Returns:
- Result of the CreateKxCluster operation returned by the service.
- See Also:
-
createKxCluster
default CreateKxClusterResponse createKxCluster(Consumer<CreateKxClusterRequest.Builder> createKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxCluster operation returned by the service.
- See Also:
-
createKxDatabase
default CreateKxDatabaseResponse createKxDatabase(CreateKxDatabaseRequest createKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, FinspaceException Creates a new kdb database in the environment.
- Parameters:
createKxDatabaseRequest
-- Returns:
- Result of the CreateKxDatabase operation returned by the service.
- See Also:
-
createKxDatabase
default CreateKxDatabaseResponse createKxDatabase(Consumer<CreateKxDatabaseRequest.Builder> createKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ResourceAlreadyExistsException, ResourceNotFoundException, LimitExceededException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxDatabase operation returned by the service.
- See Also:
-
createKxDataview
default CreateKxDataviewResponse createKxDataview(CreateKxDataviewRequest createKxDataviewRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, LimitExceededException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxDataview operation returned by the service.
- See Also:
-
createKxDataview
default CreateKxDataviewResponse createKxDataview(Consumer<CreateKxDataviewRequest.Builder> createKxDataviewRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, LimitExceededException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxDataview operation returned by the service.
- See Also:
-
createKxEnvironment
default CreateKxEnvironmentResponse createKxEnvironment(CreateKxEnvironmentRequest createKxEnvironmentRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceException Creates a managed kdb environment for the account.
- Parameters:
createKxEnvironmentRequest
-- Returns:
- Result of the CreateKxEnvironment operation returned by the service.
- See Also:
-
createKxEnvironment
default CreateKxEnvironmentResponse createKxEnvironment(Consumer<CreateKxEnvironmentRequest.Builder> createKxEnvironmentRequest) throws InternalServerException, ValidationException, AccessDeniedException, ThrottlingException, ServiceQuotaExceededException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxEnvironment operation returned by the service.
- See Also:
-
createKxScalingGroup
default CreateKxScalingGroupResponse createKxScalingGroup(CreateKxScalingGroupRequest createKxScalingGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Creates a new scaling group.
- Parameters:
createKxScalingGroupRequest
-- Returns:
- Result of the CreateKxScalingGroup operation returned by the service.
- See Also:
-
createKxScalingGroup
default CreateKxScalingGroupResponse createKxScalingGroup(Consumer<CreateKxScalingGroupRequest.Builder> createKxScalingGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxScalingGroup operation returned by the service.
- See Also:
-
createKxUser
default CreateKxUserResponse createKxUser(CreateKxUserRequest createKxUserRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, AccessDeniedException, ValidationException, ResourceAlreadyExistsException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceException Creates a user in FinSpace kdb environment with an associated IAM role.
- Parameters:
createKxUserRequest
-- Returns:
- Result of the CreateKxUser operation returned by the service.
- See Also:
-
createKxUser
default CreateKxUserResponse createKxUser(Consumer<CreateKxUserRequest.Builder> createKxUserRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, AccessDeniedException, ValidationException, ResourceAlreadyExistsException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxUser operation returned by the service.
- See Also:
-
createKxVolume
default CreateKxVolumeResponse createKxVolume(CreateKxVolumeRequest createKxVolumeRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, FinspaceException Creates a new volume with a specific amount of throughput and storage capacity.
- Parameters:
createKxVolumeRequest
-- Returns:
- Result of the CreateKxVolume operation returned by the service.
- See Also:
-
createKxVolume
default CreateKxVolumeResponse createKxVolume(Consumer<CreateKxVolumeRequest.Builder> createKxVolumeRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the CreateKxVolume operation returned by the service.
- See Also:
-
deleteEnvironment
@Deprecated default DeleteEnvironmentResponse deleteEnvironment(DeleteEnvironmentRequest deleteEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, FinspaceException Deprecated.This method will be discontinued.Delete an FinSpace environment.
- Parameters:
deleteEnvironmentRequest
-- Returns:
- Result of the DeleteEnvironment operation returned by the service.
- See Also:
-
deleteEnvironment
@Deprecated default DeleteEnvironmentResponse deleteEnvironment(Consumer<DeleteEnvironmentRequest.Builder> deleteEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteEnvironment operation returned by the service.
- See Also:
-
deleteKxCluster
default DeleteKxClusterResponse deleteKxCluster(DeleteKxClusterRequest deleteKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Deletes a kdb cluster.
- Parameters:
deleteKxClusterRequest
-- Returns:
- Result of the DeleteKxCluster operation returned by the service.
- See Also:
-
deleteKxCluster
default DeleteKxClusterResponse deleteKxCluster(Consumer<DeleteKxClusterRequest.Builder> deleteKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxCluster operation returned by the service.
- See Also:
-
deleteKxClusterNode
default DeleteKxClusterNodeResponse deleteKxClusterNode(DeleteKxClusterNodeRequest deleteKxClusterNodeRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Deletes the specified nodes from a cluster.
- Parameters:
deleteKxClusterNodeRequest
-- Returns:
- Result of the DeleteKxClusterNode operation returned by the service.
- See Also:
-
deleteKxClusterNode
default DeleteKxClusterNodeResponse deleteKxClusterNode(Consumer<DeleteKxClusterNodeRequest.Builder> deleteKxClusterNodeRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxClusterNode operation returned by the service.
- See Also:
-
deleteKxDatabase
default DeleteKxDatabaseResponse deleteKxDatabase(DeleteKxDatabaseRequest deleteKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxDatabase operation returned by the service.
- See Also:
-
deleteKxDatabase
default DeleteKxDatabaseResponse deleteKxDatabase(Consumer<DeleteKxDatabaseRequest.Builder> deleteKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxDatabase operation returned by the service.
- See Also:
-
deleteKxDataview
default DeleteKxDataviewResponse deleteKxDataview(DeleteKxDataviewRequest deleteKxDataviewRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceException Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
- Parameters:
deleteKxDataviewRequest
-- Returns:
- Result of the DeleteKxDataview operation returned by the service.
- See Also:
-
deleteKxDataview
default DeleteKxDataviewResponse deleteKxDataview(Consumer<DeleteKxDataviewRequest.Builder> deleteKxDataviewRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxDataview operation returned by the service.
- See Also:
-
deleteKxEnvironment
default DeleteKxEnvironmentResponse deleteKxEnvironment(DeleteKxEnvironmentRequest deleteKxEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxEnvironment operation returned by the service.
- See Also:
-
deleteKxEnvironment
default DeleteKxEnvironmentResponse deleteKxEnvironment(Consumer<DeleteKxEnvironmentRequest.Builder> deleteKxEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxEnvironment operation returned by the service.
- See Also:
-
deleteKxScalingGroup
default DeleteKxScalingGroupResponse deleteKxScalingGroup(DeleteKxScalingGroupRequest deleteKxScalingGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxScalingGroup operation returned by the service.
- See Also:
-
deleteKxScalingGroup
default DeleteKxScalingGroupResponse deleteKxScalingGroup(Consumer<DeleteKxScalingGroupRequest.Builder> deleteKxScalingGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxScalingGroup operation returned by the service.
- See Also:
-
deleteKxUser
default DeleteKxUserResponse deleteKxUser(DeleteKxUserRequest deleteKxUserRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException Deletes a user in the specified kdb environment.
- Parameters:
deleteKxUserRequest
-- Returns:
- Result of the DeleteKxUser operation returned by the service.
- See Also:
-
deleteKxUser
default DeleteKxUserResponse deleteKxUser(Consumer<DeleteKxUserRequest.Builder> deleteKxUserRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxUser operation returned by the service.
- See Also:
-
deleteKxVolume
default DeleteKxVolumeResponse deleteKxVolume(DeleteKxVolumeRequest deleteKxVolumeRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxVolume operation returned by the service.
- See Also:
-
deleteKxVolume
default DeleteKxVolumeResponse deleteKxVolume(Consumer<DeleteKxVolumeRequest.Builder> deleteKxVolumeRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the DeleteKxVolume operation returned by the service.
- See Also:
-
getEnvironment
@Deprecated default GetEnvironmentResponse getEnvironment(GetEnvironmentRequest getEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceException Deprecated.This method will be discontinued.Returns the FinSpace environment object.
- Parameters:
getEnvironmentRequest
-- Returns:
- Result of the GetEnvironment operation returned by the service.
- See Also:
-
getEnvironment
@Deprecated default GetEnvironmentResponse getEnvironment(Consumer<GetEnvironmentRequest.Builder> getEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetEnvironment operation returned by the service.
- See Also:
-
getKxChangeset
default GetKxChangesetResponse getKxChangeset(GetKxChangesetRequest getKxChangesetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Returns information about a kdb changeset.
- Parameters:
getKxChangesetRequest
-- Returns:
- Result of the GetKxChangeset operation returned by the service.
- See Also:
-
getKxChangeset
default GetKxChangesetResponse getKxChangeset(Consumer<GetKxChangesetRequest.Builder> getKxChangesetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxChangeset operation returned by the service.
- See Also:
-
getKxCluster
default GetKxClusterResponse getKxCluster(GetKxClusterRequest getKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Retrieves information about a kdb cluster.
- Parameters:
getKxClusterRequest
-- Returns:
- Result of the GetKxCluster operation returned by the service.
- See Also:
-
getKxCluster
default GetKxClusterResponse getKxCluster(Consumer<GetKxClusterRequest.Builder> getKxClusterRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxCluster operation returned by the service.
- See Also:
-
getKxConnectionString
default GetKxConnectionStringResponse getKxConnectionString(GetKxConnectionStringRequest getKxConnectionStringRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxConnectionString operation returned by the service.
- See Also:
-
getKxConnectionString
default GetKxConnectionStringResponse getKxConnectionString(Consumer<GetKxConnectionStringRequest.Builder> getKxConnectionStringRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxConnectionString operation returned by the service.
- See Also:
-
getKxDatabase
default GetKxDatabaseResponse getKxDatabase(GetKxDatabaseRequest getKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Returns database information for the specified environment ID.
- Parameters:
getKxDatabaseRequest
-- Returns:
- Result of the GetKxDatabase operation returned by the service.
- See Also:
-
getKxDatabase
default GetKxDatabaseResponse getKxDatabase(Consumer<GetKxDatabaseRequest.Builder> getKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxDatabase operation returned by the service.
- See Also:
-
getKxDataview
default GetKxDataviewResponse getKxDataview(GetKxDataviewRequest getKxDataviewRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Retrieves details of the dataview.
- Parameters:
getKxDataviewRequest
-- Returns:
- Result of the GetKxDataview operation returned by the service.
- See Also:
-
getKxDataview
default GetKxDataviewResponse getKxDataview(Consumer<GetKxDataviewRequest.Builder> getKxDataviewRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxDataview operation returned by the service.
- See Also:
-
getKxEnvironment
default GetKxEnvironmentResponse getKxEnvironment(GetKxEnvironmentRequest getKxEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceException Retrieves all the information for the specified kdb environment.
- Parameters:
getKxEnvironmentRequest
-- Returns:
- Result of the GetKxEnvironment operation returned by the service.
- See Also:
-
getKxEnvironment
default GetKxEnvironmentResponse getKxEnvironment(Consumer<GetKxEnvironmentRequest.Builder> getKxEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxEnvironment operation returned by the service.
- See Also:
-
getKxScalingGroup
default GetKxScalingGroupResponse getKxScalingGroup(GetKxScalingGroupRequest getKxScalingGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Retrieves details of a scaling group.
- Parameters:
getKxScalingGroupRequest
-- Returns:
- Result of the GetKxScalingGroup operation returned by the service.
- See Also:
-
getKxScalingGroup
default GetKxScalingGroupResponse getKxScalingGroup(Consumer<GetKxScalingGroupRequest.Builder> getKxScalingGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxScalingGroup operation returned by the service.
- See Also:
-
getKxUser
default GetKxUserResponse getKxUser(GetKxUserRequest getKxUserRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, FinspaceException Retrieves information about the specified kdb user.
- Parameters:
getKxUserRequest
-- Returns:
- Result of the GetKxUser operation returned by the service.
- See Also:
-
getKxUser
default GetKxUserResponse getKxUser(Consumer<GetKxUserRequest.Builder> getKxUserRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxUser operation returned by the service.
- See Also:
-
getKxVolume
default GetKxVolumeResponse getKxVolume(GetKxVolumeRequest getKxVolumeRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Retrieves the information about the volume.
- Parameters:
getKxVolumeRequest
-- Returns:
- Result of the GetKxVolume operation returned by the service.
- See Also:
-
getKxVolume
default GetKxVolumeResponse getKxVolume(Consumer<GetKxVolumeRequest.Builder> getKxVolumeRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the GetKxVolume operation returned by the service.
- See Also:
-
listEnvironments
@Deprecated default ListEnvironmentsResponse listEnvironments(ListEnvironmentsRequest listEnvironmentsRequest) throws InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceException Deprecated.This method will be discontinued.A list of all of your FinSpace environments.
- Parameters:
listEnvironmentsRequest
-- Returns:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listEnvironments
@Deprecated default ListEnvironmentsResponse listEnvironments(Consumer<ListEnvironmentsRequest.Builder> listEnvironmentsRequest) throws InternalServerException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListEnvironments operation returned by the service.
- See Also:
-
listKxChangesets
default ListKxChangesetsResponse listKxChangesets(ListKxChangesetsRequest listKxChangesetsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Returns a list of all the changesets for a database.
- Parameters:
listKxChangesetsRequest
-- Returns:
- Result of the ListKxChangesets operation returned by the service.
- See Also:
-
listKxChangesets
default ListKxChangesetsResponse listKxChangesets(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxChangesets operation returned by the service.
- See Also:
-
listKxChangesetsPaginator
default ListKxChangesetsIterable listKxChangesetsPaginator(ListKxChangesetsRequest listKxChangesetsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client.listKxChangesetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client .listKxChangesetsPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxChangesetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client.listKxChangesetsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxChangesetsPaginator
default ListKxChangesetsIterable listKxChangesetsPaginator(Consumer<ListKxChangesetsRequest.Builder> listKxChangesetsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxChangesets(software.amazon.awssdk.services.finspace.model.ListKxChangesetsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client.listKxChangesetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client .listKxChangesetsPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxChangesetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxChangesetsIterable responses = client.listKxChangesetsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxClusterNodes
default ListKxClusterNodesResponse listKxClusterNodes(ListKxClusterNodesRequest listKxClusterNodesRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Lists all the nodes in a kdb cluster.
- Parameters:
listKxClusterNodesRequest
-- Returns:
- Result of the ListKxClusterNodes operation returned by the service.
- See Also:
-
listKxClusterNodes
default ListKxClusterNodesResponse listKxClusterNodes(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxClusterNodes operation returned by the service.
- See Also:
-
listKxClusterNodesPaginator
default ListKxClusterNodesIterable listKxClusterNodesPaginator(ListKxClusterNodesRequest listKxClusterNodesRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client.listKxClusterNodesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client .listKxClusterNodesPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxClusterNodesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client.listKxClusterNodesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxClusterNodesPaginator
default ListKxClusterNodesIterable listKxClusterNodesPaginator(Consumer<ListKxClusterNodesRequest.Builder> listKxClusterNodesRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxClusterNodes(software.amazon.awssdk.services.finspace.model.ListKxClusterNodesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client.listKxClusterNodesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client .listKxClusterNodesPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxClusterNodesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxClusterNodesIterable responses = client.listKxClusterNodesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxClusters
default ListKxClustersResponse listKxClusters(ListKxClustersRequest listKxClustersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Returns a list of clusters.
- Parameters:
listKxClustersRequest
-- Returns:
- Result of the ListKxClusters operation returned by the service.
- See Also:
-
listKxClusters
default ListKxClustersResponse listKxClusters(Consumer<ListKxClustersRequest.Builder> listKxClustersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxClusters operation returned by the service.
- See Also:
-
listKxDatabases
default ListKxDatabasesResponse listKxDatabases(ListKxDatabasesRequest listKxDatabasesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Returns a list of all the databases in the kdb environment.
- Parameters:
listKxDatabasesRequest
-- Returns:
- Result of the ListKxDatabases operation returned by the service.
- See Also:
-
listKxDatabases
default ListKxDatabasesResponse listKxDatabases(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxDatabases operation returned by the service.
- See Also:
-
listKxDatabasesPaginator
default ListKxDatabasesIterable listKxDatabasesPaginator(ListKxDatabasesRequest listKxDatabasesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client.listKxDatabasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client .listKxDatabasesPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxDatabasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client.listKxDatabasesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxDatabasesPaginator
default ListKxDatabasesIterable listKxDatabasesPaginator(Consumer<ListKxDatabasesRequest.Builder> listKxDatabasesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxDatabases(software.amazon.awssdk.services.finspace.model.ListKxDatabasesRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client.listKxDatabasesPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client .listKxDatabasesPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxDatabasesResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxDatabasesIterable responses = client.listKxDatabasesPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxDataviews
default ListKxDataviewsResponse listKxDataviews(ListKxDataviewsRequest listKxDataviewsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Returns a list of all the dataviews in the database.
- Parameters:
listKxDataviewsRequest
-- Returns:
- Result of the ListKxDataviews operation returned by the service.
- See Also:
-
listKxDataviews
default ListKxDataviewsResponse listKxDataviews(Consumer<ListKxDataviewsRequest.Builder> listKxDataviewsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxDataviews operation returned by the service.
- See Also:
-
listKxDataviewsPaginator
default ListKxDataviewsIterable listKxDataviewsPaginator(ListKxDataviewsRequest listKxDataviewsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxDataviewsIterable responses = client.listKxDataviewsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxDataviewsIterable responses = client .listKxDataviewsPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxDataviewsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxDataviewsIterable responses = client.listKxDataviewsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxDataviewsPaginator
default ListKxDataviewsIterable listKxDataviewsPaginator(Consumer<ListKxDataviewsRequest.Builder> listKxDataviewsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxDataviews(software.amazon.awssdk.services.finspace.model.ListKxDataviewsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxDataviewsIterable responses = client.listKxDataviewsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxDataviewsIterable responses = client .listKxDataviewsPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxDataviewsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxDataviewsIterable responses = client.listKxDataviewsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxEnvironments
default ListKxEnvironmentsResponse listKxEnvironments(ListKxEnvironmentsRequest listKxEnvironmentsRequest) throws InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, FinspaceException Returns a list of kdb environments created in an account.
- Parameters:
listKxEnvironmentsRequest
-- Returns:
- Result of the ListKxEnvironments operation returned by the service.
- See Also:
-
listKxEnvironments
default ListKxEnvironmentsResponse listKxEnvironments(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest) throws InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxEnvironments operation returned by the service.
- See Also:
-
listKxEnvironmentsPaginator
default ListKxEnvironmentsIterable listKxEnvironmentsPaginator(ListKxEnvironmentsRequest listKxEnvironmentsRequest) throws InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client.listKxEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client .listKxEnvironmentsPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client.listKxEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxEnvironmentsPaginator
default ListKxEnvironmentsIterable listKxEnvironmentsPaginator(Consumer<ListKxEnvironmentsRequest.Builder> listKxEnvironmentsRequest) throws InternalServerException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxEnvironments(software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client.listKxEnvironmentsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client .listKxEnvironmentsPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxEnvironmentsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxEnvironmentsIterable responses = client.listKxEnvironmentsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxScalingGroups
default ListKxScalingGroupsResponse listKxScalingGroups(ListKxScalingGroupsRequest listKxScalingGroupsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Returns a list of scaling groups in a kdb environment.
- Parameters:
listKxScalingGroupsRequest
-- Returns:
- Result of the ListKxScalingGroups operation returned by the service.
- See Also:
-
listKxScalingGroups
default ListKxScalingGroupsResponse listKxScalingGroups(Consumer<ListKxScalingGroupsRequest.Builder> listKxScalingGroupsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxScalingGroups operation returned by the service.
- See Also:
-
listKxScalingGroupsPaginator
default ListKxScalingGroupsIterable listKxScalingGroupsPaginator(ListKxScalingGroupsRequest listKxScalingGroupsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsIterable responses = client.listKxScalingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsIterable responses = client .listKxScalingGroupsPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsIterable responses = client.listKxScalingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxScalingGroupsPaginator
default ListKxScalingGroupsIterable listKxScalingGroupsPaginator(Consumer<ListKxScalingGroupsRequest.Builder> listKxScalingGroupsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException This is a variant of
listKxScalingGroups(software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsIterable responses = client.listKxScalingGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsIterable responses = client .listKxScalingGroupsPaginator(request); for (software.amazon.awssdk.services.finspace.model.ListKxScalingGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspace.paginators.ListKxScalingGroupsIterable responses = client.listKxScalingGroupsPaginator(request); responses.iterator().forEachRemaining(....);
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 iterable that can be used to iterate through all the response pages.
- See Also:
-
listKxUsers
default ListKxUsersResponse listKxUsers(ListKxUsersRequest listKxUsersRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, FinspaceException Lists all the users in a kdb environment.
- Parameters:
listKxUsersRequest
-- Returns:
- Result of the ListKxUsers operation returned by the service.
- See Also:
-
listKxUsers
default ListKxUsersResponse listKxUsers(Consumer<ListKxUsersRequest.Builder> listKxUsersRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, AccessDeniedException, ValidationException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxUsers operation returned by the service.
- See Also:
-
listKxVolumes
default ListKxVolumesResponse listKxVolumes(ListKxVolumesRequest listKxVolumesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Lists all the volumes in a kdb environment.
- Parameters:
listKxVolumesRequest
-- Returns:
- Result of the ListKxVolumes operation returned by the service.
- See Also:
-
listKxVolumes
default ListKxVolumesResponse listKxVolumes(Consumer<ListKxVolumesRequest.Builder> listKxVolumesRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListKxVolumes operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException A list of all tags for a resource.
- Parameters:
listTagsForResourceRequest
-- Returns:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
listTagsForResource
default ListTagsForResourceResponse listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the ListTagsForResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(TagResourceRequest tagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Adds metadata tags to a FinSpace resource.
- Parameters:
tagResourceRequest
-- Returns:
- Result of the TagResource operation returned by the service.
- See Also:
-
tagResource
default TagResourceResponse tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the TagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(UntagResourceRequest untagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException Removes metadata tags from a FinSpace resource.
- Parameters:
untagResourceRequest
-- Returns:
- Result of the UntagResource operation returned by the service.
- See Also:
-
untagResource
default UntagResourceResponse untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest) throws InternalServerException, InvalidRequestException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UntagResource operation returned by the service.
- See Also:
-
updateEnvironment
@Deprecated default UpdateEnvironmentResponse updateEnvironment(UpdateEnvironmentRequest updateEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, FinspaceException Deprecated.This method will be discontinued.Update your FinSpace environment.
- Parameters:
updateEnvironmentRequest
-- Returns:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
updateEnvironment
@Deprecated default UpdateEnvironmentResponse updateEnvironment(Consumer<UpdateEnvironmentRequest.Builder> updateEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateEnvironment operation returned by the service.
- See Also:
-
updateKxClusterCodeConfiguration
default UpdateKxClusterCodeConfigurationResponse updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest updateKxClusterCodeConfigurationRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxClusterCodeConfiguration operation returned by the service.
- See Also:
-
updateKxClusterCodeConfiguration
default UpdateKxClusterCodeConfigurationResponse updateKxClusterCodeConfiguration(Consumer<UpdateKxClusterCodeConfigurationRequest.Builder> updateKxClusterCodeConfigurationRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxClusterCodeConfiguration operation returned by the service.
- See Also:
-
updateKxClusterDatabases
default UpdateKxClusterDatabasesResponse updateKxClusterDatabases(UpdateKxClusterDatabasesRequest updateKxClusterDatabasesRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxClusterDatabases operation returned by the service.
- See Also:
-
updateKxClusterDatabases
default UpdateKxClusterDatabasesResponse updateKxClusterDatabases(Consumer<UpdateKxClusterDatabasesRequest.Builder> updateKxClusterDatabasesRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxClusterDatabases operation returned by the service.
- See Also:
-
updateKxDatabase
default UpdateKxDatabaseResponse updateKxDatabase(UpdateKxDatabaseRequest updateKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceException Updates information for the given kdb database.
- Parameters:
updateKxDatabaseRequest
-- Returns:
- Result of the UpdateKxDatabase operation returned by the service.
- See Also:
-
updateKxDatabase
default UpdateKxDatabaseResponse updateKxDatabase(Consumer<UpdateKxDatabaseRequest.Builder> updateKxDatabaseRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxDatabase operation returned by the service.
- See Also:
-
updateKxDataview
default UpdateKxDataviewResponse updateKxDataview(UpdateKxDataviewRequest updateKxDataviewRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxDataview operation returned by the service.
- See Also:
-
updateKxDataview
default UpdateKxDataviewResponse updateKxDataview(Consumer<UpdateKxDataviewRequest.Builder> updateKxDataviewRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, ResourceAlreadyExistsException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxDataview operation returned by the service.
- See Also:
-
updateKxEnvironment
default UpdateKxEnvironmentResponse updateKxEnvironment(UpdateKxEnvironmentRequest updateKxEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException Updates information for the given kdb environment.
- Parameters:
updateKxEnvironmentRequest
-- Returns:
- Result of the UpdateKxEnvironment operation returned by the service.
- See Also:
-
updateKxEnvironment
default UpdateKxEnvironmentResponse updateKxEnvironment(Consumer<UpdateKxEnvironmentRequest.Builder> updateKxEnvironmentRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxEnvironment operation returned by the service.
- See Also:
-
updateKxEnvironmentNetwork
default UpdateKxEnvironmentNetworkResponse updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest updateKxEnvironmentNetworkRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxEnvironmentNetwork operation returned by the service.
- See Also:
-
updateKxEnvironmentNetwork
default UpdateKxEnvironmentNetworkResponse updateKxEnvironmentNetwork(Consumer<UpdateKxEnvironmentNetworkRequest.Builder> updateKxEnvironmentNetworkRequest) throws ResourceNotFoundException, InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxEnvironmentNetwork operation returned by the service.
- See Also:
-
updateKxUser
default UpdateKxUserResponse updateKxUser(UpdateKxUserRequest updateKxUserRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceException Updates the user details. You can only update the IAM role associated with a user.
- Parameters:
updateKxUserRequest
-- Returns:
- Result of the UpdateKxUser operation returned by the service.
- See Also:
-
updateKxUser
default UpdateKxUserResponse updateKxUser(Consumer<UpdateKxUserRequest.Builder> updateKxUserRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ValidationException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxUser operation returned by the service.
- See Also:
-
updateKxVolume
default UpdateKxVolumeResponse updateKxVolume(UpdateKxVolumeRequest updateKxVolumeRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxVolume operation returned by the service.
- See Also:
-
updateKxVolume
default UpdateKxVolumeResponse updateKxVolume(Consumer<UpdateKxVolumeRequest.Builder> updateKxVolumeRequest) throws InternalServerException, ThrottlingException, AccessDeniedException, LimitExceededException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceException 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:
- Result of the UpdateKxVolume operation returned by the service.
- See Also:
-
create
Create aFinspaceClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aFinspaceClient
. -
serviceMetadata
-
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
-