@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface SageMakerGeospatialAsyncClient extends AwsClient
builder() method.
Provides APIs for creating and managing SageMaker geospatial resources.
| 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 |
|---|---|
static SageMakerGeospatialAsyncClientBuilder |
builder()
Create a builder that can be used to configure and create a
SageMakerGeospatialAsyncClient. |
static SageMakerGeospatialAsyncClient |
create()
Create a
SageMakerGeospatialAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default CompletableFuture<DeleteEarthObservationJobResponse> |
deleteEarthObservationJob(Consumer<DeleteEarthObservationJobRequest.Builder> deleteEarthObservationJobRequest)
Use this operation to delete an Earth Observation job.
|
default CompletableFuture<DeleteEarthObservationJobResponse> |
deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest)
Use this operation to delete an Earth Observation job.
|
default CompletableFuture<DeleteVectorEnrichmentJobResponse> |
deleteVectorEnrichmentJob(Consumer<DeleteVectorEnrichmentJobRequest.Builder> deleteVectorEnrichmentJobRequest)
Use this operation to delete a Vector Enrichment job.
|
default CompletableFuture<DeleteVectorEnrichmentJobResponse> |
deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest)
Use this operation to delete a Vector Enrichment job.
|
default CompletableFuture<ExportEarthObservationJobResponse> |
exportEarthObservationJob(Consumer<ExportEarthObservationJobRequest.Builder> exportEarthObservationJobRequest)
Use this operation to export results of an Earth Observation job and optionally source images used as input to
the EOJ to an Amazon S3 location.
|
default CompletableFuture<ExportEarthObservationJobResponse> |
exportEarthObservationJob(ExportEarthObservationJobRequest exportEarthObservationJobRequest)
Use this operation to export results of an Earth Observation job and optionally source images used as input to
the EOJ to an Amazon S3 location.
|
default CompletableFuture<ExportVectorEnrichmentJobResponse> |
exportVectorEnrichmentJob(Consumer<ExportVectorEnrichmentJobRequest.Builder> exportVectorEnrichmentJobRequest)
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
|
default CompletableFuture<ExportVectorEnrichmentJobResponse> |
exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest)
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
|
default CompletableFuture<GetEarthObservationJobResponse> |
getEarthObservationJob(Consumer<GetEarthObservationJobRequest.Builder> getEarthObservationJobRequest)
Get the details for a previously initiated Earth Observation job.
|
default CompletableFuture<GetEarthObservationJobResponse> |
getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest)
Get the details for a previously initiated Earth Observation job.
|
default CompletableFuture<GetRasterDataCollectionResponse> |
getRasterDataCollection(Consumer<GetRasterDataCollectionRequest.Builder> getRasterDataCollectionRequest)
Use this operation to get details of a specific raster data collection.
|
default CompletableFuture<GetRasterDataCollectionResponse> |
getRasterDataCollection(GetRasterDataCollectionRequest getRasterDataCollectionRequest)
Use this operation to get details of a specific raster data collection.
|
default <ReturnT> CompletableFuture<ReturnT> |
getTile(Consumer<GetTileRequest.Builder> getTileRequest,
AsyncResponseTransformer<GetTileResponse,ReturnT> asyncResponseTransformer)
Gets a web mercator tile for the given Earth Observation job.
|
default CompletableFuture<GetTileResponse> |
getTile(Consumer<GetTileRequest.Builder> getTileRequest,
Path destinationPath)
Gets a web mercator tile for the given Earth Observation job.
|
default <ReturnT> CompletableFuture<ReturnT> |
getTile(GetTileRequest getTileRequest,
AsyncResponseTransformer<GetTileResponse,ReturnT> asyncResponseTransformer)
Gets a web mercator tile for the given Earth Observation job.
|
default CompletableFuture<GetTileResponse> |
getTile(GetTileRequest getTileRequest,
Path destinationPath)
Gets a web mercator tile for the given Earth Observation job.
|
default CompletableFuture<GetVectorEnrichmentJobResponse> |
getVectorEnrichmentJob(Consumer<GetVectorEnrichmentJobRequest.Builder> getVectorEnrichmentJobRequest)
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
|
default CompletableFuture<GetVectorEnrichmentJobResponse> |
getVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest)
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
|
default CompletableFuture<ListEarthObservationJobsResponse> |
listEarthObservationJobs(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
account.
|
default CompletableFuture<ListEarthObservationJobsResponse> |
listEarthObservationJobs(ListEarthObservationJobsRequest listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
account.
|
default ListEarthObservationJobsPublisher |
listEarthObservationJobsPaginator(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
account.
|
default ListEarthObservationJobsPublisher |
listEarthObservationJobsPaginator(ListEarthObservationJobsRequest listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services
account.
|
default CompletableFuture<ListRasterDataCollectionsResponse> |
listRasterDataCollections(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
|
default CompletableFuture<ListRasterDataCollectionsResponse> |
listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
|
default ListRasterDataCollectionsPublisher |
listRasterDataCollectionsPaginator(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
|
default ListRasterDataCollectionsPublisher |
listRasterDataCollectionsPaginator(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags attached to the resource.
|
default CompletableFuture<ListTagsForResourceResponse> |
listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags attached to the resource.
|
default CompletableFuture<ListVectorEnrichmentJobsResponse> |
listVectorEnrichmentJobs(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
|
default CompletableFuture<ListVectorEnrichmentJobsResponse> |
listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
|
default ListVectorEnrichmentJobsPublisher |
listVectorEnrichmentJobsPaginator(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
|
default ListVectorEnrichmentJobsPublisher |
listVectorEnrichmentJobsPaginator(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
|
default CompletableFuture<SearchRasterDataCollectionResponse> |
searchRasterDataCollection(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
the selected filters.
|
default CompletableFuture<SearchRasterDataCollectionResponse> |
searchRasterDataCollection(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
the selected filters.
|
default SearchRasterDataCollectionPublisher |
searchRasterDataCollectionPaginator(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
the selected filters.
|
default SearchRasterDataCollectionPublisher |
searchRasterDataCollectionPaginator(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching
the selected filters.
|
default SageMakerGeospatialServiceClientConfiguration |
serviceClientConfiguration() |
default CompletableFuture<StartEarthObservationJobResponse> |
startEarthObservationJob(Consumer<StartEarthObservationJobRequest.Builder> startEarthObservationJobRequest)
Use this operation to create an Earth observation job.
|
default CompletableFuture<StartEarthObservationJobResponse> |
startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest)
Use this operation to create an Earth observation job.
|
default CompletableFuture<StartVectorEnrichmentJobResponse> |
startVectorEnrichmentJob(Consumer<StartVectorEnrichmentJobRequest.Builder> startVectorEnrichmentJobRequest)
Creates a Vector Enrichment job for the supplied job type.
|
default CompletableFuture<StartVectorEnrichmentJobResponse> |
startVectorEnrichmentJob(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest)
Creates a Vector Enrichment job for the supplied job type.
|
default CompletableFuture<StopEarthObservationJobResponse> |
stopEarthObservationJob(Consumer<StopEarthObservationJobRequest.Builder> stopEarthObservationJobRequest)
Use this operation to stop an existing earth observation job.
|
default CompletableFuture<StopEarthObservationJobResponse> |
stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest)
Use this operation to stop an existing earth observation job.
|
default CompletableFuture<StopVectorEnrichmentJobResponse> |
stopVectorEnrichmentJob(Consumer<StopVectorEnrichmentJobRequest.Builder> stopVectorEnrichmentJobRequest)
Stops the Vector Enrichment job for a given job ARN.
|
default CompletableFuture<StopVectorEnrichmentJobResponse> |
stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest)
Stops the Vector Enrichment job for a given job ARN.
|
default CompletableFuture<TagResourceResponse> |
tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
The resource you want to tag.
|
default CompletableFuture<TagResourceResponse> |
tagResource(TagResourceRequest tagResourceRequest)
The resource you want to tag.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
The resource you want to untag.
|
default CompletableFuture<UntagResourceResponse> |
untagResource(UntagResourceRequest untagResourceRequest)
The resource you want to untag.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default CompletableFuture<DeleteEarthObservationJobResponse> deleteEarthObservationJob(DeleteEarthObservationJobRequest deleteEarthObservationJobRequest)
Use this operation to delete an Earth Observation job.
deleteEarthObservationJobRequest - default CompletableFuture<DeleteEarthObservationJobResponse> deleteEarthObservationJob(Consumer<DeleteEarthObservationJobRequest.Builder> deleteEarthObservationJobRequest)
Use this operation to delete an Earth Observation job.
This is a convenience which creates an instance of the DeleteEarthObservationJobRequest.Builder avoiding
the need to create one manually via DeleteEarthObservationJobRequest.builder()
deleteEarthObservationJobRequest - A Consumer that will call methods on DeleteEarthObservationJobInput.Builder to create a
request.default CompletableFuture<DeleteVectorEnrichmentJobResponse> deleteVectorEnrichmentJob(DeleteVectorEnrichmentJobRequest deleteVectorEnrichmentJobRequest)
Use this operation to delete a Vector Enrichment job.
deleteVectorEnrichmentJobRequest - default CompletableFuture<DeleteVectorEnrichmentJobResponse> deleteVectorEnrichmentJob(Consumer<DeleteVectorEnrichmentJobRequest.Builder> deleteVectorEnrichmentJobRequest)
Use this operation to delete a Vector Enrichment job.
This is a convenience which creates an instance of the DeleteVectorEnrichmentJobRequest.Builder avoiding
the need to create one manually via DeleteVectorEnrichmentJobRequest.builder()
deleteVectorEnrichmentJobRequest - A Consumer that will call methods on DeleteVectorEnrichmentJobInput.Builder to create a
request.default CompletableFuture<ExportEarthObservationJobResponse> exportEarthObservationJob(ExportEarthObservationJobRequest exportEarthObservationJobRequest)
Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.
exportEarthObservationJobRequest - default CompletableFuture<ExportEarthObservationJobResponse> exportEarthObservationJob(Consumer<ExportEarthObservationJobRequest.Builder> exportEarthObservationJobRequest)
Use this operation to export results of an Earth Observation job and optionally source images used as input to the EOJ to an Amazon S3 location.
This is a convenience which creates an instance of the ExportEarthObservationJobRequest.Builder avoiding
the need to create one manually via ExportEarthObservationJobRequest.builder()
exportEarthObservationJobRequest - A Consumer that will call methods on ExportEarthObservationJobInput.Builder to create a
request.default CompletableFuture<ExportVectorEnrichmentJobResponse> exportVectorEnrichmentJob(ExportVectorEnrichmentJobRequest exportVectorEnrichmentJobRequest)
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
exportVectorEnrichmentJobRequest - default CompletableFuture<ExportVectorEnrichmentJobResponse> exportVectorEnrichmentJob(Consumer<ExportVectorEnrichmentJobRequest.Builder> exportVectorEnrichmentJobRequest)
Use this operation to copy results of a Vector Enrichment job to an Amazon S3 location.
This is a convenience which creates an instance of the ExportVectorEnrichmentJobRequest.Builder avoiding
the need to create one manually via ExportVectorEnrichmentJobRequest.builder()
exportVectorEnrichmentJobRequest - A Consumer that will call methods on ExportVectorEnrichmentJobInput.Builder to create a
request.default CompletableFuture<GetEarthObservationJobResponse> getEarthObservationJob(GetEarthObservationJobRequest getEarthObservationJobRequest)
Get the details for a previously initiated Earth Observation job.
getEarthObservationJobRequest - default CompletableFuture<GetEarthObservationJobResponse> getEarthObservationJob(Consumer<GetEarthObservationJobRequest.Builder> getEarthObservationJobRequest)
Get the details for a previously initiated Earth Observation job.
This is a convenience which creates an instance of the GetEarthObservationJobRequest.Builder avoiding the
need to create one manually via GetEarthObservationJobRequest.builder()
getEarthObservationJobRequest - A Consumer that will call methods on GetEarthObservationJobInput.Builder to create a
request.default CompletableFuture<GetRasterDataCollectionResponse> getRasterDataCollection(GetRasterDataCollectionRequest getRasterDataCollectionRequest)
Use this operation to get details of a specific raster data collection.
getRasterDataCollectionRequest - default CompletableFuture<GetRasterDataCollectionResponse> getRasterDataCollection(Consumer<GetRasterDataCollectionRequest.Builder> getRasterDataCollectionRequest)
Use this operation to get details of a specific raster data collection.
This is a convenience which creates an instance of the GetRasterDataCollectionRequest.Builder avoiding
the need to create one manually via GetRasterDataCollectionRequest.builder()
getRasterDataCollectionRequest - A Consumer that will call methods on GetRasterDataCollectionInput.Builder to create a
request.default <ReturnT> CompletableFuture<ReturnT> getTile(GetTileRequest getTileRequest, AsyncResponseTransformer<GetTileResponse,ReturnT> asyncResponseTransformer)
Gets a web mercator tile for the given Earth Observation job.
getTileRequest - 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 output binary file.
'.default <ReturnT> CompletableFuture<ReturnT> getTile(Consumer<GetTileRequest.Builder> getTileRequest, AsyncResponseTransformer<GetTileResponse,ReturnT> asyncResponseTransformer)
Gets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the GetTileRequest.Builder avoiding the need to create
one manually via GetTileRequest.builder()
getTileRequest - A Consumer that will call methods on GetTileInput.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 output binary file.
'.default CompletableFuture<GetTileResponse> getTile(GetTileRequest getTileRequest, Path destinationPath)
Gets a web mercator tile for the given Earth Observation job.
getTileRequest - 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 output binary file.
'.default CompletableFuture<GetTileResponse> getTile(Consumer<GetTileRequest.Builder> getTileRequest, Path destinationPath)
Gets a web mercator tile for the given Earth Observation job.
This is a convenience which creates an instance of the GetTileRequest.Builder avoiding the need to create
one manually via GetTileRequest.builder()
getTileRequest - A Consumer that will call methods on GetTileInput.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 output binary file.
'.default CompletableFuture<GetVectorEnrichmentJobResponse> getVectorEnrichmentJob(GetVectorEnrichmentJobRequest getVectorEnrichmentJobRequest)
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
getVectorEnrichmentJobRequest - default CompletableFuture<GetVectorEnrichmentJobResponse> getVectorEnrichmentJob(Consumer<GetVectorEnrichmentJobRequest.Builder> getVectorEnrichmentJobRequest)
Retrieves details of a Vector Enrichment Job for a given job Amazon Resource Name (ARN).
This is a convenience which creates an instance of the GetVectorEnrichmentJobRequest.Builder avoiding the
need to create one manually via GetVectorEnrichmentJobRequest.builder()
getVectorEnrichmentJobRequest - A Consumer that will call methods on GetVectorEnrichmentJobInput.Builder to create a
request.default CompletableFuture<ListEarthObservationJobsResponse> listEarthObservationJobs(ListEarthObservationJobsRequest listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
listEarthObservationJobsRequest - default CompletableFuture<ListEarthObservationJobsResponse> listEarthObservationJobs(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
This is a convenience which creates an instance of the ListEarthObservationJobsRequest.Builder avoiding
the need to create one manually via ListEarthObservationJobsRequest.builder()
listEarthObservationJobsRequest - A Consumer that will call methods on ListEarthObservationJobInput.Builder to create a
request.default ListEarthObservationJobsPublisher listEarthObservationJobsPaginator(ListEarthObservationJobsRequest listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
This is a variant of
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
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.sagemakergeospatial.paginators.ListEarthObservationJobsPublisher publisher = client.listEarthObservationJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsPublisher publisher = client.listEarthObservationJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse 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
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation.
listEarthObservationJobsRequest - default ListEarthObservationJobsPublisher listEarthObservationJobsPaginator(Consumer<ListEarthObservationJobsRequest.Builder> listEarthObservationJobsRequest)
Use this operation to get a list of the Earth Observation jobs associated with the calling Amazon Web Services account.
This is a variant of
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
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.sagemakergeospatial.paginators.ListEarthObservationJobsPublisher publisher = client.listEarthObservationJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListEarthObservationJobsPublisher publisher = client.listEarthObservationJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsResponse 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
listEarthObservationJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListEarthObservationJobsRequest)
operation.
This is a convenience which creates an instance of the ListEarthObservationJobsRequest.Builder avoiding
the need to create one manually via ListEarthObservationJobsRequest.builder()
listEarthObservationJobsRequest - A Consumer that will call methods on ListEarthObservationJobInput.Builder to create a
request.default CompletableFuture<ListRasterDataCollectionsResponse> listRasterDataCollections(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
listRasterDataCollectionsRequest - default CompletableFuture<ListRasterDataCollectionsResponse> listRasterDataCollections(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
This is a convenience which creates an instance of the ListRasterDataCollectionsRequest.Builder avoiding
the need to create one manually via ListRasterDataCollectionsRequest.builder()
listRasterDataCollectionsRequest - A Consumer that will call methods on ListRasterDataCollectionsInput.Builder to create a
request.default ListRasterDataCollectionsPublisher listRasterDataCollectionsPaginator(ListRasterDataCollectionsRequest listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
This is a variant of
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
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.sagemakergeospatial.paginators.ListRasterDataCollectionsPublisher publisher = client.listRasterDataCollectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsPublisher publisher = client.listRasterDataCollectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse 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
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation.
listRasterDataCollectionsRequest - default ListRasterDataCollectionsPublisher listRasterDataCollectionsPaginator(Consumer<ListRasterDataCollectionsRequest.Builder> listRasterDataCollectionsRequest)
Use this operation to get raster data collections.
This is a variant of
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
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.sagemakergeospatial.paginators.ListRasterDataCollectionsPublisher publisher = client.listRasterDataCollectionsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListRasterDataCollectionsPublisher publisher = client.listRasterDataCollectionsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsResponse 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
listRasterDataCollections(software.amazon.awssdk.services.sagemakergeospatial.model.ListRasterDataCollectionsRequest)
operation.
This is a convenience which creates an instance of the ListRasterDataCollectionsRequest.Builder avoiding
the need to create one manually via ListRasterDataCollectionsRequest.builder()
listRasterDataCollectionsRequest - A Consumer that will call methods on ListRasterDataCollectionsInput.Builder to create a
request.default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(ListTagsForResourceRequest listTagsForResourceRequest)
Lists the tags attached to the resource.
listTagsForResourceRequest - default CompletableFuture<ListTagsForResourceResponse> listTagsForResource(Consumer<ListTagsForResourceRequest.Builder> listTagsForResourceRequest)
Lists the tags attached to the 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<ListVectorEnrichmentJobsResponse> listVectorEnrichmentJobs(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
listVectorEnrichmentJobsRequest - default CompletableFuture<ListVectorEnrichmentJobsResponse> listVectorEnrichmentJobs(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
This is a convenience which creates an instance of the ListVectorEnrichmentJobsRequest.Builder avoiding
the need to create one manually via ListVectorEnrichmentJobsRequest.builder()
listVectorEnrichmentJobsRequest - A Consumer that will call methods on ListVectorEnrichmentJobInput.Builder to create a
request.default ListVectorEnrichmentJobsPublisher listVectorEnrichmentJobsPaginator(ListVectorEnrichmentJobsRequest listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
This is a variant of
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
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.sagemakergeospatial.paginators.ListVectorEnrichmentJobsPublisher publisher = client.listVectorEnrichmentJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsPublisher publisher = client.listVectorEnrichmentJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse 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
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation.
listVectorEnrichmentJobsRequest - default ListVectorEnrichmentJobsPublisher listVectorEnrichmentJobsPaginator(Consumer<ListVectorEnrichmentJobsRequest.Builder> listVectorEnrichmentJobsRequest)
Retrieves a list of vector enrichment jobs.
This is a variant of
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
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.sagemakergeospatial.paginators.ListVectorEnrichmentJobsPublisher publisher = client.listVectorEnrichmentJobsPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sagemakergeospatial.paginators.ListVectorEnrichmentJobsPublisher publisher = client.listVectorEnrichmentJobsPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsResponse 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
listVectorEnrichmentJobs(software.amazon.awssdk.services.sagemakergeospatial.model.ListVectorEnrichmentJobsRequest)
operation.
This is a convenience which creates an instance of the ListVectorEnrichmentJobsRequest.Builder avoiding
the need to create one manually via ListVectorEnrichmentJobsRequest.builder()
listVectorEnrichmentJobsRequest - A Consumer that will call methods on ListVectorEnrichmentJobInput.Builder to create a
request.default CompletableFuture<SearchRasterDataCollectionResponse> searchRasterDataCollection(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
searchRasterDataCollectionRequest - default CompletableFuture<SearchRasterDataCollectionResponse> searchRasterDataCollection(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
This is a convenience which creates an instance of the SearchRasterDataCollectionRequest.Builder avoiding
the need to create one manually via SearchRasterDataCollectionRequest.builder()
searchRasterDataCollectionRequest - A Consumer that will call methods on SearchRasterDataCollectionInput.Builder to create a
request.default SearchRasterDataCollectionPublisher searchRasterDataCollectionPaginator(SearchRasterDataCollectionRequest searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
This is a variant of
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
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.sagemakergeospatial.paginators.SearchRasterDataCollectionPublisher publisher = client.searchRasterDataCollectionPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionPublisher publisher = client.searchRasterDataCollectionPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse 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 null 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
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation.
searchRasterDataCollectionRequest - default SearchRasterDataCollectionPublisher searchRasterDataCollectionPaginator(Consumer<SearchRasterDataCollectionRequest.Builder> searchRasterDataCollectionRequest)
Allows you run image query on a specific raster data collection to get a list of the satellite imagery matching the selected filters.
This is a variant of
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
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.sagemakergeospatial.paginators.SearchRasterDataCollectionPublisher publisher = client.searchRasterDataCollectionPaginator(request);
CompletableFuture<Void> future = publisher.subscribe(res -> { // Do something with the response });
future.get();
2) Using a custom subscriber
software.amazon.awssdk.services.sagemakergeospatial.paginators.SearchRasterDataCollectionPublisher publisher = client.searchRasterDataCollectionPaginator(request);
publisher.subscribe(new Subscriber<software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse>() {
public void onSubscribe(org.reactivestreams.Subscriber subscription) { //... };
public void onNext(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionResponse 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 null 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
searchRasterDataCollection(software.amazon.awssdk.services.sagemakergeospatial.model.SearchRasterDataCollectionRequest)
operation.
This is a convenience which creates an instance of the SearchRasterDataCollectionRequest.Builder avoiding
the need to create one manually via SearchRasterDataCollectionRequest.builder()
searchRasterDataCollectionRequest - A Consumer that will call methods on SearchRasterDataCollectionInput.Builder to create a
request.default CompletableFuture<StartEarthObservationJobResponse> startEarthObservationJob(StartEarthObservationJobRequest startEarthObservationJobRequest)
Use this operation to create an Earth observation job.
startEarthObservationJobRequest - default CompletableFuture<StartEarthObservationJobResponse> startEarthObservationJob(Consumer<StartEarthObservationJobRequest.Builder> startEarthObservationJobRequest)
Use this operation to create an Earth observation job.
This is a convenience which creates an instance of the StartEarthObservationJobRequest.Builder avoiding
the need to create one manually via StartEarthObservationJobRequest.builder()
startEarthObservationJobRequest - A Consumer that will call methods on StartEarthObservationJobInput.Builder to create a
request.default CompletableFuture<StartVectorEnrichmentJobResponse> startVectorEnrichmentJob(StartVectorEnrichmentJobRequest startVectorEnrichmentJobRequest)
Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
startVectorEnrichmentJobRequest - default CompletableFuture<StartVectorEnrichmentJobResponse> startVectorEnrichmentJob(Consumer<StartVectorEnrichmentJobRequest.Builder> startVectorEnrichmentJobRequest)
Creates a Vector Enrichment job for the supplied job type. Currently, there are two supported job types: reverse geocoding and map matching.
This is a convenience which creates an instance of the StartVectorEnrichmentJobRequest.Builder avoiding
the need to create one manually via StartVectorEnrichmentJobRequest.builder()
startVectorEnrichmentJobRequest - A Consumer that will call methods on StartVectorEnrichmentJobInput.Builder to create a
request.default CompletableFuture<StopEarthObservationJobResponse> stopEarthObservationJob(StopEarthObservationJobRequest stopEarthObservationJobRequest)
Use this operation to stop an existing earth observation job.
stopEarthObservationJobRequest - default CompletableFuture<StopEarthObservationJobResponse> stopEarthObservationJob(Consumer<StopEarthObservationJobRequest.Builder> stopEarthObservationJobRequest)
Use this operation to stop an existing earth observation job.
This is a convenience which creates an instance of the StopEarthObservationJobRequest.Builder avoiding
the need to create one manually via StopEarthObservationJobRequest.builder()
stopEarthObservationJobRequest - A Consumer that will call methods on StopEarthObservationJobInput.Builder to create a
request.default CompletableFuture<StopVectorEnrichmentJobResponse> stopVectorEnrichmentJob(StopVectorEnrichmentJobRequest stopVectorEnrichmentJobRequest)
Stops the Vector Enrichment job for a given job ARN.
stopVectorEnrichmentJobRequest - default CompletableFuture<StopVectorEnrichmentJobResponse> stopVectorEnrichmentJob(Consumer<StopVectorEnrichmentJobRequest.Builder> stopVectorEnrichmentJobRequest)
Stops the Vector Enrichment job for a given job ARN.
This is a convenience which creates an instance of the StopVectorEnrichmentJobRequest.Builder avoiding
the need to create one manually via StopVectorEnrichmentJobRequest.builder()
stopVectorEnrichmentJobRequest - A Consumer that will call methods on StopVectorEnrichmentJobInput.Builder to create a
request.default CompletableFuture<TagResourceResponse> tagResource(TagResourceRequest tagResourceRequest)
The resource you want to tag.
tagResourceRequest - default CompletableFuture<TagResourceResponse> tagResource(Consumer<TagResourceRequest.Builder> tagResourceRequest)
The resource you want to tag.
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)
The resource you want to untag.
untagResourceRequest - default CompletableFuture<UntagResourceResponse> untagResource(Consumer<UntagResourceRequest.Builder> untagResourceRequest)
The resource you want to untag.
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 SageMakerGeospatialServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientstatic SageMakerGeospatialAsyncClient create()
SageMakerGeospatialAsyncClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static SageMakerGeospatialAsyncClientBuilder builder()
SageMakerGeospatialAsyncClient.Copyright © 2023. All rights reserved.