@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface FinspaceDataAsyncClient extends SdkClient
builder()
method.
The FinSpace APIs let you take actions inside the FinSpace.
| Modifier and Type | Field and Description |
|---|---|
static String |
SERVICE_METADATA_ID
Value for looking up the service's metadata from the
ServiceMetadataProvider. |
static String |
SERVICE_NAME |
| Modifier and Type | Method and Description |
|---|---|
default CompletableFuture<AssociateUserToPermissionGroupResponse> |
associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest associateUserToPermissionGroupRequest)
Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
|
default CompletableFuture<AssociateUserToPermissionGroupResponse> |
associateUserToPermissionGroup(Consumer<AssociateUserToPermissionGroupRequest.Builder> associateUserToPermissionGroupRequest)
Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
|
static FinspaceDataAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
FinspaceDataAsyncClient. |
static FinspaceDataAsyncClient |
create()
Create a
FinspaceDataAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
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.
|
default CompletableFuture<CreatePermissionGroupResponse> |
createPermissionGroup(Consumer<CreatePermissionGroupRequest.Builder> createPermissionGroupRequest)
Creates a group of permissions for various actions that a user can perform in FinSpace.
|
default CompletableFuture<CreatePermissionGroupResponse> |
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.
|
default CompletableFuture<DeletePermissionGroupResponse> |
deletePermissionGroup(Consumer<DeletePermissionGroupRequest.Builder> deletePermissionGroupRequest)
Deletes a permission group.
|
default CompletableFuture<DeletePermissionGroupResponse> |
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.
|
default CompletableFuture<DisassociateUserFromPermissionGroupResponse> |
disassociateUserFromPermissionGroup(Consumer<DisassociateUserFromPermissionGroupRequest.Builder> disassociateUserFromPermissionGroupRequest)
Removes a user account from a permission group.
|
default CompletableFuture<DisassociateUserFromPermissionGroupResponse> |
disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest disassociateUserFromPermissionGroupRequest)
Removes a user account 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.
|
default CompletableFuture<GetExternalDataViewAccessDetailsResponse> |
getExternalDataViewAccessDetails(Consumer<GetExternalDataViewAccessDetailsRequest.Builder> getExternalDataViewAccessDetailsRequest)
Returns the credentials to access the external Dataview from an S3 location.
|
default CompletableFuture<GetExternalDataViewAccessDetailsResponse> |
getExternalDataViewAccessDetails(GetExternalDataViewAccessDetailsRequest getExternalDataViewAccessDetailsRequest)
Returns the credentials to access the external Dataview from an S3 location.
|
default CompletableFuture<GetPermissionGroupResponse> |
getPermissionGroup(Consumer<GetPermissionGroupRequest.Builder> getPermissionGroupRequest)
Retrieves the details of a specific permission group.
|
default CompletableFuture<GetPermissionGroupResponse> |
getPermissionGroup(GetPermissionGroupRequest getPermissionGroupRequest)
Retrieves the details of a specific permission group.
|
default CompletableFuture<GetProgrammaticAccessCredentialsResponse> |
getProgrammaticAccessCredentials(Consumer<GetProgrammaticAccessCredentialsRequest.Builder> getProgrammaticAccessCredentialsRequest)
Request programmatic credentials to use with FinSpace SDK.
|
default CompletableFuture<GetProgrammaticAccessCredentialsResponse> |
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.
|
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.
|
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.
|
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 ListChangesetsPublisher |
listChangesetsPaginator(Consumer<ListChangesetsRequest.Builder> listChangesetsRequest)
Lists the FinSpace Changesets for a Dataset.
|
default ListChangesetsPublisher |
listChangesetsPaginator(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 ListDatasetsPublisher |
listDatasetsPaginator(Consumer<ListDatasetsRequest.Builder> listDatasetsRequest)
Lists all of the active Datasets that a user has access to.
|
default ListDatasetsPublisher |
listDatasetsPaginator(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 ListDataViewsPublisher |
listDataViewsPaginator(Consumer<ListDataViewsRequest.Builder> listDataViewsRequest)
Lists all available Dataviews for a Dataset.
|
default ListDataViewsPublisher |
listDataViewsPaginator(ListDataViewsRequest listDataViewsRequest)
Lists all available Dataviews for a Dataset.
|
default CompletableFuture<ListPermissionGroupsResponse> |
listPermissionGroups(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest)
Lists all available permission groups in FinSpace.
|
default CompletableFuture<ListPermissionGroupsResponse> |
listPermissionGroups(ListPermissionGroupsRequest listPermissionGroupsRequest)
Lists all available permission groups in FinSpace.
|
default CompletableFuture<ListPermissionGroupsByUserResponse> |
listPermissionGroupsByUser(Consumer<ListPermissionGroupsByUserRequest.Builder> listPermissionGroupsByUserRequest)
Lists all the permission groups that are associated with a specific user account.
|
default CompletableFuture<ListPermissionGroupsByUserResponse> |
listPermissionGroupsByUser(ListPermissionGroupsByUserRequest listPermissionGroupsByUserRequest)
Lists all the permission groups that are associated with a specific user account.
|
default ListPermissionGroupsPublisher |
listPermissionGroupsPaginator(Consumer<ListPermissionGroupsRequest.Builder> listPermissionGroupsRequest)
Lists all available permission groups in FinSpace.
|
default ListPermissionGroupsPublisher |
listPermissionGroupsPaginator(ListPermissionGroupsRequest listPermissionGroupsRequest)
Lists all available permission groups in FinSpace.
|
default CompletableFuture<ListUsersResponse> |
listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists all available user accounts in FinSpace.
|
default CompletableFuture<ListUsersResponse> |
listUsers(ListUsersRequest listUsersRequest)
Lists all available user accounts in FinSpace.
|
default CompletableFuture<ListUsersByPermissionGroupResponse> |
listUsersByPermissionGroup(Consumer<ListUsersByPermissionGroupRequest.Builder> listUsersByPermissionGroupRequest)
Lists details of all the users in a specific permission group.
|
default CompletableFuture<ListUsersByPermissionGroupResponse> |
listUsersByPermissionGroup(ListUsersByPermissionGroupRequest listUsersByPermissionGroupRequest)
Lists details of all the users in a specific permission group.
|
default ListUsersPublisher |
listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists all available user accounts in FinSpace.
|
default ListUsersPublisher |
listUsersPaginator(ListUsersRequest listUsersRequest)
Lists all available user accounts in FinSpace.
|
default CompletableFuture<ResetUserPasswordResponse> |
resetUserPassword(Consumer<ResetUserPasswordRequest.Builder> resetUserPasswordRequest)
Resets the password for a specified user ID and generates a temporary one.
|
default CompletableFuture<ResetUserPasswordResponse> |
resetUserPassword(ResetUserPasswordRequest resetUserPasswordRequest)
Resets the password for a specified user ID and generates a temporary one.
|
default 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.
|
default CompletableFuture<UpdatePermissionGroupResponse> |
updatePermissionGroup(Consumer<UpdatePermissionGroupRequest.Builder> updatePermissionGroupRequest)
Modifies the details of a permission group.
|
default CompletableFuture<UpdatePermissionGroupResponse> |
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 account.
|
default CompletableFuture<UpdateUserResponse> |
updateUser(UpdateUserRequest updateUserRequest)
Modifies the details of the specified user account.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.static FinspaceDataAsyncClient create()
FinspaceDataAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static FinspaceDataAsyncClientBuilder builder()
FinspaceDataAsyncClient.default CompletableFuture<AssociateUserToPermissionGroupResponse> associateUserToPermissionGroup(AssociateUserToPermissionGroupRequest associateUserToPermissionGroupRequest)
Adds a user account to a permission group to grant permissions for actions a user can perform in FinSpace.
associateUserToPermissionGroupRequest - default CompletableFuture<AssociateUserToPermissionGroupResponse> associateUserToPermissionGroup(Consumer<AssociateUserToPermissionGroupRequest.Builder> associateUserToPermissionGroupRequest)
Adds a user account 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 via AssociateUserToPermissionGroupRequest.builder()
associateUserToPermissionGroupRequest - A Consumer that will call methods on AssociateUserToPermissionGroupRequest.Builder to
create a request.default CompletableFuture<CreateChangesetResponse> createChangeset(CreateChangesetRequest createChangesetRequest)
Creates a new Changeset in a FinSpace Dataset.
createChangesetRequest - The request for a CreateChangeset operation.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.Builder avoiding the need
to create one manually via CreateChangesetRequest.builder()
createChangesetRequest - A Consumer that will call methods on CreateChangesetRequest.Builder to create a request.
The request for a CreateChangeset operation.default CompletableFuture<CreateDataViewResponse> createDataView(CreateDataViewRequest createDataViewRequest)
Creates a Dataview for a Dataset.
createDataViewRequest - Request for creating a data view.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.Builder avoiding the need to
create one manually via CreateDataViewRequest.builder()
createDataViewRequest - A Consumer that will call methods on CreateDataViewRequest.Builder to create a request.
Request for creating a data view.default CompletableFuture<CreateDatasetResponse> createDataset(CreateDatasetRequest createDatasetRequest)
Creates a new FinSpace Dataset.
createDatasetRequest - The request for a CreateDataset operationdefault CompletableFuture<CreateDatasetResponse> createDataset(Consumer<CreateDatasetRequest.Builder> createDatasetRequest)
Creates a new FinSpace Dataset.
This is a convenience which creates an instance of the CreateDatasetRequest.Builder avoiding the need to
create one manually via CreateDatasetRequest.builder()
createDatasetRequest - A Consumer that will call methods on CreateDatasetRequest.Builder to create a request. The
request for a CreateDataset operationdefault CompletableFuture<CreatePermissionGroupResponse> createPermissionGroup(CreatePermissionGroupRequest createPermissionGroupRequest)
Creates a group of permissions for various actions that a user can perform in FinSpace.
createPermissionGroupRequest - 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.Builder avoiding the
need to create one manually via CreatePermissionGroupRequest.builder()
createPermissionGroupRequest - A Consumer that will call methods on CreatePermissionGroupRequest.Builder to create a
request.default CompletableFuture<CreateUserResponse> createUser(CreateUserRequest createUserRequest)
Creates a new user in FinSpace.
createUserRequest - 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.Builder avoiding the need to
create one manually via CreateUserRequest.builder()
createUserRequest - A Consumer that will call methods on CreateUserRequest.Builder to create a request.default CompletableFuture<DeleteDatasetResponse> deleteDataset(DeleteDatasetRequest deleteDatasetRequest)
Deletes a FinSpace Dataset.
deleteDatasetRequest - The request for a DeleteDataset operation.default CompletableFuture<DeleteDatasetResponse> deleteDataset(Consumer<DeleteDatasetRequest.Builder> deleteDatasetRequest)
Deletes a FinSpace Dataset.
This is a convenience which creates an instance of the DeleteDatasetRequest.Builder avoiding the need to
create one manually via DeleteDatasetRequest.builder()
deleteDatasetRequest - A Consumer that will call methods on DeleteDatasetRequest.Builder to create a request. The
request for a DeleteDataset operation.default CompletableFuture<DeletePermissionGroupResponse> deletePermissionGroup(DeletePermissionGroupRequest deletePermissionGroupRequest)
Deletes a permission group. This action is irreversible.
deletePermissionGroupRequest - 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.Builder avoiding the
need to create one manually via DeletePermissionGroupRequest.builder()
deletePermissionGroupRequest - A Consumer that will call methods on DeletePermissionGroupRequest.Builder to create a
request.default CompletableFuture<DisableUserResponse> disableUser(DisableUserRequest disableUserRequest)
Denies access to the FinSpace web application and API for the specified user.
disableUserRequest - 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.Builder avoiding the need to
create one manually via DisableUserRequest.builder()
disableUserRequest - A Consumer that will call methods on DisableUserRequest.Builder to create a request.default CompletableFuture<DisassociateUserFromPermissionGroupResponse> disassociateUserFromPermissionGroup(DisassociateUserFromPermissionGroupRequest disassociateUserFromPermissionGroupRequest)
Removes a user account from a permission group.
disassociateUserFromPermissionGroupRequest - default CompletableFuture<DisassociateUserFromPermissionGroupResponse> disassociateUserFromPermissionGroup(Consumer<DisassociateUserFromPermissionGroupRequest.Builder> disassociateUserFromPermissionGroupRequest)
Removes a user account from a permission group.
This is a convenience which creates an instance of the DisassociateUserFromPermissionGroupRequest.Builder
avoiding the need to create one manually via DisassociateUserFromPermissionGroupRequest.builder()
disassociateUserFromPermissionGroupRequest - A Consumer that will call methods on DisassociateUserFromPermissionGroupRequest.Builder to
create a request.default CompletableFuture<EnableUserResponse> enableUser(EnableUserRequest enableUserRequest)
Allows the specified user to access the FinSpace web application and API.
enableUserRequest - 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.Builder avoiding the need to
create one manually via EnableUserRequest.builder()
enableUserRequest - A Consumer that will call methods on EnableUserRequest.Builder to create a request.default CompletableFuture<GetChangesetResponse> getChangeset(GetChangesetRequest getChangesetRequest)
Get information about a Changeset.
getChangesetRequest - Request to describe a changeset.default CompletableFuture<GetChangesetResponse> getChangeset(Consumer<GetChangesetRequest.Builder> getChangesetRequest)
Get information about a Changeset.
This is a convenience which creates an instance of the GetChangesetRequest.Builder avoiding the need to
create one manually via GetChangesetRequest.builder()
getChangesetRequest - A Consumer that will call methods on GetChangesetRequest.Builder to create a request.
Request to describe a changeset.default CompletableFuture<GetDataViewResponse> getDataView(GetDataViewRequest getDataViewRequest)
Gets information about a Dataview.
getDataViewRequest - Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.default CompletableFuture<GetDataViewResponse> getDataView(Consumer<GetDataViewRequest.Builder> getDataViewRequest)
Gets information about a Dataview.
This is a convenience which creates an instance of the GetDataViewRequest.Builder avoiding the need to
create one manually via GetDataViewRequest.builder()
getDataViewRequest - A Consumer that will call methods on GetDataViewRequest.Builder to create a request.
Request for retrieving a data view detail. Grouped / accessible within a dataset by its dataset id.default CompletableFuture<GetDatasetResponse> getDataset(GetDatasetRequest getDatasetRequest)
Returns information about a Dataset.
getDatasetRequest - Request for the GetDataset operation.default CompletableFuture<GetDatasetResponse> getDataset(Consumer<GetDatasetRequest.Builder> getDatasetRequest)
Returns information about a Dataset.
This is a convenience which creates an instance of the GetDatasetRequest.Builder avoiding the need to
create one manually via GetDatasetRequest.builder()
getDatasetRequest - A Consumer that will call methods on GetDatasetRequest.Builder to create a request.
Request for the GetDataset operation.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 Data permissions.
getExternalDataViewAccessDetailsRequest - 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 Data permissions.
This is a convenience which creates an instance of the GetExternalDataViewAccessDetailsRequest.Builder
avoiding the need to create one manually via GetExternalDataViewAccessDetailsRequest.builder()
getExternalDataViewAccessDetailsRequest - A Consumer that will call methods on GetExternalDataViewAccessDetailsRequest.Builder to
create a request.default CompletableFuture<GetPermissionGroupResponse> getPermissionGroup(GetPermissionGroupRequest getPermissionGroupRequest)
Retrieves the details of a specific permission group.
getPermissionGroupRequest - 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.Builder avoiding the
need to create one manually via GetPermissionGroupRequest.builder()
getPermissionGroupRequest - A Consumer that will call methods on GetPermissionGroupRequest.Builder to create a
request.default CompletableFuture<GetProgrammaticAccessCredentialsResponse> getProgrammaticAccessCredentials(GetProgrammaticAccessCredentialsRequest getProgrammaticAccessCredentialsRequest)
Request programmatic credentials to use with FinSpace SDK.
getProgrammaticAccessCredentialsRequest - Request for GetProgrammaticAccessCredentials operationdefault CompletableFuture<GetProgrammaticAccessCredentialsResponse> getProgrammaticAccessCredentials(Consumer<GetProgrammaticAccessCredentialsRequest.Builder> getProgrammaticAccessCredentialsRequest)
Request programmatic credentials to use with FinSpace SDK.
This is a convenience which creates an instance of the GetProgrammaticAccessCredentialsRequest.Builder
avoiding the need to create one manually via GetProgrammaticAccessCredentialsRequest.builder()
getProgrammaticAccessCredentialsRequest - A Consumer that will call methods on GetProgrammaticAccessCredentialsRequest.Builder to
create a request. Request for GetProgrammaticAccessCredentials operationdefault CompletableFuture<GetUserResponse> getUser(GetUserRequest getUserRequest)
Retrieves details for a specific user.
getUserRequest - default CompletableFuture<GetUserResponse> getUser(Consumer<GetUserRequest.Builder> getUserRequest)
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 via GetUserRequest.builder()
getUserRequest - A Consumer that will call methods on GetUserRequest.Builder to create a request.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.
getWorkingLocationRequest - 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.Builder avoiding the
need to create one manually via GetWorkingLocationRequest.builder()
getWorkingLocationRequest - A Consumer that will call methods on GetWorkingLocationRequest.Builder to create a
request.default CompletableFuture<ListChangesetsResponse> listChangesets(ListChangesetsRequest listChangesetsRequest)
Lists the FinSpace Changesets for a Dataset.
listChangesetsRequest - Request to ListChangesetsRequest. It exposes minimal query filters.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.Builder avoiding the need to
create one manually via ListChangesetsRequest.builder()
listChangesetsRequest - A Consumer that will call methods on ListChangesetsRequest.Builder to create a request.
Request to ListChangesetsRequest. It exposes minimal query filters.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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListChangesetsPublisher publisher = client.listChangesetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listChangesetsRequest - Request to ListChangesetsRequest. It exposes minimal query filters.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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListChangesetsPublisher publisher = client.listChangesetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListChangesetsRequest.builder()
listChangesetsRequest - A Consumer that will call methods on ListChangesetsRequest.Builder to create a request.
Request to ListChangesetsRequest. It exposes minimal query filters.default CompletableFuture<ListDataViewsResponse> listDataViews(ListDataViewsRequest listDataViewsRequest)
Lists all available Dataviews for a Dataset.
listDataViewsRequest - Request for a list data views.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.Builder avoiding the need to
create one manually via ListDataViewsRequest.builder()
listDataViewsRequest - A Consumer that will call methods on ListDataViewsRequest.Builder to create a request.
Request for a list data views.default ListDataViewsPublisher listDataViewsPaginator(ListDataViewsRequest 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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListDataViewsPublisher publisher = client.listDataViewsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listDataViewsRequest - Request for a list data views.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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListDataViewsPublisher publisher = client.listDataViewsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListDataViewsRequest.builder()
listDataViewsRequest - A Consumer that will call methods on ListDataViewsRequest.Builder to create a request.
Request for a list data views.default CompletableFuture<ListDatasetsResponse> listDatasets(ListDatasetsRequest listDatasetsRequest)
Lists all of the active Datasets that a user has access to.
listDatasetsRequest - Request for the ListDatasets operation.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.Builder avoiding the need to
create one manually via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.
Request for the ListDatasets operation.default ListDatasetsPublisher listDatasetsPaginator(ListDatasetsRequest 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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listDatasetsRequest - Request for the ListDatasets operation.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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListDatasetsPublisher publisher = client.listDatasetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListDatasetsRequest.builder()
listDatasetsRequest - A Consumer that will call methods on ListDatasetsRequest.Builder to create a request.
Request for the ListDatasets operation.default CompletableFuture<ListPermissionGroupsResponse> listPermissionGroups(ListPermissionGroupsRequest listPermissionGroupsRequest)
Lists all available permission groups in FinSpace.
listPermissionGroupsRequest - 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.Builder avoiding the
need to create one manually via ListPermissionGroupsRequest.builder()
listPermissionGroupsRequest - A Consumer that will call methods on ListPermissionGroupsRequest.Builder to create a
request.default CompletableFuture<ListPermissionGroupsByUserResponse> listPermissionGroupsByUser(ListPermissionGroupsByUserRequest listPermissionGroupsByUserRequest)
Lists all the permission groups that are associated with a specific user account.
listPermissionGroupsByUserRequest - default CompletableFuture<ListPermissionGroupsByUserResponse> listPermissionGroupsByUser(Consumer<ListPermissionGroupsByUserRequest.Builder> listPermissionGroupsByUserRequest)
Lists all the permission groups that are associated with a specific user account.
This is a convenience which creates an instance of the ListPermissionGroupsByUserRequest.Builder avoiding
the need to create one manually via ListPermissionGroupsByUserRequest.builder()
listPermissionGroupsByUserRequest - A Consumer that will call methods on ListPermissionGroupsByUserRequest.Builder to create a
request.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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsPublisher publisher = client.listPermissionGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listPermissionGroupsRequest - 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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListPermissionGroupsPublisher publisher = client.listPermissionGroupsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListPermissionGroupsRequest.builder()
listPermissionGroupsRequest - A Consumer that will call methods on ListPermissionGroupsRequest.Builder to create a
request.default CompletableFuture<ListUsersResponse> listUsers(ListUsersRequest listUsersRequest)
Lists all available user accounts in FinSpace.
listUsersRequest - default CompletableFuture<ListUsersResponse> listUsers(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists all available user accounts in FinSpace.
This is a convenience which creates an instance of the ListUsersRequest.Builder avoiding the need to
create one manually via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.default CompletableFuture<ListUsersByPermissionGroupResponse> listUsersByPermissionGroup(ListUsersByPermissionGroupRequest listUsersByPermissionGroupRequest)
Lists details of all the users in a specific permission group.
listUsersByPermissionGroupRequest - 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.Builder avoiding
the need to create one manually via ListUsersByPermissionGroupRequest.builder()
listUsersByPermissionGroupRequest - A Consumer that will call methods on ListUsersByPermissionGroupRequest.Builder to create a
request.default ListUsersPublisher listUsersPaginator(ListUsersRequest listUsersRequest)
Lists all available user accounts 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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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.
listUsersRequest - default ListUsersPublisher listUsersPaginator(Consumer<ListUsersRequest.Builder> listUsersRequest)
Lists all available user accounts 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 new Subscription i.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
software.amazon.awssdk.services.finspacedata.paginators.ListUsersPublisher publisher = client.listUsersPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
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) { //... };
});
As the response is a publisher, it can work well with third party reactive streams implementations like RxJava2.
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 via ListUsersRequest.builder()
listUsersRequest - A Consumer that will call methods on ListUsersRequest.Builder to create a request.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.
resetUserPasswordRequest - 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.Builder avoiding the need
to create one manually via ResetUserPasswordRequest.builder()
resetUserPasswordRequest - A Consumer that will call methods on ResetUserPasswordRequest.Builder to create a request.default CompletableFuture<UpdateChangesetResponse> updateChangeset(UpdateChangesetRequest updateChangesetRequest)
Updates a FinSpace Changeset.
updateChangesetRequest - Request to update an existing changeset.default CompletableFuture<UpdateChangesetResponse> updateChangeset(Consumer<UpdateChangesetRequest.Builder> updateChangesetRequest)
Updates a FinSpace Changeset.
This is a convenience which creates an instance of the UpdateChangesetRequest.Builder avoiding the need
to create one manually via UpdateChangesetRequest.builder()
updateChangesetRequest - A Consumer that will call methods on UpdateChangesetRequest.Builder to create a request.
Request to update an existing changeset.default CompletableFuture<UpdateDatasetResponse> updateDataset(UpdateDatasetRequest updateDatasetRequest)
Updates a FinSpace Dataset.
updateDatasetRequest - The request for an UpdateDataset operationdefault CompletableFuture<UpdateDatasetResponse> updateDataset(Consumer<UpdateDatasetRequest.Builder> updateDatasetRequest)
Updates a FinSpace Dataset.
This is a convenience which creates an instance of the UpdateDatasetRequest.Builder avoiding the need to
create one manually via UpdateDatasetRequest.builder()
updateDatasetRequest - A Consumer that will call methods on UpdateDatasetRequest.Builder to create a request. The
request for an UpdateDataset operationdefault CompletableFuture<UpdatePermissionGroupResponse> updatePermissionGroup(UpdatePermissionGroupRequest updatePermissionGroupRequest)
Modifies the details of a permission group. You cannot modify a permissionGroupID.
updatePermissionGroupRequest - 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.Builder avoiding the
need to create one manually via UpdatePermissionGroupRequest.builder()
updatePermissionGroupRequest - A Consumer that will call methods on UpdatePermissionGroupRequest.Builder to create a
request.default CompletableFuture<UpdateUserResponse> updateUser(UpdateUserRequest updateUserRequest)
Modifies the details of the specified user account. You cannot update the userId for a user.
updateUserRequest - default CompletableFuture<UpdateUserResponse> updateUser(Consumer<UpdateUserRequest.Builder> updateUserRequest)
Modifies the details of the specified user account. 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 via UpdateUserRequest.builder()
updateUserRequest - A Consumer that will call methods on UpdateUserRequest.Builder to create a request.Copyright © 2023. All rights reserved.