@Generated(value="software.amazon.awssdk:codegen") @ThreadSafe public interface BackupStorageClient extends AwsClient
builder() method.
The frontend service for Cryo Storage.| 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 BackupStorageClientBuilder |
builder()
Create a builder that can be used to configure and create a
BackupStorageClient. |
static BackupStorageClient |
create()
Create a
BackupStorageClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider. |
default DeleteObjectResponse |
deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)
Delete Object from the incremental base Backup.
|
default DeleteObjectResponse |
deleteObject(DeleteObjectRequest deleteObjectRequest)
Delete Object from the incremental base Backup.
|
default ResponseInputStream<GetChunkResponse> |
getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest)
Gets the specified object's chunk.
|
default GetChunkResponse |
getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest,
Path destinationPath)
Gets the specified object's chunk.
|
default <ReturnT> ReturnT |
getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest,
ResponseTransformer<GetChunkResponse,ReturnT> responseTransformer)
Gets the specified object's chunk.
|
default ResponseInputStream<GetChunkResponse> |
getChunk(GetChunkRequest getChunkRequest)
Gets the specified object's chunk.
|
default GetChunkResponse |
getChunk(GetChunkRequest getChunkRequest,
Path destinationPath)
Gets the specified object's chunk.
|
default <ReturnT> ReturnT |
getChunk(GetChunkRequest getChunkRequest,
ResponseTransformer<GetChunkResponse,ReturnT> responseTransformer)
Gets the specified object's chunk.
|
default ResponseBytes<GetChunkResponse> |
getChunkAsBytes(Consumer<GetChunkRequest.Builder> getChunkRequest)
Gets the specified object's chunk.
|
default ResponseBytes<GetChunkResponse> |
getChunkAsBytes(GetChunkRequest getChunkRequest)
Gets the specified object's chunk.
|
default ResponseInputStream<GetObjectMetadataResponse> |
getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest)
Get metadata associated with an Object.
|
default GetObjectMetadataResponse |
getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest,
Path destinationPath)
Get metadata associated with an Object.
|
default <ReturnT> ReturnT |
getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest,
ResponseTransformer<GetObjectMetadataResponse,ReturnT> responseTransformer)
Get metadata associated with an Object.
|
default ResponseInputStream<GetObjectMetadataResponse> |
getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest)
Get metadata associated with an Object.
|
default GetObjectMetadataResponse |
getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest,
Path destinationPath)
Get metadata associated with an Object.
|
default <ReturnT> ReturnT |
getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest,
ResponseTransformer<GetObjectMetadataResponse,ReturnT> responseTransformer)
Get metadata associated with an Object.
|
default ResponseBytes<GetObjectMetadataResponse> |
getObjectMetadataAsBytes(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest)
Get metadata associated with an Object.
|
default ResponseBytes<GetObjectMetadataResponse> |
getObjectMetadataAsBytes(GetObjectMetadataRequest getObjectMetadataRequest)
Get metadata associated with an Object.
|
default ListChunksResponse |
listChunks(Consumer<ListChunksRequest.Builder> listChunksRequest)
List chunks in a given Object
|
default ListChunksResponse |
listChunks(ListChunksRequest listChunksRequest)
List chunks in a given Object
|
default ListChunksIterable |
listChunksPaginator(Consumer<ListChunksRequest.Builder> listChunksRequest)
List chunks in a given Object
|
default ListChunksIterable |
listChunksPaginator(ListChunksRequest listChunksRequest)
List chunks in a given Object
|
default ListObjectsResponse |
listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest)
List all Objects in a given Backup.
|
default ListObjectsResponse |
listObjects(ListObjectsRequest listObjectsRequest)
List all Objects in a given Backup.
|
default ListObjectsIterable |
listObjectsPaginator(Consumer<ListObjectsRequest.Builder> listObjectsRequest)
List all Objects in a given Backup.
|
default ListObjectsIterable |
listObjectsPaginator(ListObjectsRequest listObjectsRequest)
List all Objects in a given Backup.
|
default NotifyObjectCompleteResponse |
notifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest,
Path sourcePath)
Complete upload
|
default NotifyObjectCompleteResponse |
notifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest,
RequestBody requestBody)
Complete upload
|
default NotifyObjectCompleteResponse |
notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest,
Path sourcePath)
Complete upload
|
default NotifyObjectCompleteResponse |
notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest,
RequestBody requestBody)
Complete upload
|
default PutChunkResponse |
putChunk(Consumer<PutChunkRequest.Builder> putChunkRequest,
Path sourcePath)
Upload chunk.
|
default PutChunkResponse |
putChunk(Consumer<PutChunkRequest.Builder> putChunkRequest,
RequestBody requestBody)
Upload chunk.
|
default PutChunkResponse |
putChunk(PutChunkRequest putChunkRequest,
Path sourcePath)
Upload chunk.
|
default PutChunkResponse |
putChunk(PutChunkRequest putChunkRequest,
RequestBody requestBody)
Upload chunk.
|
default PutObjectResponse |
putObject(Consumer<PutObjectRequest.Builder> putObjectRequest,
Path sourcePath)
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
|
default PutObjectResponse |
putObject(Consumer<PutObjectRequest.Builder> putObjectRequest,
RequestBody requestBody)
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
|
default PutObjectResponse |
putObject(PutObjectRequest putObjectRequest,
Path sourcePath)
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
|
default PutObjectResponse |
putObject(PutObjectRequest putObjectRequest,
RequestBody requestBody)
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
|
default BackupStorageServiceClientConfiguration |
serviceClientConfiguration() |
static ServiceMetadata |
serviceMetadata() |
default StartObjectResponse |
startObject(Consumer<StartObjectRequest.Builder> startObjectRequest)
Start upload containing one or many chunks.
|
default StartObjectResponse |
startObject(StartObjectRequest startObjectRequest)
Start upload containing one or many chunks.
|
serviceNameclosestatic final String SERVICE_NAME
static final String SERVICE_METADATA_ID
ServiceMetadataProvider.default DeleteObjectResponse deleteObject(DeleteObjectRequest deleteObjectRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
deleteObjectRequest - ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault DeleteObjectResponse deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the DeleteObjectRequest.Builder avoiding the need to
create one manually via DeleteObjectRequest.builder()
deleteObjectRequest - A Consumer that will call methods on
DeleteObjectRequest.Builder to create a
request.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT getChunk(GetChunkRequest getChunkRequest, ResponseTransformer<GetChunkResponse,ReturnT> responseTransformer) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
getChunkRequest - responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetChunkResponse and
an InputStream to the response content are provided as parameters to the callback. The callback may return
a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows 'Chunk data'.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest, ResponseTransformer<GetChunkResponse,ReturnT> responseTransformer) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the GetChunkRequest.Builder avoiding the need to
create one manually via GetChunkRequest.builder()
getChunkRequest - A Consumer that will call methods on
GetChunkRequest.Builder to create a request.responseTransformer - Functional interface for processing the streamed response content. The unmarshalled GetChunkResponse and
an InputStream to the response content are provided as parameters to the callback. The callback may return
a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows 'Chunk data'.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetChunkResponse getChunk(GetChunkRequest getChunkRequest, Path destinationPath) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
getChunkRequest - 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 'Chunk data'.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetChunk(GetChunkRequest, ResponseTransformer),
AWS API
Documentationdefault GetChunkResponse getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest, Path destinationPath) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the GetChunkRequest.Builder avoiding the need to
create one manually via GetChunkRequest.builder()
getChunkRequest - A Consumer that will call methods on
GetChunkRequest.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 'Chunk data'.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetChunk(GetChunkRequest, ResponseTransformer),
AWS API
Documentationdefault ResponseInputStream<GetChunkResponse> getChunk(GetChunkRequest getChunkRequest) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
getChunkRequest - ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'Chunk data'.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getChunk, ResponseTransformer),
AWS API
Documentationdefault ResponseInputStream<GetChunkResponse> getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the GetChunkRequest.Builder avoiding the need to
create one manually via GetChunkRequest.builder()
getChunkRequest - A Consumer that will call methods on
GetChunkRequest.Builder to create a request.ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'Chunk data'.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getChunk, ResponseTransformer),
AWS API
Documentationdefault ResponseBytes<GetChunkResponse> getChunkAsBytes(GetChunkRequest getChunkRequest) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
getChunkRequest - ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows 'Chunk data'.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getChunk, ResponseTransformer),
AWS API
Documentationdefault ResponseBytes<GetChunkResponse> getChunkAsBytes(Consumer<GetChunkRequest.Builder> getChunkRequest) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the GetChunkRequest.Builder avoiding the need to
create one manually via GetChunkRequest.builder()
getChunkRequest - A Consumer that will call methods on
GetChunkRequest.Builder to create a request.ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows 'Chunk data'.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getChunk, ResponseTransformer),
AWS API
Documentationdefault <ReturnT> ReturnT getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest, ResponseTransformer<GetObjectMetadataResponse,ReturnT> responseTransformer) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
getObjectMetadataRequest - responseTransformer - Functional interface for processing the streamed response content. The unmarshalled
GetObjectMetadataResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows 'Metadata blob.'.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault <ReturnT> ReturnT getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest, ResponseTransformer<GetObjectMetadataResponse,ReturnT> responseTransformer) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the GetObjectMetadataRequest.Builder avoiding the need
to create one manually via GetObjectMetadataRequest.builder()
getObjectMetadataRequest - A Consumer that will call methods on
GetObjectMetadataRequest.Builder to create a
request.responseTransformer - Functional interface for processing the streamed response content. The unmarshalled
GetObjectMetadataResponse and an InputStream to the response content are provided as parameters to the
callback. The callback may return a transformed type which will be the return value of this method. See
ResponseTransformer for details on implementing this interface
and for links to pre-canned implementations for common scenarios like downloading to a file. The service
documentation for the response content is as follows 'Metadata blob.'.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault GetObjectMetadataResponse getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest, Path destinationPath) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
getObjectMetadataRequest - 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 'Metadata blob.'.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetObjectMetadata(GetObjectMetadataRequest, ResponseTransformer),
AWS API Documentationdefault GetObjectMetadataResponse getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest, Path destinationPath) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the GetObjectMetadataRequest.Builder avoiding the need
to create one manually via GetObjectMetadataRequest.builder()
getObjectMetadataRequest - A Consumer that will call methods on
GetObjectMetadataRequest.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 'Metadata blob.'.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiongetObjectMetadata(GetObjectMetadataRequest, ResponseTransformer),
AWS API Documentationdefault ResponseInputStream<GetObjectMetadataResponse> getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
getObjectMetadataRequest - ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'Metadata blob.'.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getObjectMetadata, ResponseTransformer),
AWS API Documentationdefault ResponseInputStream<GetObjectMetadataResponse> getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the GetObjectMetadataRequest.Builder avoiding the need
to create one manually via GetObjectMetadataRequest.builder()
getObjectMetadataRequest - A Consumer that will call methods on
GetObjectMetadataRequest.Builder to create a
request.ResponseInputStream containing data streamed from service. Note that this is an unmanaged
reference to the underlying HTTP connection so great care must be taken to ensure all data if fully read
from the input stream and that it is properly closed. Failure to do so may result in sub-optimal behavior
and exhausting connections in the connection pool. The unmarshalled response object can be obtained via
ResponseInputStream.response(). The service documentation for the response content is as follows
'Metadata blob.'.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getObjectMetadata, ResponseTransformer),
AWS API Documentationdefault ResponseBytes<GetObjectMetadataResponse> getObjectMetadataAsBytes(GetObjectMetadataRequest getObjectMetadataRequest) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
getObjectMetadataRequest - ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows 'Metadata blob.'.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getObjectMetadata, ResponseTransformer),
AWS API Documentationdefault ResponseBytes<GetObjectMetadataResponse> getObjectMetadataAsBytes(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the GetObjectMetadataRequest.Builder avoiding the need
to create one manually via GetObjectMetadataRequest.builder()
getObjectMetadataRequest - A Consumer that will call methods on
GetObjectMetadataRequest.Builder to create a
request.ResponseBytes that loads the data streamed from the service into memory and exposes it in
convenient in-memory representations like a byte buffer or string. The unmarshalled response object can
be obtained via ResponseBytes.response(). The service documentation for the response content is
as follows 'Metadata blob.'.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceException#getObject(getObjectMetadata, ResponseTransformer),
AWS API Documentationdefault ListChunksResponse listChunks(ListChunksRequest listChunksRequest) throws ServiceUnavailableException, ResourceNotFoundException, ServiceInternalException, RetryableException, IllegalArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
listChunksRequest - ServiceUnavailableException - Retryable exception, indicates internal server error.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChunksResponse listChunks(Consumer<ListChunksRequest.Builder> listChunksRequest) throws ServiceUnavailableException, ResourceNotFoundException, ServiceInternalException, RetryableException, IllegalArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the ListChunksRequest.Builder avoiding the need to
create one manually via ListChunksRequest.builder()
listChunksRequest - A Consumer that will call methods on
ListChunksRequest.Builder to create a request.ServiceUnavailableException - Retryable exception, indicates internal server error.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChunksIterable listChunksPaginator(ListChunksRequest listChunksRequest) throws ServiceUnavailableException, ResourceNotFoundException, ServiceInternalException, RetryableException, IllegalArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a variant of listChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupstorage.paginators.ListChunksIterable responses = client.listChunksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupstorage.paginators.ListChunksIterable responses = client.listChunksPaginator(request);
for (software.amazon.awssdk.services.backupstorage.model.ListChunksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupstorage.paginators.ListChunksIterable responses = client.listChunksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest) operation.
listChunksRequest - ServiceUnavailableException - Retryable exception, indicates internal server error.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListChunksIterable listChunksPaginator(Consumer<ListChunksRequest.Builder> listChunksRequest) throws ServiceUnavailableException, ResourceNotFoundException, ServiceInternalException, RetryableException, IllegalArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a variant of listChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupstorage.paginators.ListChunksIterable responses = client.listChunksPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupstorage.paginators.ListChunksIterable responses = client.listChunksPaginator(request);
for (software.amazon.awssdk.services.backupstorage.model.ListChunksResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupstorage.paginators.ListChunksIterable responses = client.listChunksPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest) operation.
This is a convenience which creates an instance of the ListChunksRequest.Builder avoiding the need to
create one manually via ListChunksRequest.builder()
listChunksRequest - A Consumer that will call methods on
ListChunksRequest.Builder to create a request.ServiceUnavailableException - Retryable exception, indicates internal server error.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListObjectsResponse listObjects(ListObjectsRequest listObjectsRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ThrottlingException, ResourceNotFoundException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
listObjectsRequest - ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListObjectsResponse listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ThrottlingException, ResourceNotFoundException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the ListObjectsRequest.Builder avoiding the need to
create one manually via ListObjectsRequest.builder()
listObjectsRequest - A Consumer that will call methods on
ListObjectsRequest.Builder to create a
request.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListObjectsIterable listObjectsPaginator(ListObjectsRequest listObjectsRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ThrottlingException, ResourceNotFoundException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a variant of listObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupstorage.paginators.ListObjectsIterable responses = client.listObjectsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupstorage.paginators.ListObjectsIterable responses = client.listObjectsPaginator(request);
for (software.amazon.awssdk.services.backupstorage.model.ListObjectsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupstorage.paginators.ListObjectsIterable responses = client.listObjectsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest) operation.
listObjectsRequest - ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault ListObjectsIterable listObjectsPaginator(Consumer<ListObjectsRequest.Builder> listObjectsRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ThrottlingException, ResourceNotFoundException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a variant of listObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest)
operation. The return type is a custom iterable that can be used to iterate through all the pages. SDK will
internally handle making service calls for you.
When this operation is called, a custom iterable is returned but no service calls are made yet. So there is no guarantee that the request is valid. As you iterate through the iterable, SDK will start lazily loading response pages by making service calls until there are no pages left or your iteration stops. If there are errors in your request, you will see the failures only after you start iterating through the iterable.
The following are few ways to iterate through the response pages:
1) Using a Stream
software.amazon.awssdk.services.backupstorage.paginators.ListObjectsIterable responses = client.listObjectsPaginator(request);
responses.stream().forEach(....);
2) Using For loop
{
@code
software.amazon.awssdk.services.backupstorage.paginators.ListObjectsIterable responses = client.listObjectsPaginator(request);
for (software.amazon.awssdk.services.backupstorage.model.ListObjectsResponse response : responses) {
// do something;
}
}
3) Use iterator directly
software.amazon.awssdk.services.backupstorage.paginators.ListObjectsIterable responses = client.listObjectsPaginator(request);
responses.iterator().forEachRemaining(....);
Please notice that the configuration of MaxResults won't limit the number of results you get with the paginator. It only limits the number of results in each page.
Note: If you prefer to have control on service calls, use the
listObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest) operation.
This is a convenience which creates an instance of the ListObjectsRequest.Builder avoiding the need to
create one manually via ListObjectsRequest.builder()
listObjectsRequest - A Consumer that will call methods on
ListObjectsRequest.Builder to create a
request.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault NotifyObjectCompleteResponse notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
notifyObjectCompleteRequest - requestBody - The content to send to the service. A RequestBody can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody for additional details and which sources of data are supported.
The service documentation for the request content is as follows 'Optional metadata associated with an
Object. Maximum length is 4MB.'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault NotifyObjectCompleteResponse notifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the NotifyObjectCompleteRequest.Builder avoiding the
need to create one manually via NotifyObjectCompleteRequest.builder()
notifyObjectCompleteRequest - A Consumer that will call methods on
NotifyObjectCompleteRequest.Builder to create
a request.requestBody - The content to send to the service. A RequestBody can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody for additional details and which sources of data are supported.
The service documentation for the request content is as follows 'Optional metadata associated with an
Object. Maximum length is 4MB.'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault NotifyObjectCompleteResponse notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
notifyObjectCompleteRequest - sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows 'Optional metadata associated with an Object. Maximum length is 4MB.'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionnotifyObjectComplete(NotifyObjectCompleteRequest, RequestBody),
AWS API Documentationdefault NotifyObjectCompleteResponse notifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the NotifyObjectCompleteRequest.Builder avoiding the
need to create one manually via NotifyObjectCompleteRequest.builder()
notifyObjectCompleteRequest - A Consumer that will call methods on
NotifyObjectCompleteRequest.Builder to create
a request.sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows 'Optional metadata associated with an Object. Maximum length is 4MB.'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionnotifyObjectComplete(NotifyObjectCompleteRequest, RequestBody),
AWS API Documentationdefault PutChunkResponse putChunk(PutChunkRequest putChunkRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
putChunkRequest - requestBody - The content to send to the service. A RequestBody can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody for additional details and which sources of data are supported.
The service documentation for the request content is as follows 'Data to be uploaded'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutChunkResponse putChunk(Consumer<PutChunkRequest.Builder> putChunkRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the PutChunkRequest.Builder avoiding the need to
create one manually via PutChunkRequest.builder()
putChunkRequest - A Consumer that will call methods on
PutChunkRequest.Builder to create a request.requestBody - The content to send to the service. A RequestBody can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody for additional details and which sources of data are supported.
The service documentation for the request content is as follows 'Data to be uploaded'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutChunkResponse putChunk(PutChunkRequest putChunkRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
putChunkRequest - sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows 'Data to be uploaded'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionputChunk(PutChunkRequest, RequestBody),
AWS API
Documentationdefault PutChunkResponse putChunk(Consumer<PutChunkRequest.Builder> putChunkRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the PutChunkRequest.Builder avoiding the need to
create one manually via PutChunkRequest.builder()
putChunkRequest - A Consumer that will call methods on
PutChunkRequest.Builder to create a request.sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows 'Data to be uploaded'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionputChunk(PutChunkRequest, RequestBody),
AWS API
Documentationdefault PutObjectResponse putObject(PutObjectRequest putObjectRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
putObjectRequest - requestBody - The content to send to the service. A RequestBody can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody for additional details and which sources of data are supported.
The service documentation for the request content is as follows 'Inline chunk data to be uploaded.'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutObjectResponse putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the PutObjectRequest.Builder avoiding the need to
create one manually via PutObjectRequest.builder()
putObjectRequest - A Consumer that will call methods on
PutObjectRequest.Builder to create a request.requestBody - The content to send to the service. A RequestBody can be created using one of several factory
methods for various sources of data. For example, to create a request body from a file you can do the
following.
RequestBody.fromFile(new File("myfile.txt"))
See documentation in RequestBody for additional details and which sources of data are supported.
The service documentation for the request content is as follows 'Inline chunk data to be uploaded.'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault PutObjectResponse putObject(PutObjectRequest putObjectRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
putObjectRequest - sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows 'Inline chunk data to be uploaded.'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionputObject(PutObjectRequest, RequestBody),
AWS API
Documentationdefault PutObjectResponse putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the PutObjectRequest.Builder avoiding the need to
create one manually via PutObjectRequest.builder()
putObjectRequest - A Consumer that will call methods on
PutObjectRequest.Builder to create a request.sourcePath - Path to file containing data to send to the service. File will be read entirely and may be read
multiple times in the event of a retry. If the file does not exist or the current user does not have
access to read it then an exception will be thrown. The service documentation for the request content is
as follows 'Inline chunk data to be uploaded.'ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.NotReadableInputStreamException - Retryalble exception. Indicated issues while reading an input stream due to the networking issues or
connection drop on the client side.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.KmsInvalidKeyUsageException - Non-retryable exception. Indicates the KMS key usage is incorrect. See exception message for details.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionputObject(PutObjectRequest, RequestBody),
AWS API
Documentationdefault StartObjectResponse startObject(StartObjectRequest startObjectRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ResourceNotFoundException, DataAlreadyExistsException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
startObjectRequest - ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.DataAlreadyExistsException - Non-retryable exception. Attempted to create already existing object or chunk. This message contains a
checksum of already presented data.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptiondefault StartObjectResponse startObject(Consumer<StartObjectRequest.Builder> startObjectRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ResourceNotFoundException, DataAlreadyExistsException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
This is a convenience which creates an instance of the StartObjectRequest.Builder avoiding the need to
create one manually via StartObjectRequest.builder()
startObjectRequest - A Consumer that will call methods on
StartObjectRequest.Builder to create a
request.ServiceUnavailableException - Retryable exception, indicates internal server error.ServiceInternalException - Deprecated. To be removed from the model.RetryableException - Retryable exception. In general indicates internal failure that can be fixed by retry.IllegalArgumentException - Non-retryable exception, indicates client error (wrong argument passed to API). See exception message for
details.ResourceNotFoundException - Non-retryable exception. Attempted to make an operation on non-existing or expired resource.DataAlreadyExistsException - Non-retryable exception. Attempted to create already existing object or chunk. This message contains a
checksum of already presented data.ThrottlingException - Increased rate over throttling limits. Can be retried with exponential backoff.AccessDeniedExceptionSdkException - Base class for all exceptions that can be thrown by the SDK (both service and client). Can be used for
catch all scenarios.SdkClientException - If any client side error occurs such as an IO related failure, failure to get credentials, etc.BackupStorageException - Base class for all service exceptions. Unknown exceptions will be thrown as an instance of this type.AwsServiceExceptionstatic BackupStorageClient create()
BackupStorageClient with the region loaded from the
DefaultAwsRegionProviderChain and credentials loaded from the
DefaultCredentialsProvider.static BackupStorageClientBuilder builder()
BackupStorageClient.static ServiceMetadata serviceMetadata()
default BackupStorageServiceClientConfiguration serviceClientConfiguration()
serviceClientConfiguration in interface AwsClientserviceClientConfiguration in interface SdkClientCopyright © 2023. All rights reserved.