Replication

class oci.file_storage.models.Replication(**kwargs)

Bases: object

Replications are the primary resource that governs the policy of cross-region replication between source and target file systems. Replications are associated with a secondary resource called a ReplicationTarget located in another availability domain in the same or different region. The replication retrieves the delta of data between two snapshots of a source file system and sends it to the associated ReplicationTarget, which applies it to the target file system. For more information, see `File System Replication`__.

Attributes:

DELTA_STATUS_APPLYING

A constant which can be used with the delta_status property of a Replication.

DELTA_STATUS_CAPTURING

A constant which can be used with the delta_status property of a Replication.

DELTA_STATUS_FAILED

A constant which can be used with the delta_status property of a Replication.

DELTA_STATUS_IDLE

A constant which can be used with the delta_status property of a Replication.

DELTA_STATUS_SERVICE_ERROR

A constant which can be used with the delta_status property of a Replication.

DELTA_STATUS_TRANSFERRING

A constant which can be used with the delta_status property of a Replication.

DELTA_STATUS_USER_ERROR

A constant which can be used with the delta_status property of a Replication.

LIFECYCLE_STATE_ACTIVE

A constant which can be used with the lifecycle_state property of a Replication.

LIFECYCLE_STATE_CREATING

A constant which can be used with the lifecycle_state property of a Replication.

LIFECYCLE_STATE_DELETED

A constant which can be used with the lifecycle_state property of a Replication.

LIFECYCLE_STATE_DELETING

A constant which can be used with the lifecycle_state property of a Replication.

LIFECYCLE_STATE_FAILED

A constant which can be used with the lifecycle_state property of a Replication.

availability_domain

Gets the availability_domain of this Replication.

compartment_id

[Required] Gets the compartment_id of this Replication.

defined_tags

Gets the defined_tags of this Replication.

delta_progress

Gets the delta_progress of this Replication.

delta_status

Gets the delta_status of this Replication.

display_name

[Required] Gets the display_name of this Replication.

freeform_tags

Gets the freeform_tags of this Replication. Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see `Resource Tags`__. Example: {"Department": "Finance"}.

id

[Required] Gets the id of this Replication.

last_snapshot_id

Gets the last_snapshot_id of this Replication.

lifecycle_details

Gets the lifecycle_details of this Replication.

lifecycle_state

[Required] Gets the lifecycle_state of this Replication.

locks

Gets the locks of this Replication.

recovery_point_time

Gets the recovery_point_time of this Replication.

replication_interval

Gets the replication_interval of this Replication.

replication_target_id

[Required] Gets the replication_target_id of this Replication.

source_id

[Required] Gets the source_id of this Replication.

system_tags

Gets the system_tags of this Replication.

target_id

[Required] Gets the target_id of this Replication.

time_created

[Required] Gets the time_created of this Replication.

Methods:

__init__(**kwargs)

Initializes a new Replication object with values from keyword arguments.

DELTA_STATUS_APPLYING = 'APPLYING'

A constant which can be used with the delta_status property of a Replication. This constant has a value of “APPLYING”

DELTA_STATUS_CAPTURING = 'CAPTURING'

A constant which can be used with the delta_status property of a Replication. This constant has a value of “CAPTURING”

DELTA_STATUS_FAILED = 'FAILED'

A constant which can be used with the delta_status property of a Replication. This constant has a value of “FAILED”

DELTA_STATUS_IDLE = 'IDLE'

A constant which can be used with the delta_status property of a Replication. This constant has a value of “IDLE”

DELTA_STATUS_SERVICE_ERROR = 'SERVICE_ERROR'

A constant which can be used with the delta_status property of a Replication. This constant has a value of “SERVICE_ERROR”

DELTA_STATUS_TRANSFERRING = 'TRANSFERRING'

A constant which can be used with the delta_status property of a Replication. This constant has a value of “TRANSFERRING”

DELTA_STATUS_USER_ERROR = 'USER_ERROR'

A constant which can be used with the delta_status property of a Replication. This constant has a value of “USER_ERROR”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

A constant which can be used with the lifecycle_state property of a Replication. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'

A constant which can be used with the lifecycle_state property of a Replication. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'

A constant which can be used with the lifecycle_state property of a Replication. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'

A constant which can be used with the lifecycle_state property of a Replication. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'

A constant which can be used with the lifecycle_state property of a Replication. This constant has a value of “FAILED”

__init__(**kwargs)

Initializes a new Replication object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • compartment_id (str) – The value to assign to the compartment_id property of this Replication.

  • availability_domain (str) – The value to assign to the availability_domain property of this Replication.

  • id (str) – The value to assign to the id property of this Replication.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this Replication. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • display_name (str) – The value to assign to the display_name property of this Replication.

  • time_created (datetime) – The value to assign to the time_created property of this Replication.

  • source_id (str) – The value to assign to the source_id property of this Replication.

  • target_id (str) – The value to assign to the target_id property of this Replication.

  • replication_target_id (str) – The value to assign to the replication_target_id property of this Replication.

  • replication_interval (int) – The value to assign to the replication_interval property of this Replication.

  • last_snapshot_id (str) – The value to assign to the last_snapshot_id property of this Replication.

  • recovery_point_time (datetime) – The value to assign to the recovery_point_time property of this Replication.

  • delta_status (str) – The value to assign to the delta_status property of this Replication. Allowed values for this property are: “IDLE”, “CAPTURING”, “APPLYING”, “SERVICE_ERROR”, “USER_ERROR”, “FAILED”, “TRANSFERRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this Replication.

  • delta_progress (int) – The value to assign to the delta_progress property of this Replication.

  • locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this Replication.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this Replication.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this Replication.

  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this Replication.

property availability_domain

Gets the availability_domain of this Replication. The availability domain that contains the replication. May be unset as a blank or NULL value. Example: Uocm:PHX-AD-2

Returns

The availability_domain of this Replication.

Return type

str

property compartment_id

[Required] Gets the compartment_id of this Replication. The `OCID`__ of the compartment that contains the replication.

Returns

The compartment_id of this Replication.

Return type

str

property defined_tags

Gets the defined_tags of this Replication. Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see `Resource Tags`__. Example: {“Operations”: {“CostCenter”: “42”}}

Returns

The defined_tags of this Replication.

Return type

dict(str, dict(str, object))

property delta_progress

Gets the delta_progress of this Replication. Percentage progress of the current replication cycle.

Returns

The delta_progress of this Replication.

Return type

int

property delta_status

Gets the delta_status of this Replication. The current state of the snapshot during replication operations.

Allowed values for this property are: “IDLE”, “CAPTURING”, “APPLYING”, “SERVICE_ERROR”, “USER_ERROR”, “FAILED”, “TRANSFERRING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The delta_status of this Replication.

Return type

str

property display_name

[Required] Gets the display_name of this Replication. A user-friendly name. It does not have to be unique, and it is changeable. Avoid entering confidential information.

Example: My replication

Returns

The display_name of this Replication.

Return type

str

property freeform_tags

Gets the freeform_tags of this Replication. Free-form tags for this resource. Each tag is a simple key-value pair

with no predefined name, type, or namespace.

For more information, see `Resource Tags`__. Example: {“Department”: “Finance”}

Returns

The freeform_tags of this Replication.

Return type

dict(str, str)

property id

[Required] Gets the id of this Replication. The `OCID`__ of the replication.

Returns

The id of this Replication.

Return type

str

property last_snapshot_id

Gets the last_snapshot_id of this Replication. The `OCID`__ of the last snapshot that has been replicated completely. Empty if the copy of the initial snapshot is not complete.

Returns

The last_snapshot_id of this Replication.

Return type

str

property lifecycle_details

Gets the lifecycle_details of this Replication. Additional information about the current ‘lifecycleState’.

Returns

The lifecycle_details of this Replication.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this Replication. The current lifecycle state of the replication.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The lifecycle_state of this Replication.

Return type

str

property locks

Gets the locks of this Replication. Locks associated with this resource.

Returns

The locks of this Replication.

Return type

list[oci.file_storage.models.ResourceLock]

property recovery_point_time

Gets the recovery_point_time of this Replication. The snapshot_time() of the most recent recoverable replication snapshot in `RFC 3339`__ timestamp format. Example: 2021-04-04T20:01:29.100Z

Returns

The recovery_point_time of this Replication.

Return type

datetime

property replication_interval

Gets the replication_interval of this Replication. Duration in minutes between replication snapshots.

Returns

The replication_interval of this Replication.

Return type

int

property replication_target_id

[Required] Gets the replication_target_id of this Replication. The `OCID`__ of the ReplicationTarget.

Returns

The replication_target_id of this Replication.

Return type

str

property source_id

[Required] Gets the source_id of this Replication. The `OCID`__ of the source file system.

Returns

The source_id of this Replication.

Return type

str

property system_tags

Gets the system_tags of this Replication. System tags for this resource. System tags are applied to resources by internal OCI services.

Returns

The system_tags of this Replication.

Return type

dict(str, dict(str, object))

property target_id

[Required] Gets the target_id of this Replication. The `OCID`__ of the target file system.

Returns

The target_id of this Replication.

Return type

str

property time_created

[Required] Gets the time_created of this Replication. The date and time the replication was created in `RFC 3339`__ timestamp format.

Example: 2021-01-04T20:01:29.100Z

Returns

The time_created of this Replication.

Return type

datetime