Interface FinspaceDataAsyncClient
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
builder()
method.
The FinSpace APIs let you take actions inside the FinSpace.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringValue for looking up the service's metadata from theServiceMetadataProvider.static final String -
Method Summary
Modifier and TypeMethodDescriptionassociateUserToPermissionGroup(Consumer<AssociateUserToPermissionGroupRequest.Builder> associateUserToPermissionGroupRequest) Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest associateUserToPermissionGroupRequest) Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.builder()Create a builder that can be used to configure and create aFinspaceDataAsyncClient.static FinspaceDataAsyncClientcreate()Create aFinspaceDataAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default CompletableFuture<CreateChangesetResponse> createChangeset(Consumer<CreateChangesetRequest.Builder> createChangesetRequest) Creates a new Changeset in a FinSpace Dataset.default CompletableFuture<CreateChangesetResponse> createChangeset(CreateChangesetRequest createChangesetRequest) Creates a new Changeset in a FinSpace Dataset.default CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) Creates a new FinSpace Dataset.default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest) Creates a new FinSpace Dataset.default CompletableFuture<CreateDataViewResponse> createDataView(Consumer<CreateDataViewRequest.Builder> createDataViewRequest) Creates a Dataview for a Dataset.default CompletableFuture<CreateDataViewResponse> createDataView(CreateDataViewRequest createDataViewRequest) Creates a Dataview for a Dataset.createPermissionGroup(Consumer<CreatePermissionGroupRequest.Builder> createPermissionGroupRequest) Creates a group of permissions for various actions that a user can perform in FinSpace.createPermissionGroup(CreatePermissionGroupRequest createPermissionGroupRequest) Creates a group of permissions for various actions that a user can perform in FinSpace.default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a new user in FinSpace.default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest) Creates a new user in FinSpace.default CompletableFuture<DeleteDatasetResponse> deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) Deletes a FinSpace Dataset.default CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deletes a FinSpace Dataset.deletePermissionGroup(Consumer<DeletePermissionGroupRequest.Builder> deletePermissionGroupRequest) Deletes a permission group.deletePermissionGroup(DeletePermissionGroupRequest deletePermissionGroupRequest) Deletes a permission group.default CompletableFuture<DisableUserResponse> disableUser(Consumer<DisableUserRequest.Builder> disableUserRequest) Denies access to the FinSpace web application and API for the specified user.default CompletableFuture<DisableUserResponse> disableUser(DisableUserRequest disableUserRequest) Denies access to the FinSpace web application and API for the specified user.disassociateUserFromPermissionGroup(Consumer<DisassociateUserFromPermissionGroupRequest.Builder> disassociateUserFromPermissionGroupRequest) Removes a user from a permission group.disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest disassociateUserFromPermissionGroupRequest) Removes a user from a permission group.default CompletableFuture<EnableUserResponse> enableUser(Consumer<EnableUserRequest.Builder> enableUserRequest) Allows the specified user to access the FinSpace web application and API.default CompletableFuture<EnableUserResponse> enableUser(EnableUserRequest enableUserRequest) Allows the specified user to access the FinSpace web application and API.default CompletableFuture<GetChangesetResponse> getChangeset(Consumer<GetChangesetRequest.Builder> getChangesetRequest) Get information about a Changeset.default CompletableFuture<GetChangesetResponse> getChangeset(GetChangesetRequest getChangesetRequest) Get information about a Changeset.default CompletableFuture<GetDatasetResponse> getDataset(Consumer<GetDatasetRequest.Builder> getDatasetRequest) Returns information about a Dataset.default CompletableFuture<GetDatasetResponse> getDataset(GetDatasetRequest getDatasetRequest) Returns information about a Dataset.default CompletableFuture<GetDataViewResponse> getDataView(Consumer<GetDataViewRequest.Builder> getDataViewRequest) Gets information about a Dataview.default CompletableFuture<GetDataViewResponse> getDataView(GetDataViewRequest getDataViewRequest) Gets information about a Dataview.getExternalDataViewAccessDetails(Consumer<GetExternalDataViewAccessDetailsRequest.Builder> getExternalDataViewAccessDetailsRequest) Returns the credentials to access the external Dataview from an S3 location.getExternalDataViewAccessDetails(GetExternalDataViewAccessDetailsRequest getExternalDataViewAccessDetailsRequest) Returns the credentials to access the external Dataview from an S3 location.getPermissionGroup(Consumer<GetPermissionGroupRequest.Builder> getPermissionGroupRequest) Retrieves the details of a specific permission group.getPermissionGroup(GetPermissionGroupRequest getPermissionGroupRequest) Retrieves the details of a specific permission group.getProgrammaticAccessCredentials(Consumer<GetProgrammaticAccessCredentialsRequest.Builder> getProgrammaticAccessCredentialsRequest) Request programmatic credentials to use with FinSpace SDK.getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest) Request programmatic credentials to use with FinSpace SDK.default CompletableFuture<GetUserResponse> getUser(Consumer<GetUserRequest.Builder> getUserRequest) Retrieves details for a specific user.default CompletableFuture<GetUserResponse> getUser(GetUserRequest getUserRequest) Retrieves details for a specific user.getWorkingLocation(Consumer<GetWorkingLocationRequest.Builder> getWorkingLocationRequest) 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.getWorkingLocation(GetWorkingLocationRequest getWorkingLocationRequest) 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.default CompletableFuture<ListChangesetsResponse> listChangesets(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.default CompletableFuture<ListChangesetsResponse> listChangesets(ListChangesetsRequest listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.default ListChangesetsPublisherlistChangesetsPaginator(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.default ListChangesetsPublisherlistChangesetsPaginator(ListChangesetsRequest listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.default CompletableFuture<ListDatasetsResponse> listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) Lists all of the active Datasets that a user has access to.default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest) Lists all of the active Datasets that a user has access to.default ListDatasetsPublisherlistDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) Lists all of the active Datasets that a user has access to.default ListDatasetsPublisherlistDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) Lists all of the active Datasets that a user has access to.default CompletableFuture<ListDataViewsResponse> listDataViews(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest) Lists all available Dataviews for a Dataset.default CompletableFuture<ListDataViewsResponse> listDataViews(ListDataViewsRequest listDataViewsRequest) Lists all available Dataviews for a Dataset.default ListDataViewsPublisherlistDataViewsPaginator(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest) Lists all available Dataviews for a Dataset.default ListDataViewsPublisherlistDataViewsPaginator(ListDataViewsRequest listDataViewsRequest) Lists all available Dataviews for a Dataset.listPermissionGroups(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest) Lists all available permission groups in FinSpace.listPermissionGroups(ListPermissionGroupsRequest listPermissionGroupsRequest) Lists all available permission groups in FinSpace.listPermissionGroupsByUser(Consumer<ListPermissionGroupsByUserRequest.Builder> listPermissionGroupsByUserRequest) Lists all the permission groups that are associated with a specific user.listPermissionGroupsByUser(ListPermissionGroupsByUserRequest listPermissionGroupsByUserRequest) Lists all the permission groups that are associated with a specific user.default ListPermissionGroupsPublisherlistPermissionGroupsPaginator(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest) Lists all available permission groups in FinSpace.default ListPermissionGroupsPublisherlistPermissionGroupsPaginator(ListPermissionGroupsRequest listPermissionGroupsRequest) Lists all available permission groups in FinSpace.default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists all available users in FinSpace.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest) Lists all available users in FinSpace.listUsersByPermissionGroup(Consumer<ListUsersByPermissionGroupRequest.Builder> listUsersByPermissionGroupRequest) Lists details of all the users in a specific permission group.listUsersByPermissionGroup(ListUsersByPermissionGroupRequest listUsersByPermissionGroupRequest) Lists details of all the users in a specific permission group.default ListUsersPublisherlistUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists all available users in FinSpace.default ListUsersPublisherlistUsersPaginator(ListUsersRequest listUsersRequest) Lists all available users in FinSpace.resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest) Resets the password for a specified user ID and generates a temporary one.resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest) Resets the password for a specified user ID and generates a temporary one.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationdefault CompletableFuture<UpdateChangesetResponse> updateChangeset(Consumer<UpdateChangesetRequest.Builder> updateChangesetRequest) Updates a FinSpace Changeset.default CompletableFuture<UpdateChangesetResponse> updateChangeset(UpdateChangesetRequest updateChangesetRequest) Updates a FinSpace Changeset.default CompletableFuture<UpdateDatasetResponse> updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest) Updates a FinSpace Dataset.default CompletableFuture<UpdateDatasetResponse> updateDataset(UpdateDatasetRequest updateDatasetRequest) Updates a FinSpace Dataset.updatePermissionGroup(Consumer<UpdatePermissionGroupRequest.Builder> updatePermissionGroupRequest) Modifies the details of a permission group.updatePermissionGroup(UpdatePermissionGroupRequest updatePermissionGroupRequest) Modifies the details of a permission group.default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Modifies the details of the specified user.default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest) Modifies the details of the specified user.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
closeMethods 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
-
associateUserToPermissionGroup
default CompletableFuture<AssociateUserToPermissionGroupResponse> associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest associateUserToPermissionGroupRequest) Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
- Parameters:
associateUserToPermissionGroupRequest-- Returns:
- A Java Future containing the result of the AssociateUserToPermissionGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
associateUserToPermissionGroup
default CompletableFuture<AssociateUserToPermissionGroupResponse> associateUserToPermissionGroup(Consumer<AssociateUserToPermissionGroupRequest.Builder> associateUserToPermissionGroupRequest) Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
This is a convenience which creates an instance of the
AssociateUserToPermissionGroupRequest.Builderavoiding the need to create one manually viaAssociateUserToPermissionGroupRequest.builder()- Parameters:
associateUserToPermissionGroupRequest- AConsumerthat will call methods onAssociateUserToPermissionGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the AssociateUserToPermissionGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChangeset
default CompletableFuture<CreateChangesetResponse> createChangeset(CreateChangesetRequest createChangesetRequest) Creates a new Changeset in a FinSpace Dataset.
- Parameters:
createChangesetRequest- The request for a CreateChangeset operation.- Returns:
- A Java Future containing the result of the CreateChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createChangeset
default CompletableFuture<CreateChangesetResponse> createChangeset(Consumer<CreateChangesetRequest.Builder> createChangesetRequest) Creates a new Changeset in a FinSpace Dataset.
This is a convenience which creates an instance of the
CreateChangesetRequest.Builderavoiding the need to create one manually viaCreateChangesetRequest.builder()- Parameters:
createChangesetRequest- AConsumerthat will call methods onCreateChangesetRequest.Builderto create a request. The request for a CreateChangeset operation.- Returns:
- A Java Future containing the result of the CreateChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataView
default CompletableFuture<CreateDataViewResponse> createDataView(CreateDataViewRequest createDataViewRequest) Creates a Dataview for a Dataset.
- Parameters:
createDataViewRequest- Request for creating a data view.- Returns:
- A Java Future containing the result of the CreateDataView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataView
default CompletableFuture<CreateDataViewResponse> createDataView(Consumer<CreateDataViewRequest.Builder> createDataViewRequest) Creates a Dataview for a Dataset.
This is a convenience which creates an instance of the
CreateDataViewRequest.Builderavoiding the need to create one manually viaCreateDataViewRequest.builder()- Parameters:
createDataViewRequest- AConsumerthat will call methods onCreateDataViewRequest.Builderto create a request. Request for creating a data view.- Returns:
- A Java Future containing the result of the CreateDataView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataset
default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest) Creates a new FinSpace Dataset.
- Parameters:
createDatasetRequest- The request for a CreateDataset operation- Returns:
- A Java Future containing the result of the CreateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createDataset
default CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) Creates a new FinSpace Dataset.
This is a convenience which creates an instance of the
CreateDatasetRequest.Builderavoiding the need to create one manually viaCreateDatasetRequest.builder()- Parameters:
createDatasetRequest- AConsumerthat will call methods onCreateDatasetRequest.Builderto create a request. The request for a CreateDataset operation- Returns:
- A Java Future containing the result of the CreateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPermissionGroup
default CompletableFuture<CreatePermissionGroupResponse> createPermissionGroup(CreatePermissionGroupRequest createPermissionGroupRequest) Creates a group of permissions for various actions that a user can perform in FinSpace.
- Parameters:
createPermissionGroupRequest-- Returns:
- A Java Future containing the result of the CreatePermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createPermissionGroup
default CompletableFuture<CreatePermissionGroupResponse> createPermissionGroup(Consumer<CreatePermissionGroupRequest.Builder> createPermissionGroupRequest) Creates a group of permissions for various actions that a user can perform in FinSpace.
This is a convenience which creates an instance of the
CreatePermissionGroupRequest.Builderavoiding the need to create one manually viaCreatePermissionGroupRequest.builder()- Parameters:
createPermissionGroupRequest- AConsumerthat will call methods onCreatePermissionGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreatePermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
Creates a new user in FinSpace.
- Parameters:
createUserRequest-- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
createUser
default CompletableFuture<CreateUserResponse> createUser(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a new user in FinSpace.
This is a convenience which creates an instance of the
CreateUserRequest.Builderavoiding the need to create one manually viaCreateUserRequest.builder()- Parameters:
createUserRequest- AConsumerthat will call methods onCreateUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the CreateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataset
default CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest deleteDatasetRequest) Deletes a FinSpace Dataset.
- Parameters:
deleteDatasetRequest- The request for a DeleteDataset operation.- Returns:
- A Java Future containing the result of the DeleteDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deleteDataset
default CompletableFuture<DeleteDatasetResponse> deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) Deletes a FinSpace Dataset.
This is a convenience which creates an instance of the
DeleteDatasetRequest.Builderavoiding the need to create one manually viaDeleteDatasetRequest.builder()- Parameters:
deleteDatasetRequest- AConsumerthat will call methods onDeleteDatasetRequest.Builderto create a request. The request for a DeleteDataset operation.- Returns:
- A Java Future containing the result of the DeleteDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePermissionGroup
default CompletableFuture<DeletePermissionGroupResponse> deletePermissionGroup(DeletePermissionGroupRequest deletePermissionGroupRequest) Deletes a permission group. This action is irreversible.
- Parameters:
deletePermissionGroupRequest-- Returns:
- A Java Future containing the result of the DeletePermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
deletePermissionGroup
default CompletableFuture<DeletePermissionGroupResponse> deletePermissionGroup(Consumer<DeletePermissionGroupRequest.Builder> deletePermissionGroupRequest) Deletes a permission group. This action is irreversible.
This is a convenience which creates an instance of the
DeletePermissionGroupRequest.Builderavoiding the need to create one manually viaDeletePermissionGroupRequest.builder()- Parameters:
deletePermissionGroupRequest- AConsumerthat will call methods onDeletePermissionGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DeletePermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableUser
Denies access to the FinSpace web application and API for the specified user.
- Parameters:
disableUserRequest-- Returns:
- A Java Future containing the result of the DisableUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disableUser
default CompletableFuture<DisableUserResponse> disableUser(Consumer<DisableUserRequest.Builder> disableUserRequest) Denies access to the FinSpace web application and API for the specified user.
This is a convenience which creates an instance of the
DisableUserRequest.Builderavoiding the need to create one manually viaDisableUserRequest.builder()- Parameters:
disableUserRequest- AConsumerthat will call methods onDisableUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisableUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateUserFromPermissionGroup
default CompletableFuture<DisassociateUserFromPermissionGroupResponse> disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest disassociateUserFromPermissionGroupRequest) Removes a user from a permission group.
- Parameters:
disassociateUserFromPermissionGroupRequest-- Returns:
- A Java Future containing the result of the DisassociateUserFromPermissionGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
disassociateUserFromPermissionGroup
default CompletableFuture<DisassociateUserFromPermissionGroupResponse> disassociateUserFromPermissionGroup(Consumer<DisassociateUserFromPermissionGroupRequest.Builder> disassociateUserFromPermissionGroupRequest) Removes a user from a permission group.
This is a convenience which creates an instance of the
DisassociateUserFromPermissionGroupRequest.Builderavoiding the need to create one manually viaDisassociateUserFromPermissionGroupRequest.builder()- Parameters:
disassociateUserFromPermissionGroupRequest- AConsumerthat will call methods onDisassociateUserFromPermissionGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the DisassociateUserFromPermissionGroup operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableUser
Allows the specified user to access the FinSpace web application and API.
- Parameters:
enableUserRequest-- Returns:
- A Java Future containing the result of the EnableUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
enableUser
default CompletableFuture<EnableUserResponse> enableUser(Consumer<EnableUserRequest.Builder> enableUserRequest) Allows the specified user to access the FinSpace web application and API.
This is a convenience which creates an instance of the
EnableUserRequest.Builderavoiding the need to create one manually viaEnableUserRequest.builder()- Parameters:
enableUserRequest- AConsumerthat will call methods onEnableUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the EnableUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- LimitExceededException A limit has exceeded.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChangeset
default CompletableFuture<GetChangesetResponse> getChangeset(GetChangesetRequest getChangesetRequest) Get information about a Changeset.
- Parameters:
getChangesetRequest- Request to describe a changeset.- Returns:
- A Java Future containing the result of the GetChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getChangeset
default CompletableFuture<GetChangesetResponse> getChangeset(Consumer<GetChangesetRequest.Builder> getChangesetRequest) Get information about a Changeset.
This is a convenience which creates an instance of the
GetChangesetRequest.Builderavoiding the need to create one manually viaGetChangesetRequest.builder()- Parameters:
getChangesetRequest- AConsumerthat will call methods onGetChangesetRequest.Builderto create a request. Request to describe a changeset.- Returns:
- A Java Future containing the result of the GetChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataView
Gets information about a Dataview.
- Parameters:
getDataViewRequest- Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.- Returns:
- A Java Future containing the result of the GetDataView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataView
default CompletableFuture<GetDataViewResponse> getDataView(Consumer<GetDataViewRequest.Builder> getDataViewRequest) Gets information about a Dataview.
This is a convenience which creates an instance of the
GetDataViewRequest.Builderavoiding the need to create one manually viaGetDataViewRequest.builder()- Parameters:
getDataViewRequest- AConsumerthat will call methods onGetDataViewRequest.Builderto create a request. Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.- Returns:
- A Java Future containing the result of the GetDataView operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataset
Returns information about a Dataset.
- Parameters:
getDatasetRequest- Request for the GetDataset operation.- Returns:
- A Java Future containing the result of the GetDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getDataset
default CompletableFuture<GetDatasetResponse> getDataset(Consumer<GetDatasetRequest.Builder> getDatasetRequest) Returns information about a Dataset.
This is a convenience which creates an instance of the
GetDatasetRequest.Builderavoiding the need to create one manually viaGetDatasetRequest.builder()- Parameters:
getDatasetRequest- AConsumerthat will call methods onGetDatasetRequest.Builderto create a request. Request for the GetDataset operation.- Returns:
- A Java Future containing the result of the GetDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getExternalDataViewAccessDetails
default CompletableFuture<GetExternalDataViewAccessDetailsResponse> getExternalDataViewAccessDetails(GetExternalDataViewAccessDetailsRequest getExternalDataViewAccessDetailsRequest) Returns the credentials to access the external Dataview from an S3 location. To call this API:
-
You must retrieve the programmatic credentials.
-
You must be a member of a FinSpace user group, where the dataset that you want to access has
Read Dataset Datapermissions.
- Parameters:
getExternalDataViewAccessDetailsRequest-- Returns:
- A Java Future containing the result of the GetExternalDataViewAccessDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getExternalDataViewAccessDetails
default CompletableFuture<GetExternalDataViewAccessDetailsResponse> getExternalDataViewAccessDetails(Consumer<GetExternalDataViewAccessDetailsRequest.Builder> getExternalDataViewAccessDetailsRequest) Returns the credentials to access the external Dataview from an S3 location. To call this API:
-
You must retrieve the programmatic credentials.
-
You must be a member of a FinSpace user group, where the dataset that you want to access has
Read Dataset Datapermissions.
This is a convenience which creates an instance of the
GetExternalDataViewAccessDetailsRequest.Builderavoiding the need to create one manually viaGetExternalDataViewAccessDetailsRequest.builder()- Parameters:
getExternalDataViewAccessDetailsRequest- AConsumerthat will call methods onGetExternalDataViewAccessDetailsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetExternalDataViewAccessDetails operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
-
getPermissionGroup
default CompletableFuture<GetPermissionGroupResponse> getPermissionGroup(GetPermissionGroupRequest getPermissionGroupRequest) Retrieves the details of a specific permission group.
- Parameters:
getPermissionGroupRequest-- Returns:
- A Java Future containing the result of the GetPermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getPermissionGroup
default CompletableFuture<GetPermissionGroupResponse> getPermissionGroup(Consumer<GetPermissionGroupRequest.Builder> getPermissionGroupRequest) Retrieves the details of a specific permission group.
This is a convenience which creates an instance of the
GetPermissionGroupRequest.Builderavoiding the need to create one manually viaGetPermissionGroupRequest.builder()- Parameters:
getPermissionGroupRequest- AConsumerthat will call methods onGetPermissionGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetPermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProgrammaticAccessCredentials
default CompletableFuture<GetProgrammaticAccessCredentialsResponse> getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest) Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.
- Parameters:
getProgrammaticAccessCredentialsRequest- Request for GetProgrammaticAccessCredentials operation- Returns:
- A Java Future containing the result of the GetProgrammaticAccessCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getProgrammaticAccessCredentials
default CompletableFuture<GetProgrammaticAccessCredentialsResponse> getProgrammaticAccessCredentials(Consumer<GetProgrammaticAccessCredentialsRequest.Builder> getProgrammaticAccessCredentialsRequest) Request programmatic credentials to use with FinSpace SDK. For more information, see Step 2. Access credentials programmatically using IAM access key id and secret access key.
This is a convenience which creates an instance of the
GetProgrammaticAccessCredentialsRequest.Builderavoiding the need to create one manually viaGetProgrammaticAccessCredentialsRequest.builder()- Parameters:
getProgrammaticAccessCredentialsRequest- AConsumerthat will call methods onGetProgrammaticAccessCredentialsRequest.Builderto create a request. Request for GetProgrammaticAccessCredentials operation- Returns:
- A Java Future containing the result of the GetProgrammaticAccessCredentials operation returned by the
service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getUser
Retrieves details for a specific user.
- Parameters:
getUserRequest-- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getUser
Retrieves details for a specific user.
This is a convenience which creates an instance of the
GetUserRequest.Builderavoiding the need to create one manually viaGetUserRequest.builder()- Parameters:
getUserRequest- AConsumerthat will call methods onGetUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkingLocation
default CompletableFuture<GetWorkingLocationResponse> getWorkingLocation(GetWorkingLocationRequest getWorkingLocationRequest) 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.
- Parameters:
getWorkingLocationRequest-- Returns:
- A Java Future containing the result of the GetWorkingLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
getWorkingLocation
default CompletableFuture<GetWorkingLocationResponse> getWorkingLocation(Consumer<GetWorkingLocationRequest.Builder> getWorkingLocationRequest) 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.
This is a convenience which creates an instance of the
GetWorkingLocationRequest.Builderavoiding the need to create one manually viaGetWorkingLocationRequest.builder()- Parameters:
getWorkingLocationRequest- AConsumerthat will call methods onGetWorkingLocationRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the GetWorkingLocation operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- AccessDeniedException You do not have sufficient access to perform this action.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChangesets
default CompletableFuture<ListChangesetsResponse> listChangesets(ListChangesetsRequest listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.
- Parameters:
listChangesetsRequest- Request to ListChangesetsRequest. It exposes minimal query filters.- Returns:
- A Java Future containing the result of the ListChangesets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChangesets
default CompletableFuture<ListChangesetsResponse> listChangesets(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.
This is a convenience which creates an instance of the
ListChangesetsRequest.Builderavoiding the need to create one manually viaListChangesetsRequest.builder()- Parameters:
listChangesetsRequest- AConsumerthat will call methods onListChangesetsRequest.Builderto create a request. Request to ListChangesetsRequest. It exposes minimal query filters.- Returns:
- A Java Future containing the result of the ListChangesets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChangesetsPaginator
default ListChangesetsPublisher listChangesetsPaginator(ListChangesetsRequest listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.
This is a variant of
listChangesets(software.amazon.awssdk.services.finspacedata.model.ListChangesetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListChangesetsPublisher publisher = client.listChangesetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListChangesetsPublisher publisher = client.listChangesetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListChangesetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListChangesetsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChangesets(software.amazon.awssdk.services.finspacedata.model.ListChangesetsRequest)operation.- Parameters:
listChangesetsRequest- Request to ListChangesetsRequest. It exposes minimal query filters.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listChangesetsPaginator
default ListChangesetsPublisher listChangesetsPaginator(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.
This is a variant of
listChangesets(software.amazon.awssdk.services.finspacedata.model.ListChangesetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListChangesetsPublisher publisher = client.listChangesetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListChangesetsPublisher publisher = client.listChangesetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListChangesetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListChangesetsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChangesets(software.amazon.awssdk.services.finspacedata.model.ListChangesetsRequest)operation.This is a convenience which creates an instance of the
ListChangesetsRequest.Builderavoiding the need to create one manually viaListChangesetsRequest.builder()- Parameters:
listChangesetsRequest- AConsumerthat will call methods onListChangesetsRequest.Builderto create a request. Request to ListChangesetsRequest. It exposes minimal query filters.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataViews
default CompletableFuture<ListDataViewsResponse> listDataViews(ListDataViewsRequest listDataViewsRequest) Lists all available Dataviews for a Dataset.
- Parameters:
listDataViewsRequest- Request for a list data views.- Returns:
- A Java Future containing the result of the ListDataViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataViews
default CompletableFuture<ListDataViewsResponse> listDataViews(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest) Lists all available Dataviews for a Dataset.
This is a convenience which creates an instance of the
ListDataViewsRequest.Builderavoiding the need to create one manually viaListDataViewsRequest.builder()- Parameters:
listDataViewsRequest- AConsumerthat will call methods onListDataViewsRequest.Builderto create a request. Request for a list data views.- Returns:
- A Java Future containing the result of the ListDataViews operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataViewsPaginator
Lists all available Dataviews for a Dataset.
This is a variant of
listDataViews(software.amazon.awssdk.services.finspacedata.model.ListDataViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListDataViewsPublisher publisher = client.listDataViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListDataViewsPublisher publisher = client.listDataViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListDataViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListDataViewsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataViews(software.amazon.awssdk.services.finspacedata.model.ListDataViewsRequest)operation.- Parameters:
listDataViewsRequest- Request for a list data views.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDataViewsPaginator
default ListDataViewsPublisher listDataViewsPaginator(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest) Lists all available Dataviews for a Dataset.
This is a variant of
listDataViews(software.amazon.awssdk.services.finspacedata.model.ListDataViewsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListDataViewsPublisher publisher = client.listDataViewsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListDataViewsPublisher publisher = client.listDataViewsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListDataViewsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListDataViewsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataViews(software.amazon.awssdk.services.finspacedata.model.ListDataViewsRequest)operation.This is a convenience which creates an instance of the
ListDataViewsRequest.Builderavoiding the need to create one manually viaListDataViewsRequest.builder()- Parameters:
listDataViewsRequest- AConsumerthat will call methods onListDataViewsRequest.Builderto create a request. Request for a list data views.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasets
default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest) Lists all of the active Datasets that a user has access to.
- Parameters:
listDatasetsRequest- Request for the ListDatasets operation.- Returns:
- A Java Future containing the result of the ListDatasets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasets
default CompletableFuture<ListDatasetsResponse> listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) Lists all of the active Datasets that a user has access to.
This is a convenience which creates an instance of the
ListDatasetsRequest.Builderavoiding the need to create one manually viaListDatasetsRequest.builder()- Parameters:
listDatasetsRequest- AConsumerthat will call methods onListDatasetsRequest.Builderto create a request. Request for the ListDatasets operation.- Returns:
- A Java Future containing the result of the ListDatasets operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetsPaginator
Lists all of the active Datasets that a user has access to.
This is a variant of
listDatasets(software.amazon.awssdk.services.finspacedata.model.ListDatasetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListDatasetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListDatasetsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.finspacedata.model.ListDatasetsRequest)operation.- Parameters:
listDatasetsRequest- Request for the ListDatasets operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listDatasetsPaginator
default ListDatasetsPublisher listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) Lists all of the active Datasets that a user has access to.
This is a variant of
listDatasets(software.amazon.awssdk.services.finspacedata.model.ListDatasetsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListDatasetsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListDatasetsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.finspacedata.model.ListDatasetsRequest)operation.This is a convenience which creates an instance of the
ListDatasetsRequest.Builderavoiding the need to create one manually viaListDatasetsRequest.builder()- Parameters:
listDatasetsRequest- AConsumerthat will call methods onListDatasetsRequest.Builderto create a request. Request for the ListDatasets operation.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ThrottlingException The request was denied due to request throttling.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionGroups
default CompletableFuture<ListPermissionGroupsResponse> listPermissionGroups(ListPermissionGroupsRequest listPermissionGroupsRequest) Lists all available permission groups in FinSpace.
- Parameters:
listPermissionGroupsRequest-- Returns:
- A Java Future containing the result of the ListPermissionGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionGroups
default CompletableFuture<ListPermissionGroupsResponse> listPermissionGroups(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest) Lists all available permission groups in FinSpace.
This is a convenience which creates an instance of the
ListPermissionGroupsRequest.Builderavoiding the need to create one manually viaListPermissionGroupsRequest.builder()- Parameters:
listPermissionGroupsRequest- AConsumerthat will call methods onListPermissionGroupsRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListPermissionGroups operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionGroupsByUser
default CompletableFuture<ListPermissionGroupsByUserResponse> listPermissionGroupsByUser(ListPermissionGroupsByUserRequest listPermissionGroupsByUserRequest) Lists all the permission groups that are associated with a specific user.
- Parameters:
listPermissionGroupsByUserRequest-- Returns:
- A Java Future containing the result of the ListPermissionGroupsByUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionGroupsByUser
default CompletableFuture<ListPermissionGroupsByUserResponse> listPermissionGroupsByUser(Consumer<ListPermissionGroupsByUserRequest.Builder> listPermissionGroupsByUserRequest) Lists all the permission groups that are associated with a specific user.
This is a convenience which creates an instance of the
ListPermissionGroupsByUserRequest.Builderavoiding the need to create one manually viaListPermissionGroupsByUserRequest.builder()- Parameters:
listPermissionGroupsByUserRequest- AConsumerthat will call methods onListPermissionGroupsByUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListPermissionGroupsByUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionGroupsPaginator
default ListPermissionGroupsPublisher listPermissionGroupsPaginator(ListPermissionGroupsRequest listPermissionGroupsRequest) Lists all available permission groups in FinSpace.
This is a variant of
listPermissionGroups(software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsPublisher publisher = client.listPermissionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsPublisher publisher = client.listPermissionGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionGroups(software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsRequest)operation.- Parameters:
listPermissionGroupsRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listPermissionGroupsPaginator
default ListPermissionGroupsPublisher listPermissionGroupsPaginator(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest) Lists all available permission groups in FinSpace.
This is a variant of
listPermissionGroups(software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsPublisher publisher = client.listPermissionGroupsPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsPublisher publisher = client.listPermissionGroupsPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionGroups(software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsRequest)operation.This is a convenience which creates an instance of the
ListPermissionGroupsRequest.Builderavoiding the need to create one manually viaListPermissionGroupsRequest.builder()- Parameters:
listPermissionGroupsRequest- AConsumerthat will call methods onListPermissionGroupsRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
Lists all available users in FinSpace.
- Parameters:
listUsersRequest-- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsers
default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists all available users in FinSpace.
This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListUsers operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersByPermissionGroup
default CompletableFuture<ListUsersByPermissionGroupResponse> listUsersByPermissionGroup(ListUsersByPermissionGroupRequest listUsersByPermissionGroupRequest) Lists details of all the users in a specific permission group.
- Parameters:
listUsersByPermissionGroupRequest-- Returns:
- A Java Future containing the result of the ListUsersByPermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersByPermissionGroup
default CompletableFuture<ListUsersByPermissionGroupResponse> listUsersByPermissionGroup(Consumer<ListUsersByPermissionGroupRequest.Builder> listUsersByPermissionGroupRequest) Lists details of all the users in a specific permission group.
This is a convenience which creates an instance of the
ListUsersByPermissionGroupRequest.Builderavoiding the need to create one manually viaListUsersByPermissionGroupRequest.builder()- Parameters:
listUsersByPermissionGroupRequest- AConsumerthat will call methods onListUsersByPermissionGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ListUsersByPermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
Lists all available users in FinSpace.
This is a variant of
listUsers(software.amazon.awssdk.services.finspacedata.model.ListUsersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListUsersResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.finspacedata.model.ListUsersRequest)operation.- Parameters:
listUsersRequest-- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
listUsersPaginator
Lists all available users in FinSpace.
This is a variant of
listUsers(software.amazon.awssdk.services.finspacedata.model.ListUsersRequest)operation. The return type is a custom publisher that can be subscribed to request a stream of response pages. SDK will internally handle making service calls for you.When the operation is called, an instance of this class is returned. At this point, no service calls are made yet and so there is no guarantee that the request is valid. If there are errors in your request, you will see the failures only after you start streaming the data. The subscribe method should be called as a request to start streaming data. For more info, see
Publisher.subscribe(org.reactivestreams.Subscriber). Each call to the subscribe method will result in a newSubscriptioni.e., a new contract to stream data from the starting request.The following are few ways to use the response class:
1) Using the subscribe helper method
2) Using a custom subscribersoftware.amazon.awssdk.services.finspacedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response }); future.get();
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.software.amazon.awssdk.services.finspacedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request); publisher.subscribe(new Subscriber<software.amazon.awssdk.services.finspacedata.model.ListUsersResponse>() { public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... }; public void onNext(software.amazon.awssdk.services.finspacedata.model.ListUsersResponse response) { //... }; });Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.finspacedata.model.ListUsersRequest)operation.This is a convenience which creates an instance of the
ListUsersRequest.Builderavoiding the need to create one manually viaListUsersRequest.builder()- Parameters:
listUsersRequest- AConsumerthat will call methods onListUsersRequest.Builderto create a request.- Returns:
- A custom publisher that can be subscribed to request a stream of response pages.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetUserPassword
default CompletableFuture<ResetUserPasswordResponse> resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest) 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.
- Parameters:
resetUserPasswordRequest-- Returns:
- A Java Future containing the result of the ResetUserPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
resetUserPassword
default CompletableFuture<ResetUserPasswordResponse> resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest) 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.
This is a convenience which creates an instance of the
ResetUserPasswordRequest.Builderavoiding the need to create one manually viaResetUserPasswordRequest.builder()- Parameters:
resetUserPasswordRequest- AConsumerthat will call methods onResetUserPasswordRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the ResetUserPassword operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChangeset
default CompletableFuture<UpdateChangesetResponse> updateChangeset(UpdateChangesetRequest updateChangesetRequest) Updates a FinSpace Changeset.
- Parameters:
updateChangesetRequest- Request to update an existing changeset.- Returns:
- A Java Future containing the result of the UpdateChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateChangeset
default CompletableFuture<UpdateChangesetResponse> updateChangeset(Consumer<UpdateChangesetRequest.Builder> updateChangesetRequest) Updates a FinSpace Changeset.
This is a convenience which creates an instance of the
UpdateChangesetRequest.Builderavoiding the need to create one manually viaUpdateChangesetRequest.builder()- Parameters:
updateChangesetRequest- AConsumerthat will call methods onUpdateChangesetRequest.Builderto create a request. Request to update an existing changeset.- Returns:
- A Java Future containing the result of the UpdateChangeset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- ResourceNotFoundException One or more resources can't be found.
- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataset
default CompletableFuture<UpdateDatasetResponse> updateDataset(UpdateDatasetRequest updateDatasetRequest) Updates a FinSpace Dataset.
- Parameters:
updateDatasetRequest- The request for an UpdateDataset operation- Returns:
- A Java Future containing the result of the UpdateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateDataset
default CompletableFuture<UpdateDatasetResponse> updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest) Updates a FinSpace Dataset.
This is a convenience which creates an instance of the
UpdateDatasetRequest.Builderavoiding the need to create one manually viaUpdateDatasetRequest.builder()- Parameters:
updateDatasetRequest- AConsumerthat will call methods onUpdateDatasetRequest.Builderto create a request. The request for an UpdateDataset operation- Returns:
- A Java Future containing the result of the UpdateDataset operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ConflictException The request conflicts with an existing resource.
- ResourceNotFoundException One or more resources can't be found.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePermissionGroup
default CompletableFuture<UpdatePermissionGroupResponse> updatePermissionGroup(UpdatePermissionGroupRequest updatePermissionGroupRequest) Modifies the details of a permission group. You cannot modify a
permissionGroupID.- Parameters:
updatePermissionGroupRequest-- Returns:
- A Java Future containing the result of the UpdatePermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updatePermissionGroup
default CompletableFuture<UpdatePermissionGroupResponse> updatePermissionGroup(Consumer<UpdatePermissionGroupRequest.Builder> updatePermissionGroupRequest) Modifies the details of a permission group. You cannot modify a
permissionGroupID.
This is a convenience which creates an instance of the
UpdatePermissionGroupRequest.Builderavoiding the need to create one manually viaUpdatePermissionGroupRequest.builder()- Parameters:
updatePermissionGroupRequest- AConsumerthat will call methods onUpdatePermissionGroupRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdatePermissionGroup operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
Modifies the details of the specified user. You cannot update the
userIdfor a user.- Parameters:
updateUserRequest-- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
updateUser
default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) Modifies the details of the specified user. You cannot update the
userIdfor a user.
This is a convenience which creates an instance of the
UpdateUserRequest.Builderavoiding the need to create one manually viaUpdateUserRequest.builder()- Parameters:
updateUserRequest- AConsumerthat will call methods onUpdateUserRequest.Builderto create a request.- Returns:
- A Java Future containing the result of the UpdateUser operation returned by the service.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.- InternalServerException The request processing has failed because of an unknown error, exception or failure.
- ValidationException The input fails to satisfy the constraints specified by an AWS service.
- ThrottlingException The request was denied due to request throttling.
- AccessDeniedException You do not have sufficient access to perform this action.
- ResourceNotFoundException One or more resources can't be found.
- ConflictException The request conflicts with an existing resource.
- SdkException Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for catch all scenarios.
- SdkClientException If any client side error occurs such as an IO related failure, failure to get credentials, etc.
- FinspaceDataException Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.
- See Also:
-
serviceClientConfiguration
Description copied from interface:SdkClientThe SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient- Returns:
- SdkServiceClientConfiguration
-
create
Create aFinspaceDataAsyncClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider. -
builder
Create a builder that can be used to configure and create aFinspaceDataAsyncClient.
-