com.amazonaws.services.backupstorage

Class AWSBackupStorageClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.backupstorage.AWSBackupStorageClient

All Implemented Interfaces:

AWSBackupStorage

Direct Known Subclasses:

AWSBackupStorageAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSBackupStorageClient
extends AmazonWebServiceClient
implements AWSBackupStorage

Client for accessing AWS Backup Storage. All service calls made using this client are blocking, and will not return until the service call completes.

The frontend service for Cryo Storage.

Field Summary

Fields

Modifier and Type	Field and Description
protected static ClientConfigurationFactory	configFactory Client configuration factory providing ClientConfigurations tailored to this client

Fields inherited from class com.amazonaws.AmazonWebServiceClient

client, clientConfiguration, endpoint, isEndpointOverridden, LOGGING_AWS_REQUEST_METRIC, requestHandler2s, timeOffset

Fields inherited from interface com.amazonaws.services.backupstorage.AWSBackupStorage

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSBackupStorageClientBuilder	builder()
DeleteObjectResult	deleteObject(DeleteObjectRequest request) Delete Object from the incremental base Backup.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
GetChunkResult	getChunk(GetChunkRequest request) Gets the specified object's chunk.
GetObjectMetadataResult	getObjectMetadata(GetObjectMetadataRequest request) Get metadata associated with an Object.
ListChunksResult	listChunks(ListChunksRequest request) List chunks in a given Object
ListObjectsResult	listObjects(ListObjectsRequest request) List all Objects in a given Backup.
NotifyObjectCompleteResult	notifyObjectComplete(NotifyObjectCompleteRequest request) Complete upload
PutChunkResult	putChunk(PutChunkRequest request) Upload chunk.
PutObjectResult	putObject(PutObjectRequest request) Upload object that can store object metadata String and data blob in single API call using inline chunk field.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartObjectResult	startObject(StartObjectRequest request) Start upload containing one or many chunks.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, beforeClientExecution, beforeMarshalling, calculateCRC32FromCompressedData, checkMutability, configureRegion, createExecutionContext, createExecutionContext, createExecutionContext, createSignerProvider, endClientExecution, endClientExecution, getClientConfiguration, getClientId, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceAbbreviation, getServiceName, getServiceNameIntern, getSigner, getSignerByURI, getSignerOverride, getSignerProvider, getSignerRegionOverride, getSigningRegion, getTimeOffset, isCsmEnabled, isEndpointOverridden, isProfilingEnabled, isRequestMetricsEnabled, makeImmutable, removeRequestHandler, removeRequestHandler, requestMetricCollector, setEndpoint, setEndpoint, setEndpointPrefix, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, shouldGenerateClientSideMonitoringEvents, useStrictHostNameVerification, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

configFactory

protected static final ClientConfigurationFactory configFactory

Client configuration factory providing ClientConfigurations tailored to this client

Method Detail

builder

public static AWSBackupStorageClientBuilder builder()

deleteObject

public DeleteObjectResult deleteObject(DeleteObjectRequest request)

Delete Object from the incremental base Backup.

Specified by:

deleteObject in interface AWSBackupStorage

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.

AccessDeniedException

See Also:

AWS API Documentation

getChunk

public GetChunkResult getChunk(GetChunkRequest request)

Gets the specified object's chunk.

Specified by:

getChunk in interface AWSBackupStorage

Parameters:

getChunkRequest -

Returns:

Result of the GetChunk operation returned by the service.

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.

AccessDeniedException

See Also:

AWS API Documentation

getObjectMetadata

public GetObjectMetadataResult getObjectMetadata(GetObjectMetadataRequest request)

Get metadata associated with an Object.

Specified by:

getObjectMetadata in interface AWSBackupStorage

Parameters:

getObjectMetadataRequest -

Returns:

Result of the GetObjectMetadata operation returned by the service.

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.

AccessDeniedException

See Also:

AWS API Documentation

listChunks

public ListChunksResult listChunks(ListChunksRequest request)

List chunks in a given Object

Specified by:

listChunks in interface AWSBackupStorage

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.

AccessDeniedException

See Also:

AWS API Documentation

listObjects

public ListObjectsResult listObjects(ListObjectsRequest request)

List all Objects in a given Backup.

Specified by:

listObjects in interface AWSBackupStorage

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.

AccessDeniedException

See Also:

AWS API Documentation

notifyObjectComplete

public NotifyObjectCompleteResult notifyObjectComplete(NotifyObjectCompleteRequest request)

Complete upload

Specified by:

notifyObjectComplete in interface AWSBackupStorage

Parameters:

notifyObjectCompleteRequest -

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.

AccessDeniedException

See Also:

AWS API Documentation

putChunk

public PutChunkResult putChunk(PutChunkRequest request)

Upload chunk.

Specified by:

putChunk in interface AWSBackupStorage

Parameters:

putChunkRequest -

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.

AccessDeniedException

See Also:

AWS API Documentation

putObject

public PutObjectResult putObject(PutObjectRequest request)

Upload object that can store object metadata String and data blob in single API call using inline chunk field.

Specified by:

putObject in interface AWSBackupStorage

Parameters:

putObjectRequest -

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.

AccessDeniedException

See Also:

AWS API Documentation

startObject

public StartObjectResult startObject(StartObjectRequest request)

Start upload containing one or many chunks.

Specified by:

startObject in interface AWSBackupStorage

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.

AccessDeniedException

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSBackupStorage

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from interface: AWSBackupStorage

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSBackupStorage

Overrides:

shutdown in class AmazonWebServiceClient