Interface BackupStorageClient
-
- All Superinterfaces:
AutoCloseable,AwsClient,SdkAutoCloseable,SdkClient
@Generated("software.amazon.awssdk:codegen") @ThreadSafe public interface BackupStorageClient extends AwsClient
Service client for accessing AWS Backup Storage. This can be created using the staticbuilder()method. The frontend service for Cryo Storage.
-
-
Field Summary
Fields Modifier and Type Field Description static StringSERVICE_METADATA_IDValue for looking up the service's metadata from theServiceMetadataProvider.static StringSERVICE_NAME
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static BackupStorageClientBuilderbuilder()Create a builder that can be used to configure and create aBackupStorageClient.static BackupStorageClientcreate()Create aBackupStorageClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.default DeleteObjectResponsedeleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest)Delete Object from the incremental base Backup.default DeleteObjectResponsedeleteObject(DeleteObjectRequest deleteObjectRequest)Delete Object from the incremental base Backup.default ResponseInputStream<GetChunkResponse>getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest)Gets the specified object's chunk.default GetChunkResponsegetChunk(Consumer<GetChunkRequest.Builder> getChunkRequest, Path destinationPath)Gets the specified object's chunk.default <ReturnT> ReturnTgetChunk(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 GetChunkResponsegetChunk(GetChunkRequest getChunkRequest, Path destinationPath)Gets the specified object's chunk.default <ReturnT> ReturnTgetChunk(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 GetObjectMetadataResponsegetObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest, Path destinationPath)Get metadata associated with an Object.default <ReturnT> ReturnTgetObjectMetadata(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 GetObjectMetadataResponsegetObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest, Path destinationPath)Get metadata associated with an Object.default <ReturnT> ReturnTgetObjectMetadata(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 ListChunksResponselistChunks(Consumer<ListChunksRequest.Builder> listChunksRequest)List chunks in a given Objectdefault ListChunksResponselistChunks(ListChunksRequest listChunksRequest)List chunks in a given Objectdefault ListChunksIterablelistChunksPaginator(Consumer<ListChunksRequest.Builder> listChunksRequest)This is a variant oflistChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest)operation.default ListChunksIterablelistChunksPaginator(ListChunksRequest listChunksRequest)This is a variant oflistChunks(software.amazon.awssdk.services.backupstorage.model.ListChunksRequest)operation.default ListObjectsResponselistObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest)List all Objects in a given Backup.default ListObjectsResponselistObjects(ListObjectsRequest listObjectsRequest)List all Objects in a given Backup.default ListObjectsIterablelistObjectsPaginator(Consumer<ListObjectsRequest.Builder> listObjectsRequest)This is a variant oflistObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest)operation.default ListObjectsIterablelistObjectsPaginator(ListObjectsRequest listObjectsRequest)This is a variant oflistObjects(software.amazon.awssdk.services.backupstorage.model.ListObjectsRequest)operation.default NotifyObjectCompleteResponsenotifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest, Path sourcePath)Complete uploaddefault NotifyObjectCompleteResponsenotifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest, RequestBody requestBody)Complete uploaddefault NotifyObjectCompleteResponsenotifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest, Path sourcePath)Complete uploaddefault NotifyObjectCompleteResponsenotifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest, RequestBody requestBody)Complete uploaddefault PutChunkResponseputChunk(Consumer<PutChunkRequest.Builder> putChunkRequest, Path sourcePath)Upload chunk.default PutChunkResponseputChunk(Consumer<PutChunkRequest.Builder> putChunkRequest, RequestBody requestBody)Upload chunk.default PutChunkResponseputChunk(PutChunkRequest putChunkRequest, Path sourcePath)Upload chunk.default PutChunkResponseputChunk(PutChunkRequest putChunkRequest, RequestBody requestBody)Upload chunk.default PutObjectResponseputObject(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 PutObjectResponseputObject(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 PutObjectResponseputObject(PutObjectRequest putObjectRequest, Path sourcePath)Upload object that can store object metadata String and data blob in single API call using inline chunk field.default PutObjectResponseputObject(PutObjectRequest putObjectRequest, RequestBody requestBody)Upload object that can store object metadata String and data blob in single API call using inline chunk field.default BackupStorageServiceClientConfigurationserviceClientConfiguration()static ServiceMetadataserviceMetadata()default StartObjectResponsestartObject(Consumer<StartObjectRequest.Builder> startObjectRequest)Start upload containing one or many chunks.default StartObjectResponsestartObject(StartObjectRequest startObjectRequest)Start upload containing one or many chunks.-
Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable
close
-
Methods inherited from interface software.amazon.awssdk.core.SdkClient
serviceName
-
-
-
-
Field Detail
-
SERVICE_NAME
static final String SERVICE_NAME
- See Also:
- Constant Field Values
-
SERVICE_METADATA_ID
static final String SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider.- See Also:
- Constant Field Values
-
-
Method Detail
-
deleteObject
default DeleteObjectResponse deleteObject(DeleteObjectRequest deleteObjectRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Delete Object from the incremental base Backup.- Parameters:
deleteObjectRequest-- Returns:
- Result of the DeleteObject operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
deleteObject
default DeleteObjectResponse deleteObject(Consumer<DeleteObjectRequest.Builder> deleteObjectRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ResourceNotFoundException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Delete Object from the incremental base Backup.
This is a convenience which creates an instance of the
DeleteObjectRequest.Builderavoiding the need to create one manually viaDeleteObjectRequest.builder()- Parameters:
deleteObjectRequest- AConsumerthat will call methods onDeleteObjectRequest.Builderto create a request.- Returns:
- Result of the DeleteObject operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
getChunk
default <ReturnT> ReturnT getChunk(GetChunkRequest getChunkRequest, ResponseTransformer<GetChunkResponse,ReturnT> responseTransformer) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Gets the specified object's chunk.- Parameters:
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. SeeResponseTransformerfor 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'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
- AWS API Documentation
-
getChunk
default <ReturnT> ReturnT getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest, ResponseTransformer<GetChunkResponse,ReturnT> responseTransformer) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Gets the specified object's chunk.
This is a convenience which creates an instance of the
GetChunkRequest.Builderavoiding the need to create one manually viaGetChunkRequest.builder()- Parameters:
getChunkRequest- AConsumerthat will call methods onGetChunkRequest.Builderto 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. SeeResponseTransformerfor 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'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
- AWS API Documentation
-
getChunk
default GetChunkResponse getChunk(GetChunkRequest getChunkRequest, Path destinationPath) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Gets the specified object's chunk.- Parameters:
getChunkRequest-destinationPath-Pathto 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'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
getChunk(GetChunkRequest, ResponseTransformer), AWS API Documentation
-
getChunk
default GetChunkResponse getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest, Path destinationPath) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Gets the specified object's chunk.
This is a convenience which creates an instance of the
GetChunkRequest.Builderavoiding the need to create one manually viaGetChunkRequest.builder()- Parameters:
getChunkRequest- AConsumerthat will call methods onGetChunkRequest.Builderto create a request.destinationPath-Pathto 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'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
getChunk(GetChunkRequest, ResponseTransformer), AWS API Documentation
-
getChunk
default ResponseInputStream<GetChunkResponse> getChunk(GetChunkRequest getChunkRequest) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Gets the specified object's chunk.- Parameters:
getChunkRequest-- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'Chunk data'. - Throws:
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- See Also:
#getObject(getChunk, ResponseTransformer), AWS API Documentation
-
getChunk
default ResponseInputStream<GetChunkResponse> getChunk(Consumer<GetChunkRequest.Builder> getChunkRequest) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Gets the specified object's chunk.
This is a convenience which creates an instance of the
GetChunkRequest.Builderavoiding the need to create one manually viaGetChunkRequest.builder()- Parameters:
getChunkRequest- AConsumerthat will call methods onGetChunkRequest.Builderto create a request.- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'Chunk data'. - Throws:
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- See Also:
#getObject(getChunk, ResponseTransformer), AWS API Documentation
-
getChunkAsBytes
default ResponseBytes<GetChunkResponse> getChunkAsBytes(GetChunkRequest getChunkRequest) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Gets the specified object's chunk.- Parameters:
getChunkRequest-- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'Chunk data'. - Throws:
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- See Also:
#getObject(getChunk, ResponseTransformer), AWS API Documentation
-
getChunkAsBytes
default ResponseBytes<GetChunkResponse> getChunkAsBytes(Consumer<GetChunkRequest.Builder> getChunkRequest) throws IllegalArgumentException, RetryableException, ResourceNotFoundException, ServiceInternalException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Gets the specified object's chunk.
This is a convenience which creates an instance of the
GetChunkRequest.Builderavoiding the need to create one manually viaGetChunkRequest.builder()- Parameters:
getChunkRequest- AConsumerthat will call methods onGetChunkRequest.Builderto create a request.- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'Chunk data'. - Throws:
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- See Also:
#getObject(getChunk, ResponseTransformer), AWS API Documentation
-
getObjectMetadata
default <ReturnT> ReturnT getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest, ResponseTransformer<GetObjectMetadataResponse,ReturnT> responseTransformer) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Get metadata associated with an Object.- Parameters:
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. SeeResponseTransformerfor 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.'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
- AWS API Documentation
-
getObjectMetadata
default <ReturnT> ReturnT getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest, ResponseTransformer<GetObjectMetadataResponse,ReturnT> responseTransformer) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Get metadata associated with an Object.
This is a convenience which creates an instance of the
GetObjectMetadataRequest.Builderavoiding the need to create one manually viaGetObjectMetadataRequest.builder()- Parameters:
getObjectMetadataRequest- AConsumerthat will call methods onGetObjectMetadataRequest.Builderto 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. SeeResponseTransformerfor 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.'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
- AWS API Documentation
-
getObjectMetadata
default GetObjectMetadataResponse getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest, Path destinationPath) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Get metadata associated with an Object.- Parameters:
getObjectMetadataRequest-destinationPath-Pathto 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.'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
getObjectMetadata(GetObjectMetadataRequest, ResponseTransformer), AWS API Documentation
-
getObjectMetadata
default GetObjectMetadataResponse getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest, Path destinationPath) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Get metadata associated with an Object.
This is a convenience which creates an instance of the
GetObjectMetadataRequest.Builderavoiding the need to create one manually viaGetObjectMetadataRequest.builder()- Parameters:
getObjectMetadataRequest- AConsumerthat will call methods onGetObjectMetadataRequest.Builderto create a request.destinationPath-Pathto 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.'.- Returns:
- The transformed result of the ResponseTransformer.
- Throws:
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- See Also:
getObjectMetadata(GetObjectMetadataRequest, ResponseTransformer), AWS API Documentation
-
getObjectMetadata
default ResponseInputStream<GetObjectMetadataResponse> getObjectMetadata(GetObjectMetadataRequest getObjectMetadataRequest) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Get metadata associated with an Object.- Parameters:
getObjectMetadataRequest-- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'Metadata blob.'. - Throws:
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- See Also:
#getObject(getObjectMetadata, ResponseTransformer), AWS API Documentation
-
getObjectMetadata
default ResponseInputStream<GetObjectMetadataResponse> getObjectMetadata(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Get metadata associated with an Object.
This is a convenience which creates an instance of the
GetObjectMetadataRequest.Builderavoiding the need to create one manually viaGetObjectMetadataRequest.builder()- Parameters:
getObjectMetadataRequest- AConsumerthat will call methods onGetObjectMetadataRequest.Builderto create a request.- Returns:
- A
ResponseInputStreamcontaining 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 viaResponseInputStream.response(). The service documentation for the response content is as follows 'Metadata blob.'. - Throws:
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- See Also:
#getObject(getObjectMetadata, ResponseTransformer), AWS API Documentation
-
getObjectMetadataAsBytes
default ResponseBytes<GetObjectMetadataResponse> getObjectMetadataAsBytes(GetObjectMetadataRequest getObjectMetadataRequest) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Get metadata associated with an Object.- Parameters:
getObjectMetadataRequest-- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'Metadata blob.'. - Throws:
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- See Also:
#getObject(getObjectMetadata, ResponseTransformer), AWS API Documentation
-
getObjectMetadataAsBytes
default ResponseBytes<GetObjectMetadataResponse> getObjectMetadataAsBytes(Consumer<GetObjectMetadataRequest.Builder> getObjectMetadataRequest) throws ServiceUnavailableException, ServiceInternalException, ResourceNotFoundException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Get metadata associated with an Object.
This is a convenience which creates an instance of the
GetObjectMetadataRequest.Builderavoiding the need to create one manually viaGetObjectMetadataRequest.builder()- Parameters:
getObjectMetadataRequest- AConsumerthat will call methods onGetObjectMetadataRequest.Builderto create a request.- Returns:
- A
ResponseBytesthat 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 viaResponseBytes.response(). The service documentation for the response content is as follows 'Metadata blob.'. - Throws:
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- See Also:
#getObject(getObjectMetadata, ResponseTransformer), AWS API Documentation
-
listChunks
default ListChunksResponse listChunks(ListChunksRequest listChunksRequest) throws ServiceUnavailableException, ResourceNotFoundException, ServiceInternalException, RetryableException, IllegalArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
List chunks in a given Object- Parameters:
listChunksRequest-- Returns:
- Result of the ListChunks operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listChunks
default ListChunksResponse listChunks(Consumer<ListChunksRequest.Builder> listChunksRequest) throws ServiceUnavailableException, ResourceNotFoundException, ServiceInternalException, RetryableException, IllegalArgumentException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
List chunks in a given Object
This is a convenience which creates an instance of the
ListChunksRequest.Builderavoiding the need to create one manually viaListChunksRequest.builder()- Parameters:
listChunksRequest- AConsumerthat will call methods onListChunksRequest.Builderto create a request.- Returns:
- Result of the ListChunks operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listChunksPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.backupstorage.paginators.ListChunksIterable responses = client.listChunksPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listChunksRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listChunksPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.backupstorage.paginators.ListChunksIterable responses = client.listChunksPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListChunksRequest.builder()- Parameters:
listChunksRequest- AConsumerthat will call methods onListChunksRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listObjects
default ListObjectsResponse listObjects(ListObjectsRequest listObjectsRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ThrottlingException, ResourceNotFoundException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
List all Objects in a given Backup.- Parameters:
listObjectsRequest-- Returns:
- Result of the ListObjects operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listObjects
default ListObjectsResponse listObjects(Consumer<ListObjectsRequest.Builder> listObjectsRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ThrottlingException, ResourceNotFoundException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
List all Objects in a given Backup.
This is a convenience which creates an instance of the
ListObjectsRequest.Builderavoiding the need to create one manually viaListObjectsRequest.builder()- Parameters:
listObjectsRequest- AConsumerthat will call methods onListObjectsRequest.Builderto create a request.- Returns:
- Result of the ListObjects operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listObjectsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.backupstorage.paginators.ListObjectsIterable responses = client.listObjectsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.- Parameters:
listObjectsRequest-- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
listObjectsPaginator
default 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
2) Using For loopsoftware.amazon.awssdk.services.backupstorage.paginators.ListObjectsIterable responses = client.listObjectsPaginator(request); responses.stream().forEach(....);{ @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 directlysoftware.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.Builderavoiding the need to create one manually viaListObjectsRequest.builder()- Parameters:
listObjectsRequest- AConsumerthat will call methods onListObjectsRequest.Builderto create a request.- Returns:
- A custom iterable that can be used to iterate through all the response pages.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyObjectComplete
default NotifyObjectCompleteResponse notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Complete upload- Parameters:
notifyObjectCompleteRequest-requestBody- The content to send to the service. ARequestBodycan 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.
See documentation inRequestBody.fromFile(new File("myfile.txt"))RequestBodyfor 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.'- Returns:
- Result of the NotifyObjectComplete operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyObjectComplete
default NotifyObjectCompleteResponse notifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Complete upload
This is a convenience which creates an instance of the
NotifyObjectCompleteRequest.Builderavoiding the need to create one manually viaNotifyObjectCompleteRequest.builder()- Parameters:
notifyObjectCompleteRequest- AConsumerthat will call methods onNotifyObjectCompleteRequest.Builderto create a request.requestBody- The content to send to the service. ARequestBodycan 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.
See documentation inRequestBody.fromFile(new File("myfile.txt"))RequestBodyfor 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.'- Returns:
- Result of the NotifyObjectComplete operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
notifyObjectComplete
default NotifyObjectCompleteResponse notifyObjectComplete(NotifyObjectCompleteRequest notifyObjectCompleteRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Complete upload- Parameters:
notifyObjectCompleteRequest-sourcePath-Pathto 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.'- Returns:
- Result of the NotifyObjectComplete operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
notifyObjectComplete(NotifyObjectCompleteRequest, RequestBody), AWS API Documentation
-
notifyObjectComplete
default NotifyObjectCompleteResponse notifyObjectComplete(Consumer<NotifyObjectCompleteRequest.Builder> notifyObjectCompleteRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Complete upload
This is a convenience which creates an instance of the
NotifyObjectCompleteRequest.Builderavoiding the need to create one manually viaNotifyObjectCompleteRequest.builder()- Parameters:
notifyObjectCompleteRequest- AConsumerthat will call methods onNotifyObjectCompleteRequest.Builderto create a request.sourcePath-Pathto 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.'- Returns:
- Result of the NotifyObjectComplete operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
notifyObjectComplete(NotifyObjectCompleteRequest, RequestBody), AWS API Documentation
-
putChunk
default PutChunkResponse putChunk(PutChunkRequest putChunkRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Upload chunk.- Parameters:
putChunkRequest-requestBody- The content to send to the service. ARequestBodycan 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.
See documentation inRequestBody.fromFile(new File("myfile.txt"))RequestBodyfor additional details and which sources of data are supported. The service documentation for the request content is as follows 'Data to be uploaded'- Returns:
- Result of the PutChunk operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putChunk
default PutChunkResponse putChunk(Consumer<PutChunkRequest.Builder> putChunkRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Upload chunk.
This is a convenience which creates an instance of the
PutChunkRequest.Builderavoiding the need to create one manually viaPutChunkRequest.builder()- Parameters:
putChunkRequest- AConsumerthat will call methods onPutChunkRequest.Builderto create a request.requestBody- The content to send to the service. ARequestBodycan 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.
See documentation inRequestBody.fromFile(new File("myfile.txt"))RequestBodyfor additional details and which sources of data are supported. The service documentation for the request content is as follows 'Data to be uploaded'- Returns:
- Result of the PutChunk operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putChunk
default PutChunkResponse putChunk(PutChunkRequest putChunkRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Upload chunk.- Parameters:
putChunkRequest-sourcePath-Pathto 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'- Returns:
- Result of the PutChunk operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
putChunk(PutChunkRequest, RequestBody), AWS API Documentation
-
putChunk
default PutChunkResponse putChunk(Consumer<PutChunkRequest.Builder> putChunkRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Upload chunk.
This is a convenience which creates an instance of the
PutChunkRequest.Builderavoiding the need to create one manually viaPutChunkRequest.builder()- Parameters:
putChunkRequest- AConsumerthat will call methods onPutChunkRequest.Builderto create a request.sourcePath-Pathto 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'- Returns:
- Result of the PutChunk operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
putChunk(PutChunkRequest, RequestBody), AWS API Documentation
-
putObject
default PutObjectResponse putObject(PutObjectRequest putObjectRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Upload object that can store object metadata String and data blob in single API call using inline chunk field.- Parameters:
putObjectRequest-requestBody- The content to send to the service. ARequestBodycan 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.
See documentation inRequestBody.fromFile(new File("myfile.txt"))RequestBodyfor 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.'- Returns:
- Result of the PutObject operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putObject
default PutObjectResponse putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, RequestBody requestBody) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
This is a convenience which creates an instance of the
PutObjectRequest.Builderavoiding the need to create one manually viaPutObjectRequest.builder()- Parameters:
putObjectRequest- AConsumerthat will call methods onPutObjectRequest.Builderto create a request.requestBody- The content to send to the service. ARequestBodycan 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.
See documentation inRequestBody.fromFile(new File("myfile.txt"))RequestBodyfor 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.'- Returns:
- Result of the PutObject operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
putObject
default PutObjectResponse putObject(PutObjectRequest putObjectRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Upload object that can store object metadata String and data blob in single API call using inline chunk field.- Parameters:
putObjectRequest-sourcePath-Pathto 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.'- Returns:
- Result of the PutObject operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
putObject(PutObjectRequest, RequestBody), AWS API Documentation
-
putObject
default PutObjectResponse putObject(Consumer<PutObjectRequest.Builder> putObjectRequest, Path sourcePath) throws ServiceUnavailableException, ServiceInternalException, NotReadableInputStreamException, RetryableException, IllegalArgumentException, ThrottlingException, KmsInvalidKeyUsageException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
This is a convenience which creates an instance of the
PutObjectRequest.Builderavoiding the need to create one manually viaPutObjectRequest.builder()- Parameters:
putObjectRequest- AConsumerthat will call methods onPutObjectRequest.Builderto create a request.sourcePath-Pathto 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.'- Returns:
- Result of the PutObject operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
putObject(PutObjectRequest, RequestBody), AWS API Documentation
-
startObject
default StartObjectResponse startObject(StartObjectRequest startObjectRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ResourceNotFoundException, DataAlreadyExistsException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Start upload containing one or many chunks.- Parameters:
startObjectRequest-- Returns:
- Result of the StartObject operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
startObject
default StartObjectResponse startObject(Consumer<StartObjectRequest.Builder> startObjectRequest) throws ServiceUnavailableException, ServiceInternalException, RetryableException, IllegalArgumentException, ResourceNotFoundException, DataAlreadyExistsException, ThrottlingException, AccessDeniedException, AwsServiceException, SdkClientException, BackupStorageException
Start upload containing one or many chunks.
This is a convenience which creates an instance of the
StartObjectRequest.Builderavoiding the need to create one manually viaStartObjectRequest.builder()- Parameters:
startObjectRequest- AConsumerthat will call methods onStartObjectRequest.Builderto create a request.- Returns:
- Result of the StartObject operation returned by the service.
- Throws:
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.AwsServiceException- See Also:
- AWS API Documentation
-
create
static BackupStorageClient create()
Create aBackupStorageClientwith the region loaded from theDefaultAwsRegionProviderChainand credentials loaded from theDefaultCredentialsProvider.
-
builder
static BackupStorageClientBuilder builder()
Create a builder that can be used to configure and create aBackupStorageClient.
-
serviceMetadata
static ServiceMetadata serviceMetadata()
-
serviceClientConfiguration
default BackupStorageServiceClientConfiguration serviceClientConfiguration()
- Specified by:
serviceClientConfigurationin interfaceAwsClient- Specified by:
serviceClientConfigurationin interfaceSdkClient
-
-