Interface FinspaceDataClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
builder()
method.
The FinSpace APIs let you take actions inside the FinSpace.
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
Value 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.static FinspaceDataClientBuilder
builder()
Create a builder that can be used to configure and create aFinspaceDataClient
.static FinspaceDataClient
create()
Create aFinspaceDataClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.default CreateChangesetResponse
createChangeset
(Consumer<CreateChangesetRequest.Builder> createChangesetRequest) Creates a new Changeset in a FinSpace Dataset.default CreateChangesetResponse
createChangeset
(CreateChangesetRequest createChangesetRequest) Creates a new Changeset in a FinSpace Dataset.default CreateDatasetResponse
createDataset
(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) Creates a new FinSpace Dataset.default CreateDatasetResponse
createDataset
(CreateDatasetRequest createDatasetRequest) Creates a new FinSpace Dataset.default CreateDataViewResponse
createDataView
(Consumer<CreateDataViewRequest.Builder> createDataViewRequest) Creates a Dataview for a Dataset.default CreateDataViewResponse
createDataView
(CreateDataViewRequest createDataViewRequest) Creates a Dataview for a Dataset.default CreatePermissionGroupResponse
createPermissionGroup
(Consumer<CreatePermissionGroupRequest.Builder> createPermissionGroupRequest) Creates a group of permissions for various actions that a user can perform in FinSpace.default CreatePermissionGroupResponse
createPermissionGroup
(CreatePermissionGroupRequest createPermissionGroupRequest) Creates a group of permissions for various actions that a user can perform in FinSpace.default CreateUserResponse
createUser
(Consumer<CreateUserRequest.Builder> createUserRequest) Creates a new user in FinSpace.default CreateUserResponse
createUser
(CreateUserRequest createUserRequest) Creates a new user in FinSpace.default DeleteDatasetResponse
deleteDataset
(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) Deletes a FinSpace Dataset.default DeleteDatasetResponse
deleteDataset
(DeleteDatasetRequest deleteDatasetRequest) Deletes a FinSpace Dataset.default DeletePermissionGroupResponse
deletePermissionGroup
(Consumer<DeletePermissionGroupRequest.Builder> deletePermissionGroupRequest) Deletes a permission group.default DeletePermissionGroupResponse
deletePermissionGroup
(DeletePermissionGroupRequest deletePermissionGroupRequest) Deletes a permission group.default DisableUserResponse
disableUser
(Consumer<DisableUserRequest.Builder> disableUserRequest) Denies access to the FinSpace web application and API for the specified user.default 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 EnableUserResponse
enableUser
(Consumer<EnableUserRequest.Builder> enableUserRequest) Allows the specified user to access the FinSpace web application and API.default EnableUserResponse
enableUser
(EnableUserRequest enableUserRequest) Allows the specified user to access the FinSpace web application and API.default GetChangesetResponse
getChangeset
(Consumer<GetChangesetRequest.Builder> getChangesetRequest) Get information about a Changeset.default GetChangesetResponse
getChangeset
(GetChangesetRequest getChangesetRequest) Get information about a Changeset.default GetDatasetResponse
getDataset
(Consumer<GetDatasetRequest.Builder> getDatasetRequest) Returns information about a Dataset.default GetDatasetResponse
getDataset
(GetDatasetRequest getDatasetRequest) Returns information about a Dataset.default GetDataViewResponse
getDataView
(Consumer<GetDataViewRequest.Builder> getDataViewRequest) Gets information about a Dataview.default 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.default GetPermissionGroupResponse
getPermissionGroup
(Consumer<GetPermissionGroupRequest.Builder> getPermissionGroupRequest) Retrieves the details of a specific permission group.default GetPermissionGroupResponse
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 GetUserResponse
getUser
(Consumer<GetUserRequest.Builder> getUserRequest) Retrieves details for a specific user.default GetUserResponse
getUser
(GetUserRequest getUserRequest) Retrieves details for a specific user.default 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.default 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.default ListChangesetsResponse
listChangesets
(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.default ListChangesetsResponse
listChangesets
(ListChangesetsRequest listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.default ListChangesetsIterable
listChangesetsPaginator
(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.default ListChangesetsIterable
listChangesetsPaginator
(ListChangesetsRequest listChangesetsRequest) Lists the FinSpace Changesets for a Dataset.default ListDatasetsResponse
listDatasets
(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) Lists all of the active Datasets that a user has access to.default ListDatasetsResponse
listDatasets
(ListDatasetsRequest listDatasetsRequest) Lists all of the active Datasets that a user has access to.default ListDatasetsIterable
listDatasetsPaginator
(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) Lists all of the active Datasets that a user has access to.default ListDatasetsIterable
listDatasetsPaginator
(ListDatasetsRequest listDatasetsRequest) Lists all of the active Datasets that a user has access to.default ListDataViewsResponse
listDataViews
(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest) Lists all available Dataviews for a Dataset.default ListDataViewsResponse
listDataViews
(ListDataViewsRequest listDataViewsRequest) Lists all available Dataviews for a Dataset.default ListDataViewsIterable
listDataViewsPaginator
(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest) Lists all available Dataviews for a Dataset.default ListDataViewsIterable
listDataViewsPaginator
(ListDataViewsRequest listDataViewsRequest) Lists all available Dataviews for a Dataset.default ListPermissionGroupsResponse
listPermissionGroups
(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest) Lists all available permission groups in FinSpace.default ListPermissionGroupsResponse
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 ListPermissionGroupsIterable
listPermissionGroupsPaginator
(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest) Lists all available permission groups in FinSpace.default ListPermissionGroupsIterable
listPermissionGroupsPaginator
(ListPermissionGroupsRequest listPermissionGroupsRequest) Lists all available permission groups in FinSpace.default ListUsersResponse
listUsers
(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists all available users in FinSpace.default 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 ListUsersIterable
listUsersPaginator
(Consumer<ListUsersRequest.Builder> listUsersRequest) Lists all available users in FinSpace.default ListUsersIterable
listUsersPaginator
(ListUsersRequest listUsersRequest) Lists all available users in FinSpace.default ResetUserPasswordResponse
resetUserPassword
(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest) Resets the password for a specified user ID and generates a temporary one.default ResetUserPasswordResponse
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., ClientOverrideConfigurationstatic ServiceMetadata
default UpdateChangesetResponse
updateChangeset
(Consumer<UpdateChangesetRequest.Builder> updateChangesetRequest) Updates a FinSpace Changeset.default UpdateChangesetResponse
updateChangeset
(UpdateChangesetRequest updateChangesetRequest) Updates a FinSpace Changeset.default UpdateDatasetResponse
updateDataset
(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest) Updates a FinSpace Dataset.default UpdateDatasetResponse
updateDataset
(UpdateDatasetRequest updateDatasetRequest) Updates a FinSpace Dataset.default UpdatePermissionGroupResponse
updatePermissionGroup
(Consumer<UpdatePermissionGroupRequest.Builder> updatePermissionGroupRequest) Modifies the details of a permission group.default UpdatePermissionGroupResponse
updatePermissionGroup
(UpdatePermissionGroupRequest updatePermissionGroupRequest) Modifies the details of a permission group.default UpdateUserResponse
updateUser
(Consumer<UpdateUserRequest.Builder> updateUserRequest) Modifies the details of the specified user.default UpdateUserResponse
updateUser
(UpdateUserRequest updateUserRequest) Modifies the details of the specified user.Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
Field Details
-
SERVICE_NAME
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
Method Details
-
associateUserToPermissionGroup
default AssociateUserToPermissionGroupResponse associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest associateUserToPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Adds a user to a permission group to grant permissions for actions a user can perform in FinSpace.
- Parameters:
associateUserToPermissionGroupRequest
-- Returns:
- Result of the AssociateUserToPermissionGroup operation returned by the service.
- See Also:
-
associateUserToPermissionGroup
default AssociateUserToPermissionGroupResponse associateUserToPermissionGroup(Consumer<AssociateUserToPermissionGroupRequest.Builder> associateUserToPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException 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.Builder
avoiding the need to create one manually viaAssociateUserToPermissionGroupRequest.builder()
- Parameters:
associateUserToPermissionGroupRequest
- AConsumer
that will call methods onAssociateUserToPermissionGroupRequest.Builder
to create a request.- Returns:
- Result of the AssociateUserToPermissionGroup operation returned by the service.
- See Also:
-
createChangeset
default CreateChangesetResponse createChangeset(CreateChangesetRequest createChangesetRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Creates a new Changeset in a FinSpace Dataset.
- Parameters:
createChangesetRequest
- The request for a CreateChangeset operation.- Returns:
- Result of the CreateChangeset operation returned by the service.
- See Also:
-
createChangeset
default CreateChangesetResponse createChangeset(Consumer<CreateChangesetRequest.Builder> createChangesetRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Creates a new Changeset in a FinSpace Dataset.
This is a convenience which creates an instance of the
CreateChangesetRequest.Builder
avoiding the need to create one manually viaCreateChangesetRequest.builder()
- Parameters:
createChangesetRequest
- AConsumer
that will call methods onCreateChangesetRequest.Builder
to create a request. The request for a CreateChangeset operation.- Returns:
- Result of the CreateChangeset operation returned by the service.
- See Also:
-
createDataView
default CreateDataViewResponse createDataView(CreateDataViewRequest createDataViewRequest) throws InternalServerException, ThrottlingException, ValidationException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Creates a Dataview for a Dataset.
- Parameters:
createDataViewRequest
- Request for creating a data view.- Returns:
- Result of the CreateDataView operation returned by the service.
- See Also:
-
createDataView
default CreateDataViewResponse createDataView(Consumer<CreateDataViewRequest.Builder> createDataViewRequest) throws InternalServerException, ThrottlingException, ValidationException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Creates a Dataview for a Dataset.
This is a convenience which creates an instance of the
CreateDataViewRequest.Builder
avoiding the need to create one manually viaCreateDataViewRequest.builder()
- Parameters:
createDataViewRequest
- AConsumer
that will call methods onCreateDataViewRequest.Builder
to create a request. Request for creating a data view.- Returns:
- Result of the CreateDataView operation returned by the service.
- See Also:
-
createDataset
default CreateDatasetResponse createDataset(CreateDatasetRequest createDatasetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Creates a new FinSpace Dataset.
- Parameters:
createDatasetRequest
- The request for a CreateDataset operation- Returns:
- Result of the CreateDataset operation returned by the service.
- See Also:
-
createDataset
default CreateDatasetResponse createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Creates a new FinSpace Dataset.
This is a convenience which creates an instance of the
CreateDatasetRequest.Builder
avoiding the need to create one manually viaCreateDatasetRequest.builder()
- Parameters:
createDatasetRequest
- AConsumer
that will call methods onCreateDatasetRequest.Builder
to create a request. The request for a CreateDataset operation- Returns:
- Result of the CreateDataset operation returned by the service.
- See Also:
-
createPermissionGroup
default CreatePermissionGroupResponse createPermissionGroup(CreatePermissionGroupRequest createPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Creates a group of permissions for various actions that a user can perform in FinSpace.
- Parameters:
createPermissionGroupRequest
-- Returns:
- Result of the CreatePermissionGroup operation returned by the service.
- See Also:
-
createPermissionGroup
default CreatePermissionGroupResponse createPermissionGroup(Consumer<CreatePermissionGroupRequest.Builder> createPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException 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.Builder
avoiding the need to create one manually viaCreatePermissionGroupRequest.builder()
- Parameters:
createPermissionGroupRequest
- AConsumer
that will call methods onCreatePermissionGroupRequest.Builder
to create a request.- Returns:
- Result of the CreatePermissionGroup operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(CreateUserRequest createUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Creates a new user in FinSpace.
- Parameters:
createUserRequest
-- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
createUser
default CreateUserResponse createUser(Consumer<CreateUserRequest.Builder> createUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Creates a new user in FinSpace.
This is a convenience which creates an instance of the
CreateUserRequest.Builder
avoiding the need to create one manually viaCreateUserRequest.builder()
- Parameters:
createUserRequest
- AConsumer
that will call methods onCreateUserRequest.Builder
to create a request.- Returns:
- Result of the CreateUser operation returned by the service.
- See Also:
-
deleteDataset
default DeleteDatasetResponse deleteDataset(DeleteDatasetRequest deleteDatasetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Deletes a FinSpace Dataset.
- Parameters:
deleteDatasetRequest
- The request for a DeleteDataset operation.- Returns:
- Result of the DeleteDataset operation returned by the service.
- See Also:
-
deleteDataset
default DeleteDatasetResponse deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Deletes a FinSpace Dataset.
This is a convenience which creates an instance of the
DeleteDatasetRequest.Builder
avoiding the need to create one manually viaDeleteDatasetRequest.builder()
- Parameters:
deleteDatasetRequest
- AConsumer
that will call methods onDeleteDatasetRequest.Builder
to create a request. The request for a DeleteDataset operation.- Returns:
- Result of the DeleteDataset operation returned by the service.
- See Also:
-
deletePermissionGroup
default DeletePermissionGroupResponse deletePermissionGroup(DeletePermissionGroupRequest deletePermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Deletes a permission group. This action is irreversible.
- Parameters:
deletePermissionGroupRequest
-- Returns:
- Result of the DeletePermissionGroup operation returned by the service.
- See Also:
-
deletePermissionGroup
default DeletePermissionGroupResponse deletePermissionGroup(Consumer<DeletePermissionGroupRequest.Builder> deletePermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Deletes a permission group. This action is irreversible.
This is a convenience which creates an instance of the
DeletePermissionGroupRequest.Builder
avoiding the need to create one manually viaDeletePermissionGroupRequest.builder()
- Parameters:
deletePermissionGroupRequest
- AConsumer
that will call methods onDeletePermissionGroupRequest.Builder
to create a request.- Returns:
- Result of the DeletePermissionGroup operation returned by the service.
- See Also:
-
disableUser
default DisableUserResponse disableUser(DisableUserRequest disableUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Denies access to the FinSpace web application and API for the specified user.
- Parameters:
disableUserRequest
-- Returns:
- Result of the DisableUser operation returned by the service.
- See Also:
-
disableUser
default DisableUserResponse disableUser(Consumer<DisableUserRequest.Builder> disableUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Denies access to the FinSpace web application and API for the specified user.
This is a convenience which creates an instance of the
DisableUserRequest.Builder
avoiding the need to create one manually viaDisableUserRequest.builder()
- Parameters:
disableUserRequest
- AConsumer
that will call methods onDisableUserRequest.Builder
to create a request.- Returns:
- Result of the DisableUser operation returned by the service.
- See Also:
-
disassociateUserFromPermissionGroup
default DisassociateUserFromPermissionGroupResponse disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest disassociateUserFromPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Removes a user from a permission group.
- Parameters:
disassociateUserFromPermissionGroupRequest
-- Returns:
- Result of the DisassociateUserFromPermissionGroup operation returned by the service.
- See Also:
-
disassociateUserFromPermissionGroup
default DisassociateUserFromPermissionGroupResponse disassociateUserFromPermissionGroup(Consumer<DisassociateUserFromPermissionGroupRequest.Builder> disassociateUserFromPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Removes a user from a permission group.
This is a convenience which creates an instance of the
DisassociateUserFromPermissionGroupRequest.Builder
avoiding the need to create one manually viaDisassociateUserFromPermissionGroupRequest.builder()
- Parameters:
disassociateUserFromPermissionGroupRequest
- AConsumer
that will call methods onDisassociateUserFromPermissionGroupRequest.Builder
to create a request.- Returns:
- Result of the DisassociateUserFromPermissionGroup operation returned by the service.
- See Also:
-
enableUser
default EnableUserResponse enableUser(EnableUserRequest enableUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Allows the specified user to access the FinSpace web application and API.
- Parameters:
enableUserRequest
-- Returns:
- Result of the EnableUser operation returned by the service.
- See Also:
-
enableUser
default EnableUserResponse enableUser(Consumer<EnableUserRequest.Builder> enableUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, LimitExceededException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Allows the specified user to access the FinSpace web application and API.
This is a convenience which creates an instance of the
EnableUserRequest.Builder
avoiding the need to create one manually viaEnableUserRequest.builder()
- Parameters:
enableUserRequest
- AConsumer
that will call methods onEnableUserRequest.Builder
to create a request.- Returns:
- Result of the EnableUser operation returned by the service.
- See Also:
-
getChangeset
default GetChangesetResponse getChangeset(GetChangesetRequest getChangesetRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Get information about a Changeset.
- Parameters:
getChangesetRequest
- Request to describe a changeset.- Returns:
- Result of the GetChangeset operation returned by the service.
- See Also:
-
getChangeset
default GetChangesetResponse getChangeset(Consumer<GetChangesetRequest.Builder> getChangesetRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Get information about a Changeset.
This is a convenience which creates an instance of the
GetChangesetRequest.Builder
avoiding the need to create one manually viaGetChangesetRequest.builder()
- Parameters:
getChangesetRequest
- AConsumer
that will call methods onGetChangesetRequest.Builder
to create a request. Request to describe a changeset.- Returns:
- Result of the GetChangeset operation returned by the service.
- See Also:
-
getDataView
default GetDataViewResponse getDataView(GetDataViewRequest getDataViewRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Gets information about a Dataview.
- Parameters:
getDataViewRequest
- Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.- Returns:
- Result of the GetDataView operation returned by the service.
- See Also:
-
getDataView
default GetDataViewResponse getDataView(Consumer<GetDataViewRequest.Builder> getDataViewRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Gets information about a Dataview.
This is a convenience which creates an instance of the
GetDataViewRequest.Builder
avoiding the need to create one manually viaGetDataViewRequest.builder()
- Parameters:
getDataViewRequest
- AConsumer
that will call methods onGetDataViewRequest.Builder
to create a request. Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.- Returns:
- Result of the GetDataView operation returned by the service.
- See Also:
-
getDataset
default GetDatasetResponse getDataset(GetDatasetRequest getDatasetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Returns information about a Dataset.
- Parameters:
getDatasetRequest
- Request for the GetDataset operation.- Returns:
- Result of the GetDataset operation returned by the service.
- See Also:
-
getDataset
default GetDatasetResponse getDataset(Consumer<GetDatasetRequest.Builder> getDatasetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Returns information about a Dataset.
This is a convenience which creates an instance of the
GetDatasetRequest.Builder
avoiding the need to create one manually viaGetDatasetRequest.builder()
- Parameters:
getDatasetRequest
- AConsumer
that will call methods onGetDatasetRequest.Builder
to create a request. Request for the GetDataset operation.- Returns:
- Result of the GetDataset operation returned by the service.
- See Also:
-
getExternalDataViewAccessDetails
default GetExternalDataViewAccessDetailsResponse getExternalDataViewAccessDetails(GetExternalDataViewAccessDetailsRequest getExternalDataViewAccessDetailsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException 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 Data
permissions.
- Parameters:
getExternalDataViewAccessDetailsRequest
-- Returns:
- Result of the GetExternalDataViewAccessDetails operation returned by the service.
- See Also:
-
-
getExternalDataViewAccessDetails
default GetExternalDataViewAccessDetailsResponse getExternalDataViewAccessDetails(Consumer<GetExternalDataViewAccessDetailsRequest.Builder> getExternalDataViewAccessDetailsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException 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 Data
permissions.
This is a convenience which creates an instance of the
GetExternalDataViewAccessDetailsRequest.Builder
avoiding the need to create one manually viaGetExternalDataViewAccessDetailsRequest.builder()
- Parameters:
getExternalDataViewAccessDetailsRequest
- AConsumer
that will call methods onGetExternalDataViewAccessDetailsRequest.Builder
to create a request.- Returns:
- Result of the GetExternalDataViewAccessDetails operation returned by the service.
- See Also:
-
-
getPermissionGroup
default GetPermissionGroupResponse getPermissionGroup(GetPermissionGroupRequest getPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Retrieves the details of a specific permission group.
- Parameters:
getPermissionGroupRequest
-- Returns:
- Result of the GetPermissionGroup operation returned by the service.
- See Also:
-
getPermissionGroup
default GetPermissionGroupResponse getPermissionGroup(Consumer<GetPermissionGroupRequest.Builder> getPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Retrieves the details of a specific permission group.
This is a convenience which creates an instance of the
GetPermissionGroupRequest.Builder
avoiding the need to create one manually viaGetPermissionGroupRequest.builder()
- Parameters:
getPermissionGroupRequest
- AConsumer
that will call methods onGetPermissionGroupRequest.Builder
to create a request.- Returns:
- Result of the GetPermissionGroup operation returned by the service.
- See Also:
-
getProgrammaticAccessCredentials
default GetProgrammaticAccessCredentialsResponse getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException 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:
- Result of the GetProgrammaticAccessCredentials operation returned by the service.
- See Also:
-
getProgrammaticAccessCredentials
default GetProgrammaticAccessCredentialsResponse getProgrammaticAccessCredentials(Consumer<GetProgrammaticAccessCredentialsRequest.Builder> getProgrammaticAccessCredentialsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException 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.Builder
avoiding the need to create one manually viaGetProgrammaticAccessCredentialsRequest.builder()
- Parameters:
getProgrammaticAccessCredentialsRequest
- AConsumer
that will call methods onGetProgrammaticAccessCredentialsRequest.Builder
to create a request. Request for GetProgrammaticAccessCredentials operation- Returns:
- Result of the GetProgrammaticAccessCredentials operation returned by the service.
- See Also:
-
getUser
default GetUserResponse getUser(GetUserRequest getUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Retrieves details for a specific user.
- Parameters:
getUserRequest
-- Returns:
- Result of the GetUser operation returned by the service.
- See Also:
-
getUser
default GetUserResponse getUser(Consumer<GetUserRequest.Builder> getUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Retrieves details for a specific user.
This is a convenience which creates an instance of the
GetUserRequest.Builder
avoiding the need to create one manually viaGetUserRequest.builder()
- Parameters:
getUserRequest
- AConsumer
that will call methods onGetUserRequest.Builder
to create a request.- Returns:
- Result of the GetUser operation returned by the service.
- See Also:
-
getWorkingLocation
default GetWorkingLocationResponse getWorkingLocation(GetWorkingLocationRequest getWorkingLocationRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, FinspaceDataException 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:
- Result of the GetWorkingLocation operation returned by the service.
- See Also:
-
getWorkingLocation
default GetWorkingLocationResponse getWorkingLocation(Consumer<GetWorkingLocationRequest.Builder> getWorkingLocationRequest) throws InternalServerException, AccessDeniedException, ThrottlingException, ValidationException, AwsServiceException, SdkClientException, FinspaceDataException 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.Builder
avoiding the need to create one manually viaGetWorkingLocationRequest.builder()
- Parameters:
getWorkingLocationRequest
- AConsumer
that will call methods onGetWorkingLocationRequest.Builder
to create a request.- Returns:
- Result of the GetWorkingLocation operation returned by the service.
- See Also:
-
listChangesets
default ListChangesetsResponse listChangesets(ListChangesetsRequest listChangesetsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Lists the FinSpace Changesets for a Dataset.
- Parameters:
listChangesetsRequest
- Request to ListChangesetsRequest. It exposes minimal query filters.- Returns:
- Result of the ListChangesets operation returned by the service.
- See Also:
-
listChangesets
default ListChangesetsResponse listChangesets(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Lists the FinSpace Changesets for a Dataset.
This is a convenience which creates an instance of the
ListChangesetsRequest.Builder
avoiding the need to create one manually viaListChangesetsRequest.builder()
- Parameters:
listChangesetsRequest
- AConsumer
that will call methods onListChangesetsRequest.Builder
to create a request. Request to ListChangesetsRequest. It exposes minimal query filters.- Returns:
- Result of the ListChangesets operation returned by the service.
- See Also:
-
listChangesetsPaginator
default ListChangesetsIterable listChangesetsPaginator(ListChangesetsRequest listChangesetsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListChangesetsIterable responses = client.listChangesetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListChangesetsIterable responses = client .listChangesetsPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListChangesetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListChangesetsIterable responses = client.listChangesetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChangesets(software.amazon.awssdk.services.finspacedata.model.ListChangesetsRequest)
operation.- Parameters:
listChangesetsRequest
- Request to ListChangesetsRequest. It exposes minimal query filters.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listChangesetsPaginator
default ListChangesetsIterable listChangesetsPaginator(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListChangesetsIterable responses = client.listChangesetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListChangesetsIterable responses = client .listChangesetsPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListChangesetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListChangesetsIterable responses = client.listChangesetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChangesets(software.amazon.awssdk.services.finspacedata.model.ListChangesetsRequest)
operation.This is a convenience which creates an instance of the
ListChangesetsRequest.Builder
avoiding the need to create one manually viaListChangesetsRequest.builder()
- Parameters:
listChangesetsRequest
- AConsumer
that will call methods onListChangesetsRequest.Builder
to create a request. Request to ListChangesetsRequest. It exposes minimal query filters.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataViews
default ListDataViewsResponse listDataViews(ListDataViewsRequest listDataViewsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Lists all available Dataviews for a Dataset.
- Parameters:
listDataViewsRequest
- Request for a list data views.- Returns:
- Result of the ListDataViews operation returned by the service.
- See Also:
-
listDataViews
default ListDataViewsResponse listDataViews(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Lists all available Dataviews for a Dataset.
This is a convenience which creates an instance of the
ListDataViewsRequest.Builder
avoiding the need to create one manually viaListDataViewsRequest.builder()
- Parameters:
listDataViewsRequest
- AConsumer
that will call methods onListDataViewsRequest.Builder
to create a request. Request for a list data views.- Returns:
- Result of the ListDataViews operation returned by the service.
- See Also:
-
listDataViewsPaginator
default ListDataViewsIterable listDataViewsPaginator(ListDataViewsRequest listDataViewsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListDataViewsIterable responses = client.listDataViewsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListDataViewsIterable responses = client .listDataViewsPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListDataViewsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListDataViewsIterable responses = client.listDataViewsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataViews(software.amazon.awssdk.services.finspacedata.model.ListDataViewsRequest)
operation.- Parameters:
listDataViewsRequest
- Request for a list data views.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDataViewsPaginator
default ListDataViewsIterable listDataViewsPaginator(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest) throws ResourceNotFoundException, InternalServerException, ThrottlingException, ValidationException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListDataViewsIterable responses = client.listDataViewsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListDataViewsIterable responses = client .listDataViewsPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListDataViewsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListDataViewsIterable responses = client.listDataViewsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDataViews(software.amazon.awssdk.services.finspacedata.model.ListDataViewsRequest)
operation.This is a convenience which creates an instance of the
ListDataViewsRequest.Builder
avoiding the need to create one manually viaListDataViewsRequest.builder()
- Parameters:
listDataViewsRequest
- AConsumer
that will call methods onListDataViewsRequest.Builder
to create a request. Request for a list data views.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasets
default ListDatasetsResponse listDatasets(ListDatasetsRequest listDatasetsRequest) throws InternalServerException, ThrottlingException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Lists all of the active Datasets that a user has access to.
- Parameters:
listDatasetsRequest
- Request for the ListDatasets operation.- Returns:
- Result of the ListDatasets operation returned by the service.
- See Also:
-
listDatasets
default ListDatasetsResponse listDatasets(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InternalServerException, ThrottlingException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Lists all of the active Datasets that a user has access to.
This is a convenience which creates an instance of the
ListDatasetsRequest.Builder
avoiding the need to create one manually viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request. Request for the ListDatasets operation.- Returns:
- Result of the ListDatasets operation returned by the service.
- See Also:
-
listDatasetsPaginator
default ListDatasetsIterable listDatasetsPaginator(ListDatasetsRequest listDatasetsRequest) throws InternalServerException, ThrottlingException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListDatasetsIterable responses = client .listDatasetsPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListDatasetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.finspacedata.model.ListDatasetsRequest)
operation.- Parameters:
listDatasetsRequest
- Request for the ListDatasets operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listDatasetsPaginator
default ListDatasetsIterable listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest) throws InternalServerException, ThrottlingException, ValidationException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListDatasetsIterable responses = client .listDatasetsPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListDatasetsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListDatasetsIterable responses = client.listDatasetsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listDatasets(software.amazon.awssdk.services.finspacedata.model.ListDatasetsRequest)
operation.This is a convenience which creates an instance of the
ListDatasetsRequest.Builder
avoiding the need to create one manually viaListDatasetsRequest.builder()
- Parameters:
listDatasetsRequest
- AConsumer
that will call methods onListDatasetsRequest.Builder
to create a request. Request for the ListDatasets operation.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionGroups
default ListPermissionGroupsResponse listPermissionGroups(ListPermissionGroupsRequest listPermissionGroupsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException Lists all available permission groups in FinSpace.
- Parameters:
listPermissionGroupsRequest
-- Returns:
- Result of the ListPermissionGroups operation returned by the service.
- See Also:
-
listPermissionGroups
default ListPermissionGroupsResponse listPermissionGroups(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException Lists all available permission groups in FinSpace.
This is a convenience which creates an instance of the
ListPermissionGroupsRequest.Builder
avoiding the need to create one manually viaListPermissionGroupsRequest.builder()
- Parameters:
listPermissionGroupsRequest
- AConsumer
that will call methods onListPermissionGroupsRequest.Builder
to create a request.- Returns:
- Result of the ListPermissionGroups operation returned by the service.
- See Also:
-
listPermissionGroupsPaginator
default ListPermissionGroupsIterable listPermissionGroupsPaginator(ListPermissionGroupsRequest listPermissionGroupsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsIterable responses = client.listPermissionGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsIterable responses = client .listPermissionGroupsPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsIterable responses = client.listPermissionGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionGroups(software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsRequest)
operation.- Parameters:
listPermissionGroupsRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionGroupsPaginator
default ListPermissionGroupsIterable listPermissionGroupsPaginator(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsIterable responses = client.listPermissionGroupsPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsIterable responses = client .listPermissionGroupsPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsIterable responses = client.listPermissionGroupsPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listPermissionGroups(software.amazon.awssdk.services.finspacedata.model.ListPermissionGroupsRequest)
operation.This is a convenience which creates an instance of the
ListPermissionGroupsRequest.Builder
avoiding the need to create one manually viaListPermissionGroupsRequest.builder()
- Parameters:
listPermissionGroupsRequest
- AConsumer
that will call methods onListPermissionGroupsRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listPermissionGroupsByUser
default ListPermissionGroupsByUserResponse listPermissionGroupsByUser(ListPermissionGroupsByUserRequest listPermissionGroupsByUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Lists all the permission groups that are associated with a specific user.
- Parameters:
listPermissionGroupsByUserRequest
-- Returns:
- Result of the ListPermissionGroupsByUser operation returned by the service.
- See Also:
-
listPermissionGroupsByUser
default ListPermissionGroupsByUserResponse listPermissionGroupsByUser(Consumer<ListPermissionGroupsByUserRequest.Builder> listPermissionGroupsByUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Lists all the permission groups that are associated with a specific user.
This is a convenience which creates an instance of the
ListPermissionGroupsByUserRequest.Builder
avoiding the need to create one manually viaListPermissionGroupsByUserRequest.builder()
- Parameters:
listPermissionGroupsByUserRequest
- AConsumer
that will call methods onListPermissionGroupsByUserRequest.Builder
to create a request.- Returns:
- Result of the ListPermissionGroupsByUser operation returned by the service.
- See Also:
-
listUsers
default ListUsersResponse listUsers(ListUsersRequest listUsersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException Lists all available users in FinSpace.
- Parameters:
listUsersRequest
-- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsers
default ListUsersResponse listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException Lists all available users in FinSpace.
This is a convenience which creates an instance of the
ListUsersRequest.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- Result of the ListUsers operation returned by the service.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(ListUsersRequest listUsersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.finspacedata.model.ListUsersRequest)
operation.- Parameters:
listUsersRequest
-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUsersPaginator
default ListUsersIterable listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, FinspaceDataException 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 iterable that can be used to iterate through all the pages. SDK will internally handle making service calls for you.When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Streamsoftware.amazon.awssdk.services.finspacedata.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.stream().forEach(....);
{ @code software.amazon.awssdk.services.finspacedata.paginators.ListUsersIterable responses = client.listUsersPaginator(request); for (software.amazon.awssdk.services.finspacedata.model.ListUsersResponse response : responses) { // do something; } }
3) Use iterator directlysoftware.amazon.awssdk.services.finspacedata.paginators.ListUsersIterable responses = client.listUsersPaginator(request); responses.iterator().forEachRemaining(....);
Please notice that the configuration of maxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listUsers(software.amazon.awssdk.services.finspacedata.model.ListUsersRequest)
operation.This is a convenience which creates an instance of the
ListUsersRequest.Builder
avoiding the need to create one manually viaListUsersRequest.builder()
- Parameters:
listUsersRequest
- AConsumer
that will call methods onListUsersRequest.Builder
to create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- See Also:
-
listUsersByPermissionGroup
default ListUsersByPermissionGroupResponse listUsersByPermissionGroup(ListUsersByPermissionGroupRequest listUsersByPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Lists details of all the users in a specific permission group.
- Parameters:
listUsersByPermissionGroupRequest
-- Returns:
- Result of the ListUsersByPermissionGroup operation returned by the service.
- See Also:
-
listUsersByPermissionGroup
default ListUsersByPermissionGroupResponse listUsersByPermissionGroup(Consumer<ListUsersByPermissionGroupRequest.Builder> listUsersByPermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Lists details of all the users in a specific permission group.
This is a convenience which creates an instance of the
ListUsersByPermissionGroupRequest.Builder
avoiding the need to create one manually viaListUsersByPermissionGroupRequest.builder()
- Parameters:
listUsersByPermissionGroupRequest
- AConsumer
that will call methods onListUsersByPermissionGroupRequest.Builder
to create a request.- Returns:
- Result of the ListUsersByPermissionGroup operation returned by the service.
- See Also:
-
resetUserPassword
default ResetUserPasswordResponse resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException 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:
- Result of the ResetUserPassword operation returned by the service.
- See Also:
-
resetUserPassword
default ResetUserPasswordResponse resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException 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.Builder
avoiding the need to create one manually viaResetUserPasswordRequest.builder()
- Parameters:
resetUserPasswordRequest
- AConsumer
that will call methods onResetUserPasswordRequest.Builder
to create a request.- Returns:
- Result of the ResetUserPassword operation returned by the service.
- See Also:
-
updateChangeset
default UpdateChangesetResponse updateChangeset(UpdateChangesetRequest updateChangesetRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Updates a FinSpace Changeset.
- Parameters:
updateChangesetRequest
- Request to update an existing changeset.- Returns:
- Result of the UpdateChangeset operation returned by the service.
- See Also:
-
updateChangeset
default UpdateChangesetResponse updateChangeset(Consumer<UpdateChangesetRequest.Builder> updateChangesetRequest) throws ResourceNotFoundException, InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Updates a FinSpace Changeset.
This is a convenience which creates an instance of the
UpdateChangesetRequest.Builder
avoiding the need to create one manually viaUpdateChangesetRequest.builder()
- Parameters:
updateChangesetRequest
- AConsumer
that will call methods onUpdateChangesetRequest.Builder
to create a request. Request to update an existing changeset.- Returns:
- Result of the UpdateChangeset operation returned by the service.
- See Also:
-
updateDataset
default UpdateDatasetResponse updateDataset(UpdateDatasetRequest updateDatasetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Updates a FinSpace Dataset.
- Parameters:
updateDatasetRequest
- The request for an UpdateDataset operation- Returns:
- Result of the UpdateDataset operation returned by the service.
- See Also:
-
updateDataset
default UpdateDatasetResponse updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ConflictException, ResourceNotFoundException, AwsServiceException, SdkClientException, FinspaceDataException Updates a FinSpace Dataset.
This is a convenience which creates an instance of the
UpdateDatasetRequest.Builder
avoiding the need to create one manually viaUpdateDatasetRequest.builder()
- Parameters:
updateDatasetRequest
- AConsumer
that will call methods onUpdateDatasetRequest.Builder
to create a request. The request for an UpdateDataset operation- Returns:
- Result of the UpdateDataset operation returned by the service.
- See Also:
-
updatePermissionGroup
default UpdatePermissionGroupResponse updatePermissionGroup(UpdatePermissionGroupRequest updatePermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Modifies the details of a permission group. You cannot modify a
permissionGroupID
.- Parameters:
updatePermissionGroupRequest
-- Returns:
- Result of the UpdatePermissionGroup operation returned by the service.
- See Also:
-
updatePermissionGroup
default UpdatePermissionGroupResponse updatePermissionGroup(Consumer<UpdatePermissionGroupRequest.Builder> updatePermissionGroupRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Modifies the details of a permission group. You cannot modify a
permissionGroupID
.
This is a convenience which creates an instance of the
UpdatePermissionGroupRequest.Builder
avoiding the need to create one manually viaUpdatePermissionGroupRequest.builder()
- Parameters:
updatePermissionGroupRequest
- AConsumer
that will call methods onUpdatePermissionGroupRequest.Builder
to create a request.- Returns:
- Result of the UpdatePermissionGroup operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(UpdateUserRequest updateUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Modifies the details of the specified user. You cannot update the
userId
for a user.- Parameters:
updateUserRequest
-- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
updateUser
default UpdateUserResponse updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest) throws InternalServerException, ValidationException, ThrottlingException, AccessDeniedException, ResourceNotFoundException, ConflictException, AwsServiceException, SdkClientException, FinspaceDataException Modifies the details of the specified user. You cannot update the
userId
for a user.
This is a convenience which creates an instance of the
UpdateUserRequest.Builder
avoiding the need to create one manually viaUpdateUserRequest.builder()
- Parameters:
updateUserRequest
- AConsumer
that will call methods onUpdateUserRequest.Builder
to create a request.- Returns:
- Result of the UpdateUser operation returned by the service.
- See Also:
-
create
Create aFinspaceDataClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aFinspaceDataClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-