@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSfinspace extends Object implements AWSfinspace
AWSfinspace
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
CreateEnvironmentResult |
createEnvironment(CreateEnvironmentRequest request)
Deprecated.
|
CreateKxChangesetResult |
createKxChangeset(CreateKxChangesetRequest request)
Creates a changeset for a kdb database.
|
CreateKxClusterResult |
createKxCluster(CreateKxClusterRequest request)
Creates a new kdb cluster.
|
CreateKxDatabaseResult |
createKxDatabase(CreateKxDatabaseRequest request)
Creates a new kdb database in the environment.
|
CreateKxDataviewResult |
createKxDataview(CreateKxDataviewRequest request)
Creates a snapshot of kdb database with tiered storage capabilities and a pre-warmed cache, ready for mounting on
kdb clusters.
|
CreateKxEnvironmentResult |
createKxEnvironment(CreateKxEnvironmentRequest request)
Creates a managed kdb environment for the account.
|
CreateKxScalingGroupResult |
createKxScalingGroup(CreateKxScalingGroupRequest request)
Creates a new scaling group.
|
CreateKxUserResult |
createKxUser(CreateKxUserRequest request)
Creates a user in FinSpace kdb environment with an associated IAM role.
|
CreateKxVolumeResult |
createKxVolume(CreateKxVolumeRequest request)
Creates a new volume with a specific amount of throughput and storage capacity.
|
DeleteEnvironmentResult |
deleteEnvironment(DeleteEnvironmentRequest request)
Deprecated.
|
DeleteKxClusterResult |
deleteKxCluster(DeleteKxClusterRequest request)
Deletes a kdb cluster.
|
DeleteKxClusterNodeResult |
deleteKxClusterNode(DeleteKxClusterNodeRequest request)
Deletes the specified nodes from a cluster.
|
DeleteKxDatabaseResult |
deleteKxDatabase(DeleteKxDatabaseRequest request)
Deletes the specified database and all of its associated data.
|
DeleteKxDataviewResult |
deleteKxDataview(DeleteKxDataviewRequest request)
Deletes the specified dataview.
|
DeleteKxEnvironmentResult |
deleteKxEnvironment(DeleteKxEnvironmentRequest request)
Deletes the kdb environment.
|
DeleteKxScalingGroupResult |
deleteKxScalingGroup(DeleteKxScalingGroupRequest request)
Deletes the specified scaling group.
|
DeleteKxUserResult |
deleteKxUser(DeleteKxUserRequest request)
Deletes a user in the specified kdb environment.
|
DeleteKxVolumeResult |
deleteKxVolume(DeleteKxVolumeRequest request)
Deletes a volume.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetEnvironmentResult |
getEnvironment(GetEnvironmentRequest request)
Deprecated.
|
GetKxChangesetResult |
getKxChangeset(GetKxChangesetRequest request)
Returns information about a kdb changeset.
|
GetKxClusterResult |
getKxCluster(GetKxClusterRequest request)
Retrieves information about a kdb cluster.
|
GetKxConnectionStringResult |
getKxConnectionString(GetKxConnectionStringRequest request)
Retrieves a connection string for a user to connect to a kdb cluster.
|
GetKxDatabaseResult |
getKxDatabase(GetKxDatabaseRequest request)
Returns database information for the specified environment ID.
|
GetKxDataviewResult |
getKxDataview(GetKxDataviewRequest request)
Retrieves details of the dataview.
|
GetKxEnvironmentResult |
getKxEnvironment(GetKxEnvironmentRequest request)
Retrieves all the information for the specified kdb environment.
|
GetKxScalingGroupResult |
getKxScalingGroup(GetKxScalingGroupRequest request)
Retrieves details of a scaling group.
|
GetKxUserResult |
getKxUser(GetKxUserRequest request)
Retrieves information about the specified kdb user.
|
GetKxVolumeResult |
getKxVolume(GetKxVolumeRequest request)
Retrieves the information about the volume.
|
ListEnvironmentsResult |
listEnvironments(ListEnvironmentsRequest request)
Deprecated.
|
ListKxChangesetsResult |
listKxChangesets(ListKxChangesetsRequest request)
Returns a list of all the changesets for a database.
|
ListKxClusterNodesResult |
listKxClusterNodes(ListKxClusterNodesRequest request)
Lists all the nodes in a kdb cluster.
|
ListKxClustersResult |
listKxClusters(ListKxClustersRequest request)
Returns a list of clusters.
|
ListKxDatabasesResult |
listKxDatabases(ListKxDatabasesRequest request)
Returns a list of all the databases in the kdb environment.
|
ListKxDataviewsResult |
listKxDataviews(ListKxDataviewsRequest request)
Returns a list of all the dataviews in the database.
|
ListKxEnvironmentsResult |
listKxEnvironments(ListKxEnvironmentsRequest request)
Returns a list of kdb environments created in an account.
|
ListKxScalingGroupsResult |
listKxScalingGroups(ListKxScalingGroupsRequest request)
Returns a list of scaling groups in a kdb environment.
|
ListKxUsersResult |
listKxUsers(ListKxUsersRequest request)
Lists all the users in a kdb environment.
|
ListKxVolumesResult |
listKxVolumes(ListKxVolumesRequest request)
Lists all the volumes in a kdb environment.
|
ListTagsForResourceResult |
listTagsForResource(ListTagsForResourceRequest request)
A list of all tags for a resource.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Adds metadata tags to a FinSpace resource.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes metadata tags from a FinSpace resource.
|
UpdateEnvironmentResult |
updateEnvironment(UpdateEnvironmentRequest request)
Deprecated.
|
UpdateKxClusterCodeConfigurationResult |
updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest request)
Allows you to update code configuration on a running cluster.
|
UpdateKxClusterDatabasesResult |
updateKxClusterDatabases(UpdateKxClusterDatabasesRequest request)
Updates the databases mounted on a kdb cluster, which includes the
changesetId and all the dbPaths
to be cached. |
UpdateKxDatabaseResult |
updateKxDatabase(UpdateKxDatabaseRequest request)
Updates information for the given kdb database.
|
UpdateKxDataviewResult |
updateKxDataview(UpdateKxDataviewRequest request)
Updates the specified dataview.
|
UpdateKxEnvironmentResult |
updateKxEnvironment(UpdateKxEnvironmentRequest request)
Updates information for the given kdb environment.
|
UpdateKxEnvironmentNetworkResult |
updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest request)
Updates environment network to connect to your internal network by using a transit gateway.
|
UpdateKxUserResult |
updateKxUser(UpdateKxUserRequest request)
Updates the user details.
|
UpdateKxVolumeResult |
updateKxVolume(UpdateKxVolumeRequest request)
Updates the throughput or capacity of a volume.
|
@Deprecated public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
AWSfinspace
Create a new FinSpace environment.
createEnvironment
in interface AWSfinspace
public CreateKxChangesetResult createKxChangeset(CreateKxChangesetRequest request)
AWSfinspace
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.
createKxChangeset
in interface AWSfinspace
public CreateKxClusterResult createKxCluster(CreateKxClusterRequest request)
AWSfinspace
Creates a new kdb cluster.
createKxCluster
in interface AWSfinspace
public CreateKxDatabaseResult createKxDatabase(CreateKxDatabaseRequest request)
AWSfinspace
Creates a new kdb database in the environment.
createKxDatabase
in interface AWSfinspace
public CreateKxDataviewResult createKxDataview(CreateKxDataviewRequest request)
AWSfinspace
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.
createKxDataview
in interface AWSfinspace
public CreateKxEnvironmentResult createKxEnvironment(CreateKxEnvironmentRequest request)
AWSfinspace
Creates a managed kdb environment for the account.
createKxEnvironment
in interface AWSfinspace
public CreateKxScalingGroupResult createKxScalingGroup(CreateKxScalingGroupRequest request)
AWSfinspace
Creates a new scaling group.
createKxScalingGroup
in interface AWSfinspace
public CreateKxUserResult createKxUser(CreateKxUserRequest request)
AWSfinspace
Creates a user in FinSpace kdb environment with an associated IAM role.
createKxUser
in interface AWSfinspace
public CreateKxVolumeResult createKxVolume(CreateKxVolumeRequest request)
AWSfinspace
Creates a new volume with a specific amount of throughput and storage capacity.
createKxVolume
in interface AWSfinspace
@Deprecated public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
AWSfinspace
Delete an FinSpace environment.
deleteEnvironment
in interface AWSfinspace
public DeleteKxClusterResult deleteKxCluster(DeleteKxClusterRequest request)
AWSfinspace
Deletes a kdb cluster.
deleteKxCluster
in interface AWSfinspace
public DeleteKxClusterNodeResult deleteKxClusterNode(DeleteKxClusterNodeRequest request)
AWSfinspace
Deletes the specified nodes from a cluster.
deleteKxClusterNode
in interface AWSfinspace
public DeleteKxDatabaseResult deleteKxDatabase(DeleteKxDatabaseRequest request)
AWSfinspace
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.
deleteKxDatabase
in interface AWSfinspace
public DeleteKxDataviewResult deleteKxDataview(DeleteKxDataviewRequest request)
AWSfinspace
Deletes the specified dataview. Before deleting a dataview, make sure that it is not in use by any cluster.
deleteKxDataview
in interface AWSfinspace
public DeleteKxEnvironmentResult deleteKxEnvironment(DeleteKxEnvironmentRequest request)
AWSfinspace
Deletes the kdb environment. This action is irreversible. Deleting a kdb environment will remove all the associated data and any services running in it.
deleteKxEnvironment
in interface AWSfinspace
public DeleteKxScalingGroupResult deleteKxScalingGroup(DeleteKxScalingGroupRequest request)
AWSfinspace
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.
deleteKxScalingGroup
in interface AWSfinspace
public DeleteKxUserResult deleteKxUser(DeleteKxUserRequest request)
AWSfinspace
Deletes a user in the specified kdb environment.
deleteKxUser
in interface AWSfinspace
public DeleteKxVolumeResult deleteKxVolume(DeleteKxVolumeRequest request)
AWSfinspace
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.
deleteKxVolume
in interface AWSfinspace
@Deprecated public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
AWSfinspace
Returns the FinSpace environment object.
getEnvironment
in interface AWSfinspace
public GetKxChangesetResult getKxChangeset(GetKxChangesetRequest request)
AWSfinspace
Returns information about a kdb changeset.
getKxChangeset
in interface AWSfinspace
public GetKxClusterResult getKxCluster(GetKxClusterRequest request)
AWSfinspace
Retrieves information about a kdb cluster.
getKxCluster
in interface AWSfinspace
public GetKxConnectionStringResult getKxConnectionString(GetKxConnectionStringRequest request)
AWSfinspace
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.
getKxConnectionString
in interface AWSfinspace
public GetKxDatabaseResult getKxDatabase(GetKxDatabaseRequest request)
AWSfinspace
Returns database information for the specified environment ID.
getKxDatabase
in interface AWSfinspace
public GetKxDataviewResult getKxDataview(GetKxDataviewRequest request)
AWSfinspace
Retrieves details of the dataview.
getKxDataview
in interface AWSfinspace
public GetKxEnvironmentResult getKxEnvironment(GetKxEnvironmentRequest request)
AWSfinspace
Retrieves all the information for the specified kdb environment.
getKxEnvironment
in interface AWSfinspace
public GetKxScalingGroupResult getKxScalingGroup(GetKxScalingGroupRequest request)
AWSfinspace
Retrieves details of a scaling group.
getKxScalingGroup
in interface AWSfinspace
public GetKxUserResult getKxUser(GetKxUserRequest request)
AWSfinspace
Retrieves information about the specified kdb user.
getKxUser
in interface AWSfinspace
public GetKxVolumeResult getKxVolume(GetKxVolumeRequest request)
AWSfinspace
Retrieves the information about the volume.
getKxVolume
in interface AWSfinspace
@Deprecated public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
AWSfinspace
A list of all of your FinSpace environments.
listEnvironments
in interface AWSfinspace
public ListKxChangesetsResult listKxChangesets(ListKxChangesetsRequest request)
AWSfinspace
Returns a list of all the changesets for a database.
listKxChangesets
in interface AWSfinspace
public ListKxClusterNodesResult listKxClusterNodes(ListKxClusterNodesRequest request)
AWSfinspace
Lists all the nodes in a kdb cluster.
listKxClusterNodes
in interface AWSfinspace
public ListKxClustersResult listKxClusters(ListKxClustersRequest request)
AWSfinspace
Returns a list of clusters.
listKxClusters
in interface AWSfinspace
public ListKxDatabasesResult listKxDatabases(ListKxDatabasesRequest request)
AWSfinspace
Returns a list of all the databases in the kdb environment.
listKxDatabases
in interface AWSfinspace
public ListKxDataviewsResult listKxDataviews(ListKxDataviewsRequest request)
AWSfinspace
Returns a list of all the dataviews in the database.
listKxDataviews
in interface AWSfinspace
public ListKxEnvironmentsResult listKxEnvironments(ListKxEnvironmentsRequest request)
AWSfinspace
Returns a list of kdb environments created in an account.
listKxEnvironments
in interface AWSfinspace
public ListKxScalingGroupsResult listKxScalingGroups(ListKxScalingGroupsRequest request)
AWSfinspace
Returns a list of scaling groups in a kdb environment.
listKxScalingGroups
in interface AWSfinspace
public ListKxUsersResult listKxUsers(ListKxUsersRequest request)
AWSfinspace
Lists all the users in a kdb environment.
listKxUsers
in interface AWSfinspace
public ListKxVolumesResult listKxVolumes(ListKxVolumesRequest request)
AWSfinspace
Lists all the volumes in a kdb environment.
listKxVolumes
in interface AWSfinspace
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
AWSfinspace
A list of all tags for a resource.
listTagsForResource
in interface AWSfinspace
public TagResourceResult tagResource(TagResourceRequest request)
AWSfinspace
Adds metadata tags to a FinSpace resource.
tagResource
in interface AWSfinspace
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSfinspace
Removes metadata tags from a FinSpace resource.
untagResource
in interface AWSfinspace
@Deprecated public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
AWSfinspace
Update your FinSpace environment.
updateEnvironment
in interface AWSfinspace
public UpdateKxClusterCodeConfigurationResult updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest request)
AWSfinspace
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.
updateKxClusterCodeConfiguration
in interface AWSfinspace
public UpdateKxClusterDatabasesResult updateKxClusterDatabases(UpdateKxClusterDatabasesRequest request)
AWSfinspace
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.
updateKxClusterDatabases
in interface AWSfinspace
public UpdateKxDatabaseResult updateKxDatabase(UpdateKxDatabaseRequest request)
AWSfinspace
Updates information for the given kdb database.
updateKxDatabase
in interface AWSfinspace
public UpdateKxDataviewResult updateKxDataview(UpdateKxDataviewRequest request)
AWSfinspace
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
updateKxDataview
in interface AWSfinspace
public UpdateKxEnvironmentResult updateKxEnvironment(UpdateKxEnvironmentRequest request)
AWSfinspace
Updates information for the given kdb environment.
updateKxEnvironment
in interface AWSfinspace
public UpdateKxEnvironmentNetworkResult updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest request)
AWSfinspace
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.
updateKxEnvironmentNetwork
in interface AWSfinspace
public UpdateKxUserResult updateKxUser(UpdateKxUserRequest request)
AWSfinspace
Updates the user details. You can only update the IAM role associated with a user.
updateKxUser
in interface AWSfinspace
public UpdateKxVolumeResult updateKxVolume(UpdateKxVolumeRequest request)
AWSfinspace
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.
updateKxVolume
in interface AWSfinspace
public void shutdown()
AWSfinspace
shutdown
in interface AWSfinspace
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSfinspace
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
getCachedResponseMetadata
in interface AWSfinspace
request
- The originally executed request.