Edit on GitHub

Backupstorage

This page documents function available when using the Backupstorage module, created with @service Backupstorage.

Index

Documentation

Main.Backupstorage.delete_object — Method
delete_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.
source
Main.Backupstorage.get_chunk — Method
get_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 token
  • job_id: Storage job id
source
Main.Backupstorage.get_object_metadata — Method
get_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.
source
Main.Backupstorage.list_chunks — Method
list_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 id
  • object_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
source
Main.Backupstorage.list_objects — Method
list_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
source
Main.Backupstorage.notify_object_complete — Method
notify_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 checksum
  • checksum-algorithm: Checksum algorithm
  • job_id: Backup job Id for the in-progress backup
  • upload_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.
source
Main.Backupstorage.put_chunk — Method
put_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 uploaded
  • checksum: Data checksum
  • checksum-algorithm: Checksum algorithm
  • chunk_index: Describes this chunk's position relative to the other chunks
  • job_id: Backup job Id for the in-progress backup.
  • length: Data length
  • upload_id: Upload Id for the in-progress upload.
source
Main.Backupstorage.put_object — Method
put_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.
source
Main.Backupstorage.start_object — Method
start_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 backup
  • object_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.
source