ReplicationTarget¶

class oci.file_storage.models.ReplicationTarget(**kwargs)¶

Bases: object

Replication targets are associated with a primary resource called a Replication 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. All operations (except DELETE) must be done using the associated replication resource. Deleting a ReplicationTarget allows the target file system to be exported. Deleting a ReplicationTarget does not delete the associated Replication resource, but places it in a FAILED state. For more information, see File System Replication.

Attributes

`DELTA_STATUS_APPLYING`	A constant which can be used with the delta_status property of a ReplicationTarget.
`DELTA_STATUS_CAPTURING`	A constant which can be used with the delta_status property of a ReplicationTarget.
`DELTA_STATUS_FAILED`	A constant which can be used with the delta_status property of a ReplicationTarget.
`DELTA_STATUS_IDLE`	A constant which can be used with the delta_status property of a ReplicationTarget.
`DELTA_STATUS_SERVICE_ERROR`	A constant which can be used with the delta_status property of a ReplicationTarget.
`DELTA_STATUS_TRANSFERRING`	A constant which can be used with the delta_status property of a ReplicationTarget.
`DELTA_STATUS_USER_ERROR`	A constant which can be used with the delta_status property of a ReplicationTarget.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ReplicationTarget.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ReplicationTarget.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ReplicationTarget.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ReplicationTarget.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ReplicationTarget.
`availability_domain`	Gets the availability_domain of this ReplicationTarget.
`compartment_id`	[Required] Gets the compartment_id of this ReplicationTarget.
`defined_tags`	Gets the defined_tags of this ReplicationTarget.
`delta_progress`	Gets the delta_progress of this ReplicationTarget.
`delta_status`	Gets the delta_status of this ReplicationTarget.
`display_name`	[Required] Gets the display_name of this ReplicationTarget.
`freeform_tags`	Gets the freeform_tags of this ReplicationTarget.
`id`	[Required] Gets the id of this ReplicationTarget.
`last_snapshot_id`	Gets the last_snapshot_id of this ReplicationTarget.
`lifecycle_details`	Gets the lifecycle_details of this ReplicationTarget.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ReplicationTarget.
`recovery_point_time`	Gets the recovery_point_time of this ReplicationTarget.
`replication_id`	[Required] Gets the replication_id of this ReplicationTarget.
`source_id`	[Required] Gets the source_id of this ReplicationTarget.
`target_id`	[Required] Gets the target_id of this ReplicationTarget.
`time_created`	[Required] Gets the time_created of this ReplicationTarget.

Methods

__init__(**kwargs) Initializes a new ReplicationTarget object with values from keyword arguments.

DELTA_STATUS_APPLYING = 'APPLYING'¶: A constant which can be used with the delta_status property of a ReplicationTarget. This constant has a value of “APPLYING”

DELTA_STATUS_CAPTURING = 'CAPTURING'¶: A constant which can be used with the delta_status property of a ReplicationTarget. This constant has a value of “CAPTURING”

DELTA_STATUS_FAILED = 'FAILED'¶: A constant which can be used with the delta_status property of a ReplicationTarget. This constant has a value of “FAILED”

DELTA_STATUS_IDLE = 'IDLE'¶: A constant which can be used with the delta_status property of a ReplicationTarget. 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 ReplicationTarget. 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 ReplicationTarget. 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 ReplicationTarget. 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 ReplicationTarget. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a ReplicationTarget. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a ReplicationTarget. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a ReplicationTarget. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a ReplicationTarget. This constant has a value of “FAILED”

__init__(**kwargs)¶

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

Parameters:

availability_domain (str) – The value to assign to the availability_domain property of this ReplicationTarget.
compartment_id (str) – The value to assign to the compartment_id property of this ReplicationTarget.
id (str) – The value to assign to the id property of this ReplicationTarget.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ReplicationTarget. 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 ReplicationTarget.
time_created (datetime) – The value to assign to the time_created property of this ReplicationTarget.
source_id (str) – The value to assign to the source_id property of this ReplicationTarget.
target_id (str) – The value to assign to the target_id property of this ReplicationTarget.
replication_id (str) – The value to assign to the replication_id property of this ReplicationTarget.
last_snapshot_id (str) – The value to assign to the last_snapshot_id property of this ReplicationTarget.
recovery_point_time (datetime) – The value to assign to the recovery_point_time property of this ReplicationTarget.
delta_status (str) – The value to assign to the delta_status property of this ReplicationTarget. 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’.
delta_progress (int) – The value to assign to the delta_progress property of this ReplicationTarget.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ReplicationTarget.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ReplicationTarget.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ReplicationTarget.

availability_domain¶

Gets the availability_domain of this ReplicationTarget. The availability domain the replication resource is in. May be unset as a blank or NULL value.

Example: Uocm:PHX-AD-1

Returns:	The availability_domain of this ReplicationTarget.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this ReplicationTarget. The OCID of the compartment that contains the replication.

Returns:	The compartment_id of this ReplicationTarget.
Return type:	str

defined_tags¶

Gets the defined_tags of this ReplicationTarget. 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 ReplicationTarget.
Return type:	dict(str, dict(str, object))

delta_progress¶

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

Returns:	The delta_progress of this ReplicationTarget.
Return type:	int

delta_status¶

Gets the delta_status of this ReplicationTarget. 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 ReplicationTarget.
Return type:	str

display_name¶

[Required] Gets the display_name of this ReplicationTarget. A user-friendly name. This name is same as the replication display name for the associated resource. Example: My Replication

Returns:	The display_name of this ReplicationTarget.
Return type:	str

freeform_tags¶

Gets the freeform_tags of this ReplicationTarget. 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 ReplicationTarget.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this ReplicationTarget. The OCID of the replication.

Returns:	The id of this ReplicationTarget.
Return type:	str

last_snapshot_id¶

Gets the last_snapshot_id of this ReplicationTarget. The OCID of the last snapshot snapshot which was completely applied to the target file system. Empty while the initial snapshot is being applied.

Returns:	The last_snapshot_id of this ReplicationTarget.
Return type:	str

lifecycle_details¶

Gets the lifecycle_details of this ReplicationTarget. Additional information about the current lifecycleState.

Returns:	The lifecycle_details of this ReplicationTarget.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this ReplicationTarget. The current state 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’.

Returns:	The lifecycle_state of this ReplicationTarget.
Return type:	str

recovery_point_time¶

Gets the recovery_point_time of this ReplicationTarget. The snapshotTime 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 ReplicationTarget.
Return type:	datetime

replication_id¶

[Required] Gets the replication_id of this ReplicationTarget. The OCID of replication.

Returns:	The replication_id of this ReplicationTarget.
Return type:	str

source_id¶

[Required] Gets the source_id of this ReplicationTarget. The OCID of source filesystem.

Returns:	The source_id of this ReplicationTarget.
Return type:	str

target_id¶

[Required] Gets the target_id of this ReplicationTarget. The OCID of target filesystem.

Returns:	The target_id of this ReplicationTarget.
Return type:	str

time_created¶

[Required] Gets the time_created of this ReplicationTarget. The date and time the replication target was created in target region. in RFC 3339 timestamp format. Example: 2021-01-04T20:01:29.100Z

Returns:	The time_created of this ReplicationTarget.
Return type:	datetime