backupstorage/aws.sdk.kotlin.services.backupstorage/BackupStorageClient

BackupStorageClient

interface BackupStorageClient : SdkClient

The frontend service for Cryo Storage.

Types

class Builder : AbstractSdkClientBuilder<BackupStorageClient.Config, BackupStorageClient.Config.Builder, BackupStorageClient>

object Companion : AbstractAwsSdkClientFactory<BackupStorageClient.Config, BackupStorageClient.Config.Builder, BackupStorageClient, BackupStorageClient.Builder>

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

abstract override val config: BackupStorageClient.Config

BackupStorageClient's configuration

Functions

abstract suspend fun deleteObject(input: DeleteObjectRequest): DeleteObjectResponse

Delete Object from the incremental base Backup.

abstract suspend fun <T> getChunk(input: GetChunkRequest, block: suspend (GetChunkResponse) -> T): T

Gets the specified object's chunk.

getObjectMetadata

abstract suspend fun <T> getObjectMetadata(input: GetObjectMetadataRequest, block: suspend (GetObjectMetadataResponse) -> T): T

Get metadata associated with an Object.

abstract suspend fun listChunks(input: ListChunksRequest): ListChunksResponse

List chunks in a given Object

abstract suspend fun listObjects(input: ListObjectsRequest): ListObjectsResponse

List all Objects in a given Backup.

notifyObjectComplete

abstract suspend fun notifyObjectComplete(input: NotifyObjectCompleteRequest): NotifyObjectCompleteResponse

Complete upload

abstract suspend fun putChunk(input: PutChunkRequest): PutChunkResponse

Upload chunk.

abstract suspend fun putObject(input: PutObjectRequest): PutObjectResponse

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

abstract suspend fun startObject(input: StartObjectRequest): StartObjectResponse

Start upload containing one or many chunks.

Inherited functions

expect abstract fun close()

inline suspend fun BackupStorageClient.deleteObject(crossinline block: DeleteObjectRequest.Builder.() -> Unit): DeleteObjectResponse

Delete Object from the incremental base Backup.

inline suspend fun BackupStorageClient.listChunks(crossinline block: ListChunksRequest.Builder.() -> Unit): ListChunksResponse

List chunks in a given Object

listChunksPaginated

fun BackupStorageClient.listChunksPaginated(initialRequest: ListChunksRequest): Flow<ListChunksResponse>

fun BackupStorageClient.listChunksPaginated(block: ListChunksRequest.Builder.() -> Unit): Flow<ListChunksResponse>

Paginate over ListChunksResponse results.

inline suspend fun BackupStorageClient.listObjects(crossinline block: ListObjectsRequest.Builder.() -> Unit): ListObjectsResponse

List all Objects in a given Backup.

listObjectsPaginated

fun BackupStorageClient.listObjectsPaginated(initialRequest: ListObjectsRequest): Flow<ListObjectsResponse>

fun BackupStorageClient.listObjectsPaginated(block: ListObjectsRequest.Builder.() -> Unit): Flow<ListObjectsResponse>

Paginate over ListObjectsResponse results.

notifyObjectComplete

inline suspend fun BackupStorageClient.notifyObjectComplete(crossinline block: NotifyObjectCompleteRequest.Builder.() -> Unit): NotifyObjectCompleteResponse

Complete upload

inline suspend fun BackupStorageClient.putChunk(crossinline block: PutChunkRequest.Builder.() -> Unit): PutChunkResponse

Upload chunk.

inline suspend fun BackupStorageClient.putObject(crossinline block: PutObjectRequest.Builder.() -> Unit): PutObjectResponse

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

inline suspend fun BackupStorageClient.startObject(crossinline block: StartObjectRequest.Builder.() -> Unit): StartObjectResponse

Start upload containing one or many chunks.

fun BackupStorageClient.withConfig(block: BackupStorageClient.Config.Builder.() -> Unit): BackupStorageClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.