FinspaceDataClient

The FinSpace APIs let you take actions inside the FinSpace.

Properties

Link copied to clipboard
abstract override val config: FinspaceDataClient.Config

FinspaceDataClient's configuration

Functions

Link copied to clipboard

Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.

Link copied to clipboard

Creates a new Changeset in a FinSpace Dataset.

Link copied to clipboard

Creates a new FinSpace Dataset.

Link copied to clipboard

Creates a Dataview for a Dataset.

Link copied to clipboard

Creates a group of permissions for various actions that a user can perform in FinSpace.

Link copied to clipboard
abstract suspend fun createUser(input: CreateUserRequest): CreateUserResponse

Creates a new user in FinSpace.

Link copied to clipboard

Deletes a FinSpace Dataset.

Link copied to clipboard

Deletes a permission group. This action is irreversible.

Link copied to clipboard
abstract suspend fun disableUser(input: DisableUserRequest): DisableUserResponse

Denies access to the FinSpace web application and API for the specified user.

Link copied to clipboard
abstract suspend fun enableUser(input: EnableUserRequest): EnableUserResponse

Allows the specified user to access the FinSpace web application and API.

Link copied to clipboard

Get information about a Changeset.

Link copied to clipboard
abstract suspend fun getDataset(input: GetDatasetRequest): GetDatasetResponse

Returns information about a Dataset.

Link copied to clipboard
abstract suspend fun getDataView(input: GetDataViewRequest): GetDataViewResponse

Gets information about a Dataview.

Link copied to clipboard

Returns the credentials to access the external Dataview from an S3 location. To call this API:

Link copied to clipboard

Retrieves the details of a specific permission group.

Link copied to clipboard
abstract suspend fun getUser(input: GetUserRequest): GetUserResponse

Retrieves details for a specific user.

Link copied to clipboard
abstract suspend fun getWorkingLocation(input: GetWorkingLocationRequest = GetWorkingLocationRequest { }): GetWorkingLocationResponse

A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.

Link copied to clipboard

Lists the FinSpace Changesets for a Dataset.

Link copied to clipboard
abstract suspend fun listDatasets(input: ListDatasetsRequest = ListDatasetsRequest { }): ListDatasetsResponse

Lists all of the active Datasets that a user has access to.

Link copied to clipboard

Lists all available Dataviews for a Dataset.

Link copied to clipboard

Lists all available permission groups in FinSpace.

Link copied to clipboard

Lists all the permission groups that are associated with a specific user.

Link copied to clipboard
abstract suspend fun listUsers(input: ListUsersRequest): ListUsersResponse

Lists all available users in FinSpace.

Link copied to clipboard

Lists details of all the users in a specific permission group.

Link copied to clipboard

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

Link copied to clipboard

Updates a FinSpace Changeset.

Link copied to clipboard

Updates a FinSpace Dataset.

Link copied to clipboard

Modifies the details of a permission group. You cannot modify a permissionGroupID.

Link copied to clipboard
abstract suspend fun updateUser(input: UpdateUserRequest): UpdateUserResponse

Modifies the details of the specified user. You cannot update the userId for a user.

Inherited functions

Link copied to clipboard

Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

Creates a new Changeset in a FinSpace Dataset.

Link copied to clipboard

Creates a new FinSpace Dataset.

Link copied to clipboard

Creates a Dataview for a Dataset.

Link copied to clipboard

Creates a group of permissions for various actions that a user can perform in FinSpace.

Link copied to clipboard
inline suspend fun FinspaceDataClient.createUser(crossinline block: CreateUserRequest.Builder.() -> Unit): CreateUserResponse

Creates a new user in FinSpace.

Link copied to clipboard

Deletes a FinSpace Dataset.

Link copied to clipboard

Deletes a permission group. This action is irreversible.

Link copied to clipboard

Denies access to the FinSpace web application and API for the specified user.

Link copied to clipboard
inline suspend fun FinspaceDataClient.enableUser(crossinline block: EnableUserRequest.Builder.() -> Unit): EnableUserResponse

Allows the specified user to access the FinSpace web application and API.

Link copied to clipboard

Get information about a Changeset.

Link copied to clipboard
inline suspend fun FinspaceDataClient.getDataset(crossinline block: GetDatasetRequest.Builder.() -> Unit): GetDatasetResponse

Returns information about a Dataset.

Link copied to clipboard

Gets information about a Dataview.

Link copied to clipboard

Returns the credentials to access the external Dataview from an S3 location. To call this API:

Link copied to clipboard

Retrieves the details of a specific permission group.

Link copied to clipboard
inline suspend fun FinspaceDataClient.getUser(crossinline block: GetUserRequest.Builder.() -> Unit): GetUserResponse

Retrieves details for a specific user.

Link copied to clipboard

A temporary Amazon S3 location, where you can copy your files from a source location to stage or use as a scratch space in FinSpace notebook.

Link copied to clipboard

Lists the FinSpace Changesets for a Dataset.

Link copied to clipboard

Lists all of the active Datasets that a user has access to.

Link copied to clipboard

Lists all available Dataviews for a Dataset.

Link copied to clipboard

Lists all available permission groups in FinSpace.

Link copied to clipboard

Lists all the permission groups that are associated with a specific user.

Link copied to clipboard
inline suspend fun FinspaceDataClient.listUsers(crossinline block: ListUsersRequest.Builder.() -> Unit): ListUsersResponse

Lists all available users in FinSpace.

Link copied to clipboard

Lists details of all the users in a specific permission group.

Link copied to clipboard

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

Link copied to clipboard

Updates a FinSpace Changeset.

Link copied to clipboard

Updates a FinSpace Dataset.

Link copied to clipboard

Modifies the details of a permission group. You cannot modify a permissionGroupID.

Link copied to clipboard
inline suspend fun FinspaceDataClient.updateUser(crossinline block: UpdateUserRequest.Builder.() -> Unit): UpdateUserResponse

Modifies the details of the specified user. You cannot update the userId for a user.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.