ReplicationSummary¶

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

Bases: object

Summary information for a replication.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a ReplicationSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a ReplicationSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a ReplicationSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a ReplicationSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a ReplicationSummary.
`availability_domain`	Gets the availability_domain of this ReplicationSummary.
`compartment_id`	Gets the compartment_id of this ReplicationSummary.
`defined_tags`	Gets the defined_tags of this ReplicationSummary.
`display_name`	[Required] Gets the display_name of this ReplicationSummary.
`freeform_tags`	Gets the freeform_tags of this ReplicationSummary.
`id`	[Required] Gets the id of this ReplicationSummary.
`lifecycle_details`	Gets the lifecycle_details of this ReplicationSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this ReplicationSummary.
`locks`	Gets the locks of this ReplicationSummary.
`recovery_point_time`	Gets the recovery_point_time of this ReplicationSummary.
`replication_interval`	Gets the replication_interval of this ReplicationSummary.
`time_created`	[Required] Gets the time_created of this ReplicationSummary.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a ReplicationSummary. This constant has a value of “ACTIVE”

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

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

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

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

__init__(**kwargs)¶

Initializes a new ReplicationSummary 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 ReplicationSummary.
compartment_id (str) – The value to assign to the compartment_id property of this ReplicationSummary.
id (str) – The value to assign to the id property of this ReplicationSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this ReplicationSummary. 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 ReplicationSummary.
time_created (datetime) – The value to assign to the time_created property of this ReplicationSummary.
locks (list[oci.file_storage.models.ResourceLock]) – The value to assign to the locks property of this ReplicationSummary.
replication_interval (int) – The value to assign to the replication_interval property of this ReplicationSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this ReplicationSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this ReplicationSummary.
lifecycle_details (str) – The value to assign to the lifecycle_details property of this ReplicationSummary.
recovery_point_time (datetime) – The value to assign to the recovery_point_time property of this ReplicationSummary.

availability_domain¶

Gets the availability_domain of this ReplicationSummary. The availability domain the replication is in. The replication must be in the same availability domain as the source file system. Example: Uocm:PHX-AD-1

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

compartment_id¶

Gets the compartment_id of this ReplicationSummary. The OCID of the compartment that contains the replication.

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

defined_tags¶

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

display_name¶

[Required] Gets the display_name of this ReplicationSummary. 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 ReplicationSummary.
Return type:	str

freeform_tags¶

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

id¶

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

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

lifecycle_details¶

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

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this ReplicationSummary. The current state of this replication. This resource can be in a FAILED state if replication target is deleted instead of the replication resource.

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 ReplicationSummary.
Return type:	str

locks¶

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

Returns:	The locks of this ReplicationSummary.
Return type:	list[oci.file_storage.models.ResourceLock]

recovery_point_time¶

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

replication_interval¶

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

Returns:	The replication_interval of this ReplicationSummary.
Return type:	int

time_created¶

[Required] Gets the time_created of this ReplicationSummary. The date and time the replication was created in RFC 3339 timestamp format. Example: 2020-02-04T21:10:29.600Z

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