@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface MedicalImagingAsyncClient extends AwsClient
builder() method.
This is the AWS HealthImaging API Reference. AWS HealthImaging is an AWS service for storing, accessing, and analyzing medical images. For an introduction to the service, see the AWS HealthImaging Developer Guide .
We recommend using one of the AWS Software Development Kits (SDKs) for your programming language, as they take care of request authentication, serialization, and connection management. For more information, see Tools to build on AWS.
For information about using AWS HealthImaging API actions in one of the language-specific AWS SDKs, refer to the See Also link at the end of each section that describes an API action or data type.
The following sections list AWS HealthImaging API actions categorized according to functionality. Links are provided to actions within this Reference, along with links back to corresponding sections in the AWS HealthImaging Developer Guide so you can view console procedures and CLI/SDK code examples.
Data store actions
Import job actions
Image set access actions
Image set modification actions
CopyImageSet – See Copying an image set.
Tagging actions
TagResource – See Tagging a data store and Tagging an image set.
ListTagsForResource – See Tagging a data store and Tagging an image set.
UntagResource – See Tagging a data store and Tagging an image set.
| 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 |
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<CopyImageSetResponse> copyImageSet(CopyImageSetRequest copyImageSetRequest)
Copy an image set.
copyImageSetRequest - default CompletableFuture<CopyImageSetResponse> copyImageSet(Consumer<CopyImageSetRequest.Builder> copyImageSetRequest)
Copy an image set.
This is a convenience which creates an instance of the CopyImageSetRequest.Builder avoiding the need to
create one manually via CopyImageSetRequest.builder()
copyImageSetRequest - A Consumer that will call methods on
CopyImageSetRequest.Builder to create a
request.default CompletableFuture<CreateDatastoreResponse> createDatastore(CreateDatastoreRequest createDatastoreRequest)
Create a data store.
createDatastoreRequest - default CompletableFuture<CreateDatastoreResponse> createDatastore(Consumer<CreateDatastoreRequest.Builder> createDatastoreRequest)
Create a data store.
This is a convenience which creates an instance of the CreateDatastoreRequest.Builder avoiding the need
to create one manually via CreateDatastoreRequest.builder()
createDatastoreRequest - A Consumer that will call methods on
CreateDatastoreRequest.Builder to create a
request.default CompletableFuture<DeleteDatastoreResponse> deleteDatastore(DeleteDatastoreRequest deleteDatastoreRequest)
Delete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
deleteDatastoreRequest - default CompletableFuture<DeleteDatastoreResponse> deleteDatastore(Consumer<DeleteDatastoreRequest.Builder> deleteDatastoreRequest)
Delete a data store.
Before a data store can be deleted, you must first delete all image sets within it.
This is a convenience which creates an instance of the DeleteDatastoreRequest.Builder avoiding the need
to create one manually via DeleteDatastoreRequest.builder()
deleteDatastoreRequest - A Consumer that will call methods on
DeleteDatastoreRequest.Builder to create a
request.default CompletableFuture<DeleteImageSetResponse> deleteImageSet(DeleteImageSetRequest deleteImageSetRequest)
Delete an image set.
deleteImageSetRequest - default CompletableFuture<DeleteImageSetResponse> deleteImageSet(Consumer<DeleteImageSetRequest.Builder> deleteImageSetRequest)
Delete an image set.
This is a convenience which creates an instance of the DeleteImageSetRequest.Builder avoiding the need to
create one manually via DeleteImageSetRequest.builder()
deleteImageSetRequest - A Consumer that will call methods on
DeleteImageSetRequest.Builder to create a
request.default CompletableFuture<GetDicomImportJobResponse> getDICOMImportJob(GetDicomImportJobRequest getDicomImportJobRequest)
Get the import job properties to learn more about the job or job progress.
getDicomImportJobRequest - default CompletableFuture<GetDicomImportJobResponse> getDICOMImportJob(Consumer<GetDicomImportJobRequest.Builder> getDicomImportJobRequest)
Get the import job properties to learn more about the job or job progress.
This is a convenience which creates an instance of the GetDicomImportJobRequest.Builder avoiding the need
to create one manually via GetDicomImportJobRequest.builder()
getDicomImportJobRequest - A Consumer that will call methods on
GetDicomImportJobRequest.Builder to create a
request.default CompletableFuture<GetDatastoreResponse> getDatastore(GetDatastoreRequest getDatastoreRequest)
Get data store properties.
getDatastoreRequest - default CompletableFuture<GetDatastoreResponse> getDatastore(Consumer<GetDatastoreRequest.Builder> getDatastoreRequest)
Get data store properties.
This is a convenience which creates an instance of the GetDatastoreRequest.Builder avoiding the need to
create one manually via GetDatastoreRequest.builder()
getDatastoreRequest - A Consumer that will call methods on
GetDatastoreRequest.Builder to create a
request.default <ReturnT> CompletableFuture<ReturnT> getImageFrame(GetImageFrameRequest getImageFrameRequest, AsyncResponseTransformer<GetImageFrameResponse,ReturnT> asyncResponseTransformer)
Get an image frame (pixel data) for an image set.
getImageFrameRequest - asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The blob containing the aggregated image frame information.
'.default <ReturnT> CompletableFuture<ReturnT> getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest, AsyncResponseTransformer<GetImageFrameResponse,ReturnT> asyncResponseTransformer)
Get an image frame (pixel data) for an image set.
This is a convenience which creates an instance of the GetImageFrameRequest.Builder avoiding the need to
create one manually via GetImageFrameRequest.builder()
getImageFrameRequest - A Consumer that will call methods on
GetImageFrameRequest.Builder to create a
request.asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The blob containing the aggregated image frame information.
'.default CompletableFuture<GetImageFrameResponse> getImageFrame(GetImageFrameRequest getImageFrameRequest, Path destinationPath)
Get an image frame (pixel data) for an image set.
getImageFrameRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The blob containing the aggregated image frame information.
'.default CompletableFuture<GetImageFrameResponse> getImageFrame(Consumer<GetImageFrameRequest.Builder> getImageFrameRequest, Path destinationPath)
Get an image frame (pixel data) for an image set.
This is a convenience which creates an instance of the GetImageFrameRequest.Builder avoiding the need to
create one manually via GetImageFrameRequest.builder()
getImageFrameRequest - A Consumer that will call methods on
GetImageFrameRequest.Builder to create a
request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The blob containing the aggregated image frame information.
'.default CompletableFuture<GetImageSetResponse> getImageSet(GetImageSetRequest getImageSetRequest)
Get image set properties.
getImageSetRequest - default CompletableFuture<GetImageSetResponse> getImageSet(Consumer<GetImageSetRequest.Builder> getImageSetRequest)
Get image set properties.
This is a convenience which creates an instance of the GetImageSetRequest.Builder avoiding the need to
create one manually via GetImageSetRequest.builder()
getImageSetRequest - A Consumer that will call methods on
GetImageSetRequest.Builder to create a
request.default <ReturnT> CompletableFuture<ReturnT> getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest, AsyncResponseTransformer<GetImageSetMetadataResponse,ReturnT> asyncResponseTransformer)
Get metadata attributes for an image set.
getImageSetMetadataRequest - asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The blob containing the aggregated metadata information for the image set.
'.default <ReturnT> CompletableFuture<ReturnT> getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest, AsyncResponseTransformer<GetImageSetMetadataResponse,ReturnT> asyncResponseTransformer)
Get metadata attributes for an image set.
This is a convenience which creates an instance of the GetImageSetMetadataRequest.Builder avoiding the
need to create one manually via GetImageSetMetadataRequest.builder()
getImageSetMetadataRequest - A Consumer that will call methods on
GetImageSetMetadataRequest.Builder to create
a request.asyncResponseTransformer - The response transformer for processing the streaming response in a non-blocking manner. See
AsyncResponseTransformer for details on how this callback should be implemented and for links to
precanned implementations for common scenarios like downloading to a file. The service documentation for
the response content is as follows '
The blob containing the aggregated metadata information for the image set.
'.default CompletableFuture<GetImageSetMetadataResponse> getImageSetMetadata(GetImageSetMetadataRequest getImageSetMetadataRequest, Path destinationPath)
Get metadata attributes for an image set.
getImageSetMetadataRequest - destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The blob containing the aggregated metadata information for the image set.
'.default CompletableFuture<GetImageSetMetadataResponse> getImageSetMetadata(Consumer<GetImageSetMetadataRequest.Builder> getImageSetMetadataRequest, Path destinationPath)
Get metadata attributes for an image set.
This is a convenience which creates an instance of the GetImageSetMetadataRequest.Builder avoiding the
need to create one manually via GetImageSetMetadataRequest.builder()
getImageSetMetadataRequest - A Consumer that will call methods on
GetImageSetMetadataRequest.Builder to create
a request.destinationPath - Path to file that response contents will be written to. The file must not exist or this method
will throw an exception. If the file is not writable by the current user then an exception will be thrown.
The service documentation for the response content is as follows '
The blob containing the aggregated metadata information for the image set.
'.default CompletableFuture<ListDicomImportJobsResponse> listDICOMImportJobs(ListDicomImportJobsRequest listDicomImportJobsRequest)
List import jobs created by this AWS account for a specific data store.
listDicomImportJobsRequest - default CompletableFuture<ListDicomImportJobsResponse> listDICOMImportJobs(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest)
List import jobs created by this AWS account for a specific data store.
This is a convenience which creates an instance of the ListDicomImportJobsRequest.Builder avoiding the
need to create one manually via ListDicomImportJobsRequest.builder()
listDicomImportJobsRequest - A Consumer that will call methods on
ListDicomImportJobsRequest.Builder to create
a request.default ListDICOMImportJobsPublisher listDICOMImportJobsPaginator(ListDicomImportJobsRequest listDicomImportJobsRequest)
List import jobs created by this AWS account for a specific data store.
This is a variant of
listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest)
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.medicalimaging.paginators.ListDICOMImportJobsPublisher publisher = client.listDICOMImportJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsPublisher publisher = client.listDICOMImportJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse 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
listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest)
operation.
listDicomImportJobsRequest - default ListDICOMImportJobsPublisher listDICOMImportJobsPaginator(Consumer<ListDicomImportJobsRequest.Builder> listDicomImportJobsRequest)
List import jobs created by this AWS account for a specific data store.
This is a variant of
listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest)
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.medicalimaging.paginators.ListDICOMImportJobsPublisher publisher = client.listDICOMImportJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.medicalimaging.paginators.ListDICOMImportJobsPublisher publisher = client.listDICOMImportJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsResponse 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
listDICOMImportJobs(software.amazon.awssdk.services.medicalimaging.model.ListDicomImportJobsRequest)
operation.
This is a convenience which creates an instance of the ListDicomImportJobsRequest.Builder avoiding the
need to create one manually via ListDicomImportJobsRequest.builder()
listDicomImportJobsRequest - A Consumer that will call methods on
ListDicomImportJobsRequest.Builder to create
a request.default CompletableFuture<ListDatastoresResponse> listDatastores(ListDatastoresRequest listDatastoresRequest)
List data stores created by this AWS account.
listDatastoresRequest - default CompletableFuture<ListDatastoresResponse> listDatastores(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)
List data stores created by this AWS account.
This is a convenience which creates an instance of the ListDatastoresRequest.Builder avoiding the need to
create one manually via ListDatastoresRequest.builder()
listDatastoresRequest - A Consumer that will call methods on
ListDatastoresRequest.Builder to create a
request.default ListDatastoresPublisher listDatastoresPaginator(ListDatastoresRequest listDatastoresRequest)
List data stores created by this AWS account.
This is a variant of
listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest) 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.medicalimaging.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse 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
listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest)
operation.
listDatastoresRequest - default ListDatastoresPublisher listDatastoresPaginator(Consumer<ListDatastoresRequest.Builder> listDatastoresRequest)
List data stores created by this AWS account.
This is a variant of
listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest) 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.medicalimaging.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.medicalimaging.paginators.ListDatastoresPublisher publisher = client.listDatastoresPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresResponse 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
listDatastores(software.amazon.awssdk.services.medicalimaging.model.ListDatastoresRequest)
operation.
This is a convenience which creates an instance of the ListDatastoresRequest.Builder avoiding the need to
create one manually via ListDatastoresRequest.builder()
listDatastoresRequest - A Consumer that will call methods on
ListDatastoresRequest.Builder to create a
request.default CompletableFuture<ListImageSetVersionsResponse> listImageSetVersions(ListImageSetVersionsRequest listImageSetVersionsRequest)
List image set versions.
listImageSetVersionsRequest - default CompletableFuture<ListImageSetVersionsResponse> listImageSetVersions(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest)
List image set versions.
This is a convenience which creates an instance of the ListImageSetVersionsRequest.Builder avoiding the
need to create one manually via ListImageSetVersionsRequest.builder()
listImageSetVersionsRequest - A Consumer that will call methods on
ListImageSetVersionsRequest.Builder to create
a request.default ListImageSetVersionsPublisher listImageSetVersionsPaginator(ListImageSetVersionsRequest listImageSetVersionsRequest)
List image set versions.
This is a variant of
listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest)
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.medicalimaging.paginators.ListImageSetVersionsPublisher publisher = client.listImageSetVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsPublisher publisher = client.listImageSetVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse 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
listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest)
operation.
listImageSetVersionsRequest - default ListImageSetVersionsPublisher listImageSetVersionsPaginator(Consumer<ListImageSetVersionsRequest.Builder> listImageSetVersionsRequest)
List image set versions.
This is a variant of
listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest)
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.medicalimaging.paginators.ListImageSetVersionsPublisher publisher = client.listImageSetVersionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.medicalimaging.paginators.ListImageSetVersionsPublisher publisher = client.listImageSetVersionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsResponse 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
listImageSetVersions(software.amazon.awssdk.services.medicalimaging.model.ListImageSetVersionsRequest)
operation.
This is a convenience which creates an instance of the ListImageSetVersionsRequest.Builder avoiding the
need to create one manually via ListImageSetVersionsRequest.builder()
listImageSetVersionsRequest - A Consumer that will call methods on
ListImageSetVersionsRequest.Builder to create
a request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists all tags associated with a medical imaging resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists all tags associated with a medical imaging resource.
This is a convenience which creates an instance of the ListTagsForResourceRequest.Builder avoiding the
need to create one manually via ListTagsForResourceRequest.builder()
listTagsForResourceRequest - A Consumer that will call methods on
ListTagsForResourceRequest.Builder to create
a request.default CompletableFuture<SearchImageSetsResponse> searchImageSets(SearchImageSetsRequest searchImageSetsRequest)
Search image sets based on defined input attributes.
searchImageSetsRequest - default CompletableFuture<SearchImageSetsResponse> searchImageSets(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest)
Search image sets based on defined input attributes.
This is a convenience which creates an instance of the SearchImageSetsRequest.Builder avoiding the need
to create one manually via SearchImageSetsRequest.builder()
searchImageSetsRequest - A Consumer that will call methods on
SearchImageSetsRequest.Builder to create a
request.default SearchImageSetsPublisher searchImageSetsPaginator(SearchImageSetsRequest searchImageSetsRequest)
Search image sets based on defined input attributes.
This is a variant of
searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest) 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.medicalimaging.paginators.SearchImageSetsPublisher publisher = client.searchImageSetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsPublisher publisher = client.searchImageSetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse 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
searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest)
operation.
searchImageSetsRequest - default SearchImageSetsPublisher searchImageSetsPaginator(Consumer<SearchImageSetsRequest.Builder> searchImageSetsRequest)
Search image sets based on defined input attributes.
This is a variant of
searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest) 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.medicalimaging.paginators.SearchImageSetsPublisher publisher = client.searchImageSetsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.medicalimaging.paginators.SearchImageSetsPublisher publisher = client.searchImageSetsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsResponse 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
searchImageSets(software.amazon.awssdk.services.medicalimaging.model.SearchImageSetsRequest)
operation.
This is a convenience which creates an instance of the SearchImageSetsRequest.Builder avoiding the need
to create one manually via SearchImageSetsRequest.builder()
searchImageSetsRequest - A Consumer that will call methods on
SearchImageSetsRequest.Builder to create a
request.default CompletableFuture<StartDicomImportJobResponse> startDICOMImportJob(StartDicomImportJobRequest startDicomImportJobRequest)
Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files found in
the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the
file specified by the outputS3Uri parameter.
startDicomImportJobRequest - default CompletableFuture<StartDicomImportJobResponse> startDICOMImportJob(Consumer<StartDicomImportJobRequest.Builder> startDicomImportJobRequest)
Start importing bulk data into an ACTIVE data store. The import job imports DICOM P10 files found in
the S3 prefix specified by the inputS3Uri parameter. The import job stores processing results in the
file specified by the outputS3Uri parameter.
This is a convenience which creates an instance of the StartDicomImportJobRequest.Builder avoiding the
need to create one manually via StartDicomImportJobRequest.builder()
startDicomImportJobRequest - A Consumer that will call methods on
StartDicomImportJobRequest.Builder to create
a request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
Adds a user-specifed key and value tag to a medical imaging resource.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
Adds a user-specifed key and value tag to a medical imaging resource.
This is a convenience which creates an instance of the TagResourceRequest.Builder avoiding the need to
create one manually via TagResourceRequest.builder()
tagResourceRequest - A Consumer that will call methods on
TagResourceRequest.Builder to create a
request.default CompletableFuture<UntagResourceResponse> untagResource(UntagResourceRequest untagResourceRequest)
Removes tags from a medical imaging resource.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
Removes tags from a medical imaging resource.
This is a convenience which creates an instance of the UntagResourceRequest.Builder avoiding the need to
create one manually via UntagResourceRequest.builder()
untagResourceRequest - A Consumer that will call methods on
UntagResourceRequest.Builder to create a
request.default CompletableFuture<UpdateImageSetMetadataResponse> updateImageSetMetadata(UpdateImageSetMetadataRequest updateImageSetMetadataRequest)
Update image set metadata attributes.
updateImageSetMetadataRequest - default CompletableFuture<UpdateImageSetMetadataResponse> updateImageSetMetadata(Consumer<UpdateImageSetMetadataRequest.Builder> updateImageSetMetadataRequest)
Update image set metadata attributes.
This is a convenience which creates an instance of the UpdateImageSetMetadataRequest.Builder avoiding the
need to create one manually via UpdateImageSetMetadataRequest.builder()
updateImageSetMetadataRequest - A Consumer that will call methods on
UpdateImageSetMetadataRequest.Builder to
create a request.default MedicalImagingServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic MedicalImagingAsyncClient create()
MedicalImagingAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static MedicalImagingAsyncClientBuilder builder()
MedicalImagingAsyncClient.Copyright © 2023. All rights reserved.