DeploymentBackupSummary¶

class oci.golden_gate.models.DeploymentBackupSummary(**kwargs)¶

Bases: object

The summary of the Backup.

Attributes

`BACKUP_TYPE_FULL`	A constant which can be used with the backup_type property of a DeploymentBackupSummary.
`BACKUP_TYPE_INCREMENTAL`	A constant which can be used with the backup_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_BIGDATA`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_DATABASE_DB2_ZOS`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_DATABASE_MICROSOFT_SQLSERVER`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_DATABASE_MYSQL`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_DATABASE_ORACLE`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_DATABASE_POSTGRESQL`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_DATA_TRANSFORMS`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_GGSA`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`DEPLOYMENT_TYPE_OGG`	A constant which can be used with the deployment_type property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_CANCELED`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_CANCELING`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_INACTIVE`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_IN_PROGRESS`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_NEEDS_ATTENTION`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_SUCCEEDED`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_UPDATING`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`LIFECYCLE_STATE_WAITING`	A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary.
`backup_type`	Gets the backup_type of this DeploymentBackupSummary.
`bucket_name`	Gets the bucket_name of this DeploymentBackupSummary.
`compartment_id`	[Required] Gets the compartment_id of this DeploymentBackupSummary.
`defined_tags`	Gets the defined_tags of this DeploymentBackupSummary.
`deployment_id`	[Required] Gets the deployment_id of this DeploymentBackupSummary.
`deployment_type`	[Required] Gets the deployment_type of this DeploymentBackupSummary.
`display_name`	Gets the display_name of this DeploymentBackupSummary.
`freeform_tags`	Gets the freeform_tags of this DeploymentBackupSummary.
`id`	[Required] Gets the id of this DeploymentBackupSummary.
`is_automatic`	Gets the is_automatic of this DeploymentBackupSummary.
`is_metadata_only`	Gets the is_metadata_only of this DeploymentBackupSummary.
`lifecycle_details`	Gets the lifecycle_details of this DeploymentBackupSummary.
`lifecycle_state`	[Required] Gets the lifecycle_state of this DeploymentBackupSummary.
`locks`	Gets the locks of this DeploymentBackupSummary.
`namespace_name`	Gets the namespace_name of this DeploymentBackupSummary.
`object_name`	Gets the object_name of this DeploymentBackupSummary.
`ogg_version`	[Required] Gets the ogg_version of this DeploymentBackupSummary.
`size_in_bytes`	Gets the size_in_bytes of this DeploymentBackupSummary.
`system_tags`	Gets the system_tags of this DeploymentBackupSummary.
`time_backup_finished`	Gets the time_backup_finished of this DeploymentBackupSummary.
`time_created`	Gets the time_created of this DeploymentBackupSummary.
`time_of_backup`	Gets the time_of_backup of this DeploymentBackupSummary.
`time_updated`	Gets the time_updated of this DeploymentBackupSummary.

Methods

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

BACKUP_TYPE_FULL = 'FULL'¶: A constant which can be used with the backup_type property of a DeploymentBackupSummary. This constant has a value of “FULL”

BACKUP_TYPE_INCREMENTAL = 'INCREMENTAL'¶: A constant which can be used with the backup_type property of a DeploymentBackupSummary. This constant has a value of “INCREMENTAL”

DEPLOYMENT_TYPE_BIGDATA = 'BIGDATA'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “BIGDATA”

DEPLOYMENT_TYPE_DATABASE_DB2_ZOS = 'DATABASE_DB2ZOS'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “DATABASE_DB2ZOS”

DEPLOYMENT_TYPE_DATABASE_MICROSOFT_SQLSERVER = 'DATABASE_MICROSOFT_SQLSERVER'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “DATABASE_MICROSOFT_SQLSERVER”

DEPLOYMENT_TYPE_DATABASE_MYSQL = 'DATABASE_MYSQL'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “DATABASE_MYSQL”

DEPLOYMENT_TYPE_DATABASE_ORACLE = 'DATABASE_ORACLE'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “DATABASE_ORACLE”

DEPLOYMENT_TYPE_DATABASE_POSTGRESQL = 'DATABASE_POSTGRESQL'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “DATABASE_POSTGRESQL”

DEPLOYMENT_TYPE_DATA_TRANSFORMS = 'DATA_TRANSFORMS'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “DATA_TRANSFORMS”

DEPLOYMENT_TYPE_GGSA = 'GGSA'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “GGSA”

DEPLOYMENT_TYPE_OGG = 'OGG'¶: A constant which can be used with the deployment_type property of a DeploymentBackupSummary. This constant has a value of “OGG”

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

LIFECYCLE_STATE_CANCELED = 'CANCELED'¶: A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary. This constant has a value of “CANCELED”

LIFECYCLE_STATE_CANCELING = 'CANCELING'¶: A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary. This constant has a value of “CANCELING”

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

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

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

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

LIFECYCLE_STATE_INACTIVE = 'INACTIVE'¶: A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary. This constant has a value of “INACTIVE”

LIFECYCLE_STATE_IN_PROGRESS = 'IN_PROGRESS'¶: A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary. This constant has a value of “IN_PROGRESS”

LIFECYCLE_STATE_NEEDS_ATTENTION = 'NEEDS_ATTENTION'¶: A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary. This constant has a value of “NEEDS_ATTENTION”

LIFECYCLE_STATE_SUCCEEDED = 'SUCCEEDED'¶: A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary. This constant has a value of “SUCCEEDED”

LIFECYCLE_STATE_UPDATING = 'UPDATING'¶: A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary. This constant has a value of “UPDATING”

LIFECYCLE_STATE_WAITING = 'WAITING'¶: A constant which can be used with the lifecycle_state property of a DeploymentBackupSummary. This constant has a value of “WAITING”

__init__(**kwargs)¶

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

Parameters:

id (str) – The value to assign to the id property of this DeploymentBackupSummary.
deployment_id (str) – The value to assign to the deployment_id property of this DeploymentBackupSummary.
deployment_type (str) – The value to assign to the deployment_type property of this DeploymentBackupSummary. Allowed values for this property are: “OGG”, “DATABASE_ORACLE”, “BIGDATA”, “DATABASE_MICROSOFT_SQLSERVER”, “DATABASE_MYSQL”, “DATABASE_POSTGRESQL”, “DATABASE_DB2ZOS”, “GGSA”, “DATA_TRANSFORMS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
compartment_id (str) – The value to assign to the compartment_id property of this DeploymentBackupSummary.
display_name (str) – The value to assign to the display_name property of this DeploymentBackupSummary.
is_automatic (bool) – The value to assign to the is_automatic property of this DeploymentBackupSummary.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this DeploymentBackupSummary. Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “WAITING”, ‘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 DeploymentBackupSummary.
time_of_backup (datetime) – The value to assign to the time_of_backup property of this DeploymentBackupSummary.
time_backup_finished (datetime) – The value to assign to the time_backup_finished property of this DeploymentBackupSummary.
size_in_bytes (int) – The value to assign to the size_in_bytes property of this DeploymentBackupSummary.
backup_type (str) – The value to assign to the backup_type property of this DeploymentBackupSummary. Allowed values for this property are: “INCREMENTAL”, “FULL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
ogg_version (str) – The value to assign to the ogg_version property of this DeploymentBackupSummary.
namespace_name (str) – The value to assign to the namespace_name property of this DeploymentBackupSummary.
bucket_name (str) – The value to assign to the bucket_name property of this DeploymentBackupSummary.
object_name (str) – The value to assign to the object_name property of this DeploymentBackupSummary.
time_created (datetime) – The value to assign to the time_created property of this DeploymentBackupSummary.
time_updated (datetime) – The value to assign to the time_updated property of this DeploymentBackupSummary.
freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this DeploymentBackupSummary.
defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this DeploymentBackupSummary.
system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this DeploymentBackupSummary.
is_metadata_only (bool) – The value to assign to the is_metadata_only property of this DeploymentBackupSummary.
locks (list[oci.golden_gate.models.ResourceLock]) – The value to assign to the locks property of this DeploymentBackupSummary.

backup_type¶

Gets the backup_type of this DeploymentBackupSummary. Possible Deployment backup types.

Allowed values for this property are: “INCREMENTAL”, “FULL”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The backup_type of this DeploymentBackupSummary.
Return type:	str

bucket_name¶

Gets the bucket_name of this DeploymentBackupSummary. Name of the bucket where the object is to be uploaded in the object storage

Returns:	The bucket_name of this DeploymentBackupSummary.
Return type:	str

compartment_id¶

[Required] Gets the compartment_id of this DeploymentBackupSummary. The OCID of the compartment being referenced.

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

defined_tags¶

Gets the defined_tags of this DeploymentBackupSummary. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:	The defined_tags of this DeploymentBackupSummary.
Return type:	dict(str, dict(str, object))

deployment_id¶

[Required] Gets the deployment_id of this DeploymentBackupSummary. The OCID of the deployment being referenced.

Returns:	The deployment_id of this DeploymentBackupSummary.
Return type:	str

deployment_type¶

[Required] Gets the deployment_type of this DeploymentBackupSummary. The type of deployment, which can be any one of the Allowed values. NOTE: Use of the value ‘OGG’ is maintained for backward compatibility purposes.

Its use is discouraged in favor of ‘DATABASE_ORACLE’.

Allowed values for this property are: “OGG”, “DATABASE_ORACLE”, “BIGDATA”, “DATABASE_MICROSOFT_SQLSERVER”, “DATABASE_MYSQL”, “DATABASE_POSTGRESQL”, “DATABASE_DB2ZOS”, “GGSA”, “DATA_TRANSFORMS”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The deployment_type of this DeploymentBackupSummary.
Return type:	str

display_name¶

Gets the display_name of this DeploymentBackupSummary. An object’s Display Name.

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

freeform_tags¶

Gets the freeform_tags of this DeploymentBackupSummary. A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {“bar-key”: “value”}

Returns:	The freeform_tags of this DeploymentBackupSummary.
Return type:	dict(str, str)

id¶

[Required] Gets the id of this DeploymentBackupSummary. The OCID of the backup being referenced.

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

is_automatic¶

Gets the is_automatic of this DeploymentBackupSummary. True if this object is automatically created

Returns:	The is_automatic of this DeploymentBackupSummary.
Return type:	bool

is_metadata_only¶

Gets the is_metadata_only of this DeploymentBackupSummary. Parameter to allow users to create backup without trails

Returns:	The is_metadata_only of this DeploymentBackupSummary.
Return type:	bool

lifecycle_details¶

Gets the lifecycle_details of this DeploymentBackupSummary. Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

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

lifecycle_state¶

[Required] Gets the lifecycle_state of this DeploymentBackupSummary. Possible lifecycle states.

Allowed values for this property are: “CREATING”, “UPDATING”, “ACTIVE”, “INACTIVE”, “DELETING”, “DELETED”, “FAILED”, “NEEDS_ATTENTION”, “IN_PROGRESS”, “CANCELING”, “CANCELED”, “SUCCEEDED”, “WAITING”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

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

locks¶

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

Returns:	The locks of this DeploymentBackupSummary.
Return type:	list[oci.golden_gate.models.ResourceLock]

namespace_name¶

Gets the namespace_name of this DeploymentBackupSummary. Name of namespace that serves as a container for all of your buckets

Returns:	The namespace_name of this DeploymentBackupSummary.
Return type:	str

object_name¶

Gets the object_name of this DeploymentBackupSummary. Name of the object to be uploaded to object storage

Returns:	The object_name of this DeploymentBackupSummary.
Return type:	str

ogg_version¶

[Required] Gets the ogg_version of this DeploymentBackupSummary. Version of OGG

Returns:	The ogg_version of this DeploymentBackupSummary.
Return type:	str

size_in_bytes¶

Gets the size_in_bytes of this DeploymentBackupSummary. The size of the backup stored in object storage (in bytes)

Returns:	The size_in_bytes of this DeploymentBackupSummary.
Return type:	int

system_tags¶

Gets the system_tags of this DeploymentBackupSummary. The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

Returns:	The system_tags of this DeploymentBackupSummary.
Return type:	dict(str, dict(str, object))

time_backup_finished¶

Gets the time_backup_finished of this DeploymentBackupSummary. The time of the resource backup finish. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:	The time_backup_finished of this DeploymentBackupSummary.
Return type:	datetime

time_created¶

Gets the time_created of this DeploymentBackupSummary. The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

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

time_of_backup¶

Gets the time_of_backup of this DeploymentBackupSummary. The time of the resource backup. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:	The time_of_backup of this DeploymentBackupSummary.
Return type:	datetime

time_updated¶

Gets the time_updated of this DeploymentBackupSummary. The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:	The time_updated of this DeploymentBackupSummary.
Return type:	datetime