DeploymentBackup

class oci.golden_gate.models.DeploymentBackup(**kwargs)

Bases: object

A backup of the current state of the GoldenGate deployment. Can be used to restore a deployment, or create a new deployment with that state as the starting deployment state.

Attributes:

BACKUP_SOURCE_TYPE_AUTOMATIC

A constant which can be used with the backup_source_type property of a DeploymentBackup.

BACKUP_SOURCE_TYPE_MANUAL

A constant which can be used with the backup_source_type property of a DeploymentBackup.

BACKUP_SOURCE_TYPE_SCHEDULED

A constant which can be used with the backup_source_type property of a DeploymentBackup.

BACKUP_TYPE_FULL

A constant which can be used with the backup_type property of a DeploymentBackup.

BACKUP_TYPE_INCREMENTAL

A constant which can be used with the backup_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_BIGDATA

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_DATABASE_DB2_I

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_DATABASE_DB2_ZOS

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_DATABASE_MICROSOFT_SQLSERVER

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_DATABASE_MYSQL

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_DATABASE_ORACLE

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_DATABASE_POSTGRESQL

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_DATA_TRANSFORMS

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_GGSA

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_OGG

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_VERIDATA_AGENT

A constant which can be used with the deployment_type property of a DeploymentBackup.

DEPLOYMENT_TYPE_VERIDATA_SERVER

A constant which can be used with the deployment_type property of a DeploymentBackup.

LIFECYCLE_STATE_ACTIVE

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

LIFECYCLE_STATE_CANCELED

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

LIFECYCLE_STATE_CANCELING

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

LIFECYCLE_STATE_CREATING

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

LIFECYCLE_STATE_DELETED

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

LIFECYCLE_STATE_DELETING

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

LIFECYCLE_STATE_FAILED

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

backup_source_type

Gets the backup_source_type of this DeploymentBackup.

backup_type

Gets the backup_type of this DeploymentBackup.

bucket_name

Gets the bucket_name of this DeploymentBackup.

compartment_id

[Required] Gets the compartment_id of this DeploymentBackup.

defined_tags

Gets the defined_tags of this DeploymentBackup.

deployment_id

[Required] Gets the deployment_id of this DeploymentBackup.

deployment_type

[Required] Gets the deployment_type of this DeploymentBackup. 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'.

display_name

Gets the display_name of this DeploymentBackup.

freeform_tags

Gets the freeform_tags of this DeploymentBackup.

id

[Required] Gets the id of this DeploymentBackup.

is_automatic

Gets the is_automatic of this DeploymentBackup.

is_metadata_only

Gets the is_metadata_only of this DeploymentBackup.

lifecycle_details

Gets the lifecycle_details of this DeploymentBackup.

lifecycle_state

[Required] Gets the lifecycle_state of this DeploymentBackup.

locks

Gets the locks of this DeploymentBackup.

namespace_name

Gets the namespace_name of this DeploymentBackup.

object_name

Gets the object_name of this DeploymentBackup.

ogg_version

[Required] Gets the ogg_version of this DeploymentBackup.

size_in_bytes

Gets the size_in_bytes of this DeploymentBackup.

system_tags

Gets the system_tags of this DeploymentBackup.

time_backup_finished

Gets the time_backup_finished of this DeploymentBackup.

time_created

Gets the time_created of this DeploymentBackup.

time_of_backup

Gets the time_of_backup of this DeploymentBackup.

time_updated

Gets the time_updated of this DeploymentBackup.

Methods:

__init__(**kwargs)

Initializes a new DeploymentBackup object with values from keyword arguments.

BACKUP_SOURCE_TYPE_AUTOMATIC = 'AUTOMATIC'

A constant which can be used with the backup_source_type property of a DeploymentBackup. This constant has a value of “AUTOMATIC”

BACKUP_SOURCE_TYPE_MANUAL = 'MANUAL'

A constant which can be used with the backup_source_type property of a DeploymentBackup. This constant has a value of “MANUAL”

BACKUP_SOURCE_TYPE_SCHEDULED = 'SCHEDULED'

A constant which can be used with the backup_source_type property of a DeploymentBackup. This constant has a value of “SCHEDULED”

BACKUP_TYPE_FULL = 'FULL'

A constant which can be used with the backup_type property of a DeploymentBackup. This constant has a value of “FULL”

BACKUP_TYPE_INCREMENTAL = 'INCREMENTAL'

A constant which can be used with the backup_type property of a DeploymentBackup. This constant has a value of “INCREMENTAL”

DEPLOYMENT_TYPE_BIGDATA = 'BIGDATA'

A constant which can be used with the deployment_type property of a DeploymentBackup. This constant has a value of “BIGDATA”

DEPLOYMENT_TYPE_DATABASE_DB2_I = 'DATABASE_DB2I'

A constant which can be used with the deployment_type property of a DeploymentBackup. This constant has a value of “DATABASE_DB2I”

DEPLOYMENT_TYPE_DATABASE_DB2_ZOS = 'DATABASE_DB2ZOS'

A constant which can be used with the deployment_type property of a DeploymentBackup. 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 DeploymentBackup. 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 DeploymentBackup. 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 DeploymentBackup. 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 DeploymentBackup. 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 DeploymentBackup. 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 DeploymentBackup. This constant has a value of “GGSA”

DEPLOYMENT_TYPE_OGG = 'OGG'

A constant which can be used with the deployment_type property of a DeploymentBackup. This constant has a value of “OGG”

DEPLOYMENT_TYPE_VERIDATA_AGENT = 'VERIDATA_AGENT'

A constant which can be used with the deployment_type property of a DeploymentBackup. This constant has a value of “VERIDATA_AGENT”

DEPLOYMENT_TYPE_VERIDATA_SERVER = 'VERIDATA_SERVER'

A constant which can be used with the deployment_type property of a DeploymentBackup. This constant has a value of “VERIDATA_SERVER”

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'

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

LIFECYCLE_STATE_CANCELED = 'CANCELED'

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

LIFECYCLE_STATE_CANCELING = 'CANCELING'

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

LIFECYCLE_STATE_CREATING = 'CREATING'

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

LIFECYCLE_STATE_DELETED = 'DELETED'

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

LIFECYCLE_STATE_DELETING = 'DELETING'

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

LIFECYCLE_STATE_FAILED = 'FAILED'

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

__init__(**kwargs)

Initializes a new DeploymentBackup 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 DeploymentBackup.

  • deployment_id (str) – The value to assign to the deployment_id property of this DeploymentBackup.

  • deployment_type (str) – The value to assign to the deployment_type property of this DeploymentBackup. Allowed values for this property are: “OGG”, “DATABASE_ORACLE”, “BIGDATA”, “DATABASE_MICROSOFT_SQLSERVER”, “DATABASE_MYSQL”, “DATABASE_POSTGRESQL”, “DATABASE_DB2ZOS”, “DATABASE_DB2I”, “GGSA”, “DATA_TRANSFORMS”, “VERIDATA_SERVER”, “VERIDATA_AGENT”, ‘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 DeploymentBackup.

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

  • is_automatic (bool) – The value to assign to the is_automatic property of this DeploymentBackup.

  • backup_source_type (str) – The value to assign to the backup_source_type property of this DeploymentBackup. Allowed values for this property are: “MANUAL”, “AUTOMATIC”, “SCHEDULED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this DeploymentBackup. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, “CANCELING”, “CANCELED”, ‘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 DeploymentBackup.

  • time_of_backup (datetime) – The value to assign to the time_of_backup property of this DeploymentBackup.

  • time_backup_finished (datetime) – The value to assign to the time_backup_finished property of this DeploymentBackup.

  • size_in_bytes (int) – The value to assign to the size_in_bytes property of this DeploymentBackup.

  • backup_type (str) – The value to assign to the backup_type property of this DeploymentBackup. 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 DeploymentBackup.

  • namespace_name (str) – The value to assign to the namespace_name property of this DeploymentBackup.

  • bucket_name (str) – The value to assign to the bucket_name property of this DeploymentBackup.

  • object_name (str) – The value to assign to the object_name property of this DeploymentBackup.

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

  • time_updated (datetime) – The value to assign to the time_updated property of this DeploymentBackup.

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

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

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

  • is_metadata_only (bool) – The value to assign to the is_metadata_only property of this DeploymentBackup.

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

property backup_source_type

Gets the backup_source_type of this DeploymentBackup. Possible deployment backup source types.

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

Returns

The backup_source_type of this DeploymentBackup.

Return type

str

property backup_type

Gets the backup_type of this DeploymentBackup. 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 DeploymentBackup.

Return type

str

property bucket_name

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

Returns

The bucket_name of this DeploymentBackup.

Return type

str

property compartment_id

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

Returns

The compartment_id of this DeploymentBackup.

Return type

str

property defined_tags

Gets the defined_tags of this DeploymentBackup. 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 DeploymentBackup.

Return type

dict(str, dict(str, object))

property deployment_id

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

Returns

The deployment_id of this DeploymentBackup.

Return type

str

property deployment_type

[Required] Gets the deployment_type of this DeploymentBackup. 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”, “DATABASE_DB2I”, “GGSA”, “DATA_TRANSFORMS”, “VERIDATA_SERVER”, “VERIDATA_AGENT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns

The deployment_type of this DeploymentBackup.

Return type

str

property display_name

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

Returns

The display_name of this DeploymentBackup.

Return type

str

property freeform_tags

Gets the freeform_tags of this DeploymentBackup. 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 DeploymentBackup.

Return type

dict(str, str)

property id

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

Returns

The id of this DeploymentBackup.

Return type

str

property is_automatic

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

Returns

The is_automatic of this DeploymentBackup.

Return type

bool

property is_metadata_only

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

Returns

The is_metadata_only of this DeploymentBackup.

Return type

bool

property lifecycle_details

Gets the lifecycle_details of this DeploymentBackup. 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 DeploymentBackup.

Return type

str

property lifecycle_state

[Required] Gets the lifecycle_state of this DeploymentBackup. Possible lifecycle states for a Deployment Backup.

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

Returns

The lifecycle_state of this DeploymentBackup.

Return type

str

property locks

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

Returns

The locks of this DeploymentBackup.

Return type

list[oci.golden_gate.models.ResourceLock]

property namespace_name

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

Returns

The namespace_name of this DeploymentBackup.

Return type

str

property object_name

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

Returns

The object_name of this DeploymentBackup.

Return type

str

property ogg_version

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

Returns

The ogg_version of this DeploymentBackup.

Return type

str

property size_in_bytes

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

Returns

The size_in_bytes of this DeploymentBackup.

Return type

int

property system_tags

Gets the system_tags of this DeploymentBackup. 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 DeploymentBackup.

Return type

dict(str, dict(str, object))

property time_backup_finished

Gets the time_backup_finished of this DeploymentBackup. 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 DeploymentBackup.

Return type

datetime

property time_created

Gets the time_created of this DeploymentBackup. 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 DeploymentBackup.

Return type

datetime

property time_of_backup

Gets the time_of_backup of this DeploymentBackup. 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 DeploymentBackup.

Return type

datetime

property time_updated

Gets the time_updated of this DeploymentBackup. 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 DeploymentBackup.

Return type

datetime