AbstractAWSfinspace (AWS Java SDK for FinSpace User Environment Management 1.12.604 API)

java.lang.Object
- com.amazonaws.services.finspace.AbstractAWSfinspace

All Implemented Interfaces:

AWSfinspace

Direct Known Subclasses:

AbstractAWSfinspaceAsync
```
@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AbstractAWSfinspace
extends Object
implements AWSfinspace
```
Abstract implementation of AWSfinspace. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

Field Summary
- Fields inherited from interface com.amazonaws.services.finspace.AWSfinspace
  ENDPOINT_PREFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected AbstractAWSfinspace()

Constructors
Modifier	Constructor and Description
`protected`	`AbstractAWSfinspace()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
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.
`CreateKxEnvironmentResult`	`createKxEnvironment(CreateKxEnvironmentRequest request)` Creates a managed kdb environment for the account.
`CreateKxUserResult`	`createKxUser(CreateKxUserRequest request)` Creates a user in FinSpace kdb environment with an associated IAM role.
`DeleteEnvironmentResult`	`deleteEnvironment(DeleteEnvironmentRequest request)` Deprecated.
`DeleteKxClusterResult`	`deleteKxCluster(DeleteKxClusterRequest request)` Deletes a kdb cluster.
`DeleteKxDatabaseResult`	`deleteKxDatabase(DeleteKxDatabaseRequest request)` Deletes the specified database and all of its associated data.
`DeleteKxEnvironmentResult`	`deleteKxEnvironment(DeleteKxEnvironmentRequest request)` Deletes the kdb environment.
`DeleteKxUserResult`	`deleteKxUser(DeleteKxUserRequest request)` Deletes a user in the specified kdb environment.
`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.
`GetKxEnvironmentResult`	`getKxEnvironment(GetKxEnvironmentRequest request)` Retrieves all the information for the specified kdb environment.
`GetKxUserResult`	`getKxUser(GetKxUserRequest request)` Retrieves information about the specified kdb user.
`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.
`ListKxEnvironmentsResult`	`listKxEnvironments(ListKxEnvironmentsRequest request)` Returns a list of kdb environments created in an account.
`ListKxUsersResult`	`listKxUsers(ListKxUsersRequest request)` Lists all the users 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.
`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.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - AbstractAWSfinspace
```
protected AbstractAWSfinspace()
```
- Method Detail
  - createEnvironment
```
@Deprecated
public CreateEnvironmentResult createEnvironment(CreateEnvironmentRequest request)
```
    Deprecated.
    
    Description copied from interface: AWSfinspace
    
    Create a new FinSpace environment.
    
    Specified by:
    
    createEnvironment in interface AWSfinspace
    
    Returns:
    
    Result of the CreateEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKxChangeset
```
public CreateKxChangesetResult createKxChangeset(CreateKxChangesetRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    createKxChangeset in interface AWSfinspace
    
    Returns:
    
    Result of the CreateKxChangeset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKxCluster
```
public CreateKxClusterResult createKxCluster(CreateKxClusterRequest request)
```
    Description copied from interface: AWSfinspace
    
    Creates a new kdb cluster.
    
    Specified by:
    
    createKxCluster in interface AWSfinspace
    
    Returns:
    
    Result of the CreateKxCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKxDatabase
```
public CreateKxDatabaseResult createKxDatabase(CreateKxDatabaseRequest request)
```
    Description copied from interface: AWSfinspace
    
    Creates a new kdb database in the environment.
    
    Specified by:
    
    createKxDatabase in interface AWSfinspace
    
    Returns:
    
    Result of the CreateKxDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKxEnvironment
```
public CreateKxEnvironmentResult createKxEnvironment(CreateKxEnvironmentRequest request)
```
    Description copied from interface: AWSfinspace
    
    Creates a managed kdb environment for the account.
    
    Specified by:
    
    createKxEnvironment in interface AWSfinspace
    
    Returns:
    
    Result of the CreateKxEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - createKxUser
```
public CreateKxUserResult createKxUser(CreateKxUserRequest request)
```
    Description copied from interface: AWSfinspace
    
    Creates a user in FinSpace kdb environment with an associated IAM role.
    
    Specified by:
    
    createKxUser in interface AWSfinspace
    
    Returns:
    
    Result of the CreateKxUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteEnvironment
```
@Deprecated
public DeleteEnvironmentResult deleteEnvironment(DeleteEnvironmentRequest request)
```
    Deprecated.
    
    Description copied from interface: AWSfinspace
    
    Delete an FinSpace environment.
    
    Specified by:
    
    deleteEnvironment in interface AWSfinspace
    
    Returns:
    
    Result of the DeleteEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteKxCluster
```
public DeleteKxClusterResult deleteKxCluster(DeleteKxClusterRequest request)
```
    Description copied from interface: AWSfinspace
    
    Deletes a kdb cluster.
    
    Specified by:
    
    deleteKxCluster in interface AWSfinspace
    
    Returns:
    
    Result of the DeleteKxCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteKxDatabase
```
public DeleteKxDatabaseResult deleteKxDatabase(DeleteKxDatabaseRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    deleteKxDatabase in interface AWSfinspace
    
    Returns:
    
    Result of the DeleteKxDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteKxEnvironment
```
public DeleteKxEnvironmentResult deleteKxEnvironment(DeleteKxEnvironmentRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    deleteKxEnvironment in interface AWSfinspace
    
    Returns:
    
    Result of the DeleteKxEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - deleteKxUser
```
public DeleteKxUserResult deleteKxUser(DeleteKxUserRequest request)
```
    Description copied from interface: AWSfinspace
    
    Deletes a user in the specified kdb environment.
    
    Specified by:
    
    deleteKxUser in interface AWSfinspace
    
    Returns:
    
    Result of the DeleteKxUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getEnvironment
```
@Deprecated
public GetEnvironmentResult getEnvironment(GetEnvironmentRequest request)
```
    Deprecated.
    
    Description copied from interface: AWSfinspace
    
    Returns the FinSpace environment object.
    
    Specified by:
    
    getEnvironment in interface AWSfinspace
    
    Returns:
    
    Result of the GetEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKxChangeset
```
public GetKxChangesetResult getKxChangeset(GetKxChangesetRequest request)
```
    Description copied from interface: AWSfinspace
    
    Returns information about a kdb changeset.
    
    Specified by:
    
    getKxChangeset in interface AWSfinspace
    
    Returns:
    
    Result of the GetKxChangeset operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKxCluster
```
public GetKxClusterResult getKxCluster(GetKxClusterRequest request)
```
    Description copied from interface: AWSfinspace
    
    Retrieves information about a kdb cluster.
    
    Specified by:
    
    getKxCluster in interface AWSfinspace
    
    Returns:
    
    Result of the GetKxCluster operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKxConnectionString
```
public GetKxConnectionStringResult getKxConnectionString(GetKxConnectionStringRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    getKxConnectionString in interface AWSfinspace
    
    Returns:
    
    Result of the GetKxConnectionString operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKxDatabase
```
public GetKxDatabaseResult getKxDatabase(GetKxDatabaseRequest request)
```
    Description copied from interface: AWSfinspace
    
    Returns database information for the specified environment ID.
    
    Specified by:
    
    getKxDatabase in interface AWSfinspace
    
    Returns:
    
    Result of the GetKxDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKxEnvironment
```
public GetKxEnvironmentResult getKxEnvironment(GetKxEnvironmentRequest request)
```
    Description copied from interface: AWSfinspace
    
    Retrieves all the information for the specified kdb environment.
    
    Specified by:
    
    getKxEnvironment in interface AWSfinspace
    
    Returns:
    
    Result of the GetKxEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - getKxUser
```
public GetKxUserResult getKxUser(GetKxUserRequest request)
```
    Description copied from interface: AWSfinspace
    
    Retrieves information about the specified kdb user.
    
    Specified by:
    
    getKxUser in interface AWSfinspace
    
    Returns:
    
    Result of the GetKxUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listEnvironments
```
@Deprecated
public ListEnvironmentsResult listEnvironments(ListEnvironmentsRequest request)
```
    Deprecated.
    
    Description copied from interface: AWSfinspace
    
    A list of all of your FinSpace environments.
    
    Specified by:
    
    listEnvironments in interface AWSfinspace
    
    Returns:
    
    Result of the ListEnvironments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKxChangesets
```
public ListKxChangesetsResult listKxChangesets(ListKxChangesetsRequest request)
```
    Description copied from interface: AWSfinspace
    
    Returns a list of all the changesets for a database.
    
    Specified by:
    
    listKxChangesets in interface AWSfinspace
    
    Returns:
    
    Result of the ListKxChangesets operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKxClusterNodes
```
public ListKxClusterNodesResult listKxClusterNodes(ListKxClusterNodesRequest request)
```
    Description copied from interface: AWSfinspace
    
    Lists all the nodes in a kdb cluster.
    
    Specified by:
    
    listKxClusterNodes in interface AWSfinspace
    
    Returns:
    
    Result of the ListKxClusterNodes operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKxClusters
```
public ListKxClustersResult listKxClusters(ListKxClustersRequest request)
```
    Description copied from interface: AWSfinspace
    
    Returns a list of clusters.
    
    Specified by:
    
    listKxClusters in interface AWSfinspace
    
    Returns:
    
    Result of the ListKxClusters operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKxDatabases
```
public ListKxDatabasesResult listKxDatabases(ListKxDatabasesRequest request)
```
    Description copied from interface: AWSfinspace
    
    Returns a list of all the databases in the kdb environment.
    
    Specified by:
    
    listKxDatabases in interface AWSfinspace
    
    Returns:
    
    Result of the ListKxDatabases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKxEnvironments
```
public ListKxEnvironmentsResult listKxEnvironments(ListKxEnvironmentsRequest request)
```
    Description copied from interface: AWSfinspace
    
    Returns a list of kdb environments created in an account.
    
    Specified by:
    
    listKxEnvironments in interface AWSfinspace
    
    Returns:
    
    Result of the ListKxEnvironments operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listKxUsers
```
public ListKxUsersResult listKxUsers(ListKxUsersRequest request)
```
    Description copied from interface: AWSfinspace
    
    Lists all the users in a kdb environment.
    
    Specified by:
    
    listKxUsers in interface AWSfinspace
    
    Returns:
    
    Result of the ListKxUsers operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - listTagsForResource
```
public ListTagsForResourceResult listTagsForResource(ListTagsForResourceRequest request)
```
    Description copied from interface: AWSfinspace
    
    A list of all tags for a resource.
    
    Specified by:
    
    listTagsForResource in interface AWSfinspace
    
    Returns:
    
    Result of the ListTagsForResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - tagResource
```
public TagResourceResult tagResource(TagResourceRequest request)
```
    Description copied from interface: AWSfinspace
    
    Adds metadata tags to a FinSpace resource.
    
    Specified by:
    
    tagResource in interface AWSfinspace
    
    Returns:
    
    Result of the TagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - untagResource
```
public UntagResourceResult untagResource(UntagResourceRequest request)
```
    Description copied from interface: AWSfinspace
    
    Removes metadata tags from a FinSpace resource.
    
    Specified by:
    
    untagResource in interface AWSfinspace
    
    Returns:
    
    Result of the UntagResource operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateEnvironment
```
@Deprecated
public UpdateEnvironmentResult updateEnvironment(UpdateEnvironmentRequest request)
```
    Deprecated.
    
    Description copied from interface: AWSfinspace
    
    Update your FinSpace environment.
    
    Specified by:
    
    updateEnvironment in interface AWSfinspace
    
    Returns:
    
    Result of the UpdateEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateKxClusterCodeConfiguration
```
public UpdateKxClusterCodeConfigurationResult updateKxClusterCodeConfiguration(UpdateKxClusterCodeConfigurationRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    updateKxClusterCodeConfiguration in interface AWSfinspace
    
    Returns:
    
    Result of the UpdateKxClusterCodeConfiguration operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateKxClusterDatabases
```
public UpdateKxClusterDatabasesResult updateKxClusterDatabases(UpdateKxClusterDatabasesRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    updateKxClusterDatabases in interface AWSfinspace
    
    Returns:
    
    Result of the UpdateKxClusterDatabases operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateKxDatabase
```
public UpdateKxDatabaseResult updateKxDatabase(UpdateKxDatabaseRequest request)
```
    Description copied from interface: AWSfinspace
    
    Updates information for the given kdb database.
    
    Specified by:
    
    updateKxDatabase in interface AWSfinspace
    
    Returns:
    
    Result of the UpdateKxDatabase operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateKxEnvironment
```
public UpdateKxEnvironmentResult updateKxEnvironment(UpdateKxEnvironmentRequest request)
```
    Description copied from interface: AWSfinspace
    
    Updates information for the given kdb environment.
    
    Specified by:
    
    updateKxEnvironment in interface AWSfinspace
    
    Returns:
    
    Result of the UpdateKxEnvironment operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateKxEnvironmentNetwork
```
public UpdateKxEnvironmentNetworkResult updateKxEnvironmentNetwork(UpdateKxEnvironmentNetworkRequest request)
```
    Description copied from interface: 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.
    
    Specified by:
    
    updateKxEnvironmentNetwork in interface AWSfinspace
    
    Returns:
    
    Result of the UpdateKxEnvironmentNetwork operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - updateKxUser
```
public UpdateKxUserResult updateKxUser(UpdateKxUserRequest request)
```
    Description copied from interface: AWSfinspace
    
    Updates the user details. You can only update the IAM role associated with a user.
    
    Specified by:
    
    updateKxUser in interface AWSfinspace
    
    Returns:
    
    Result of the UpdateKxUser operation returned by the service.
    
    See Also:
    
    AWS API Documentation
  - shutdown
```
public void shutdown()
```
    Description copied from interface: AWSfinspace
    
    Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.
    
    Specified by:
    
    shutdown in interface AWSfinspace
  - getCachedResponseMetadata
```
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
```
    Description copied from interface: AWSfinspace
    
    Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.
    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.
    
    Specified by:
    
    getCachedResponseMetadata in interface AWSfinspace
    
    Parameters:
    
    request - The originally executed request.
    
    Returns:
    
    The response metadata for the specified request, or null if none is available.

Class AbstractAWSfinspace

Field Summary

Fields inherited from interface com.amazonaws.services.finspace.AWSfinspace

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AbstractAWSfinspace

Method Detail

createEnvironment

createKxChangeset

createKxCluster

createKxDatabase

createKxEnvironment

createKxUser

deleteEnvironment

deleteKxCluster

deleteKxDatabase

deleteKxEnvironment

deleteKxUser

getEnvironment

getKxChangeset

getKxCluster

getKxConnectionString

getKxDatabase

getKxEnvironment

getKxUser

listEnvironments

listKxChangesets

listKxClusterNodes

listKxClusters

listKxDatabases

listKxEnvironments

listKxUsers

listTagsForResource

tagResource

untagResource

updateEnvironment

updateKxClusterCodeConfiguration

updateKxClusterDatabases

updateKxDatabase

updateKxEnvironment

updateKxEnvironmentNetwork

updateKxUser

shutdown

getCachedResponseMetadata