Class BackupStorageLocation

• Defined in File BackupStorageLocation.cs

Inheritance Relationships

Base Type

• public xbe.sdk.EntityBase (Class EntityBase)

Class Documentation

class xbe.sdk.Models.BackupStorageLocation : xbe.sdk.EntityBase

Defines a single location of remote storage that will be used to maintain backup snapshots.

REQUIRES: Backup Services

Public Functions

BackupStorageLocation ()

BackupStorageLocation (Object obj)

Properties

string Name { get; set; }

The unique name of the storage location.

string Description { get; set; }

A textual description of the storage location.

string AccessKey { get; set; }

The API access key to authenticate with the remote server with.

bool Active { get; set; }

Indicates if the backup location is currently active for storing database snapshots. An inactive location can still be used to search and retrieve existing snapshots.

string Bucket { get; set; }

The name of the remote storage bucket.

string Host { get; set; }

The host of the remote storage provider.

Object Options { get; set; }

Additional configuration options used by the storage provider.

string Path { get; set; }

The path prefix or sub-directory to store files.

StorageProvider Provider { get; set; }

Describes the provider type of storage location.

string Region { get; set; }

The region that the bucket is located in. Note this is not supported by all providers.

string Secret { get; set; }

The API secret to authenticate with the remote server with.

Public Static Functions

new BackupStorageLocation Parse (string json)

Parses the given JSON encoded string into a new StorageLocation instance.

Param json:

Return: