Backupstorage
This page documents function available when using the Backupstorage
module, created with @service Backupstorage
.
Index
Main.Backupstorage.delete_object
Main.Backupstorage.get_chunk
Main.Backupstorage.get_object_metadata
Main.Backupstorage.list_chunks
Main.Backupstorage.list_objects
Main.Backupstorage.notify_object_complete
Main.Backupstorage.put_chunk
Main.Backupstorage.put_object
Main.Backupstorage.start_object
Documentation
Main.Backupstorage.delete_object
— Methoddelete_object(job_id, object_name)
delete_object(job_id, object_name, params::Dict{String,<:Any})
Delete Object from the incremental base Backup.
Arguments
job_id
: Backup job Id for the in-progress backup.object_name
: The name of the Object.
Main.Backupstorage.get_chunk
— Methodget_chunk(chunk_token, job_id)
get_chunk(chunk_token, job_id, params::Dict{String,<:Any})
Gets the specified object's chunk.
Arguments
chunk_token
: Chunk tokenjob_id
: Storage job id
Main.Backupstorage.get_object_metadata
— Methodget_object_metadata(job_id, object_token)
get_object_metadata(job_id, object_token, params::Dict{String,<:Any})
Get metadata associated with an Object.
Arguments
job_id
: Backup job id for the in-progress backup.object_token
: Object token.
Main.Backupstorage.list_chunks
— Methodlist_chunks(job_id, object_token)
list_chunks(job_id, object_token, params::Dict{String,<:Any})
List chunks in a given Object
Arguments
job_id
: Storage job idobject_token
: Object token
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"max-results"
: Maximum number of chunks"next-token"
: Pagination token
Main.Backupstorage.list_objects
— Methodlist_objects(job_id)
list_objects(job_id, params::Dict{String,<:Any})
List all Objects in a given Backup.
Arguments
job_id
: Storage job id
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"created-after"
: (Optional) Created after filter"created-before"
: (Optional) Created before filter"max-results"
: Maximum objects count"next-token"
: Pagination token"starting-object-name"
: Optional, specifies the starting Object name to list from. Ignored if NextToken is not NULL"starting-object-prefix"
: Optional, specifies the starting Object prefix to list from. Ignored if NextToken is not NULL
Main.Backupstorage.notify_object_complete
— Methodnotify_object_complete(checksum, checksum-algorithm, job_id, upload_id)
notify_object_complete(checksum, checksum-algorithm, job_id, upload_id, params::Dict{String,<:Any})
Complete upload
Arguments
checksum
: Object checksumchecksum-algorithm
: Checksum algorithmjob_id
: Backup job Id for the in-progress backupupload_id
: Upload Id for the in-progress upload
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"MetadataBlob"
: Optional metadata associated with an Object. Maximum length is 4MB."metadata-blob-length"
: The size of MetadataBlob."metadata-checksum"
: Checksum of MetadataBlob."metadata-checksum-algorithm"
: Checksum algorithm."metadata-string"
: Optional metadata associated with an Object. Maximum string length is 256 bytes.
Main.Backupstorage.put_chunk
— Methodput_chunk(data, checksum, checksum-algorithm, chunk_index, job_id, length, upload_id)
put_chunk(data, checksum, checksum-algorithm, chunk_index, job_id, length, upload_id, params::Dict{String,<:Any})
Upload chunk.
Arguments
data
: Data to be uploadedchecksum
: Data checksumchecksum-algorithm
: Checksum algorithmchunk_index
: Describes this chunk's position relative to the other chunksjob_id
: Backup job Id for the in-progress backup.length
: Data lengthupload_id
: Upload Id for the in-progress upload.
Main.Backupstorage.put_object
— Methodput_object(job_id, object_name)
put_object(job_id, object_name, params::Dict{String,<:Any})
Upload object that can store object metadata String and data blob in single API call using inline chunk field.
Arguments
job_id
: Backup job Id for the in-progress backup.object_name
: The name of the Object to be uploaded.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"InlineChunk"
: Inline chunk data to be uploaded."checksum"
: Inline chunk checksum"checksum-algorithm"
: Inline chunk checksum algorithm"length"
: Length of the inline chunk data."metadata-string"
: Store user defined metadata like backup checksum, disk ids, restore metadata etc."object-checksum"
: object checksum"object-checksum-algorithm"
: object checksum algorithm"throwOnDuplicate"
: Throw an exception if Object name is already exist.
Main.Backupstorage.start_object
— Methodstart_object(job_id, object_name)
start_object(job_id, object_name, params::Dict{String,<:Any})
Start upload containing one or many chunks.
Arguments
job_id
: Backup job Id for the in-progress backupobject_name
: Name for the object.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}
. Valid keys are:
"ThrowOnDuplicate"
: Throw an exception if Object name is already exist.