models_v2.recover_couchbase_params module

class models_v2.recover_couchbase_params.RecoverCouchbaseParams(snapshots=None, recover_to=None, overwrite=None, concurrency=None, bandwidth_mbps=None, warnings=None, suffix=None, append_documents=None, ddl_only_recovery=None, overwrite_users=None)

Bases: object

Implementation of the ‘Recover Couchbase params.’ model.

Specifies the parameters to recover Couchbase objects.

Attributes:

recover_to (long|int): Specifies the ‘Source Registration ID’ of the

source where the objects are to be recovered. If this is not specified, the recovery job will recover to the original location.

overwrite (bool): Set to true to overwrite an existing object at the

destination. If set to false, and the same object exists at the destination, then recovery will fail for that object.

concurrency (int): Specifies the maximum number of concurrent IO

Streams that will be created to exchange data with the cluster.

bandwidth_mbps (long|int): Specifies the maximum network bandwidth

that each concurrent IO Stream can use for exchanging data with the cluster.

warnings (list of string): This field will hold the warnings in cases

where the job status is SucceededWithWarnings.

snapshots (list of RecoverCouchbaseSnapshotParams): Specifies the

local snapshot ids of the Objects to be recovered.

suffix (string): A suffix that is to be applied to all recovered

objects.

append_documents (bool): If set to true, docuements from the bucket

being recovered will be appended into the bucket at the destination.

ddl_only_recovery (bool): Set to true to recover only the bucket

configurations. No documents will be recovered.

overwrite_users (bool): If set to true existing users will be replaced

with users from the bucket being recovered.

classmethod from_dictionary(dictionary)

Creates an instance of this model from a dictionary

Args:

dictionary (dictionary): A dictionary representation of the object as obtained from the deserialization of the server’s response. The keys MUST match property names in the API description.

Returns:

object: An instance of this structure class.