oci 2.117.0__py3-none-any.whl → 2.118.0__py3-none-any.whl

oci/psql/models/backup.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class Backup(object):
     """
-    Db system backup information
+    Database system backup information.
     """
 
     #: A constant which can be used with the source_type property of a Backup.
@@ -190,7 +190,9 @@ class Backup(object):
     def id(self):
         """
         **[Required]** Gets the id of this Backup.
-        Unique identifier that is immutable on creation
+        The `OCID`__ of the backup.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The id of this Backup.
@@ -202,7 +204,9 @@ class Backup(object):
     def id(self, id):
         """
         Sets the id of this Backup.
-        Unique identifier that is immutable on creation
+        The `OCID`__ of the backup.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param id: The id of this Backup.
@@ -214,7 +218,7 @@ class Backup(object):
     def display_name(self):
         """
         **[Required]** Gets the display_name of this Backup.
-        Backup display name
+        A user-friendly display name for the backup. Avoid entering confidential information.
 
 
         :return: The display_name of this Backup.
@@ -226,7 +230,7 @@ class Backup(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this Backup.
-        Backup display name
+        A user-friendly display name for the backup. Avoid entering confidential information.
 
 
         :param display_name: The display_name of this Backup.
@@ -238,7 +242,7 @@ class Backup(object):
     def description(self):
         """
         Gets the description of this Backup.
-        Backup description
+        A description for the backup.
 
 
         :return: The description of this Backup.
@@ -250,7 +254,7 @@ class Backup(object):
     def description(self, description):
         """
         Sets the description of this Backup.
-        Backup description
+        A description for the backup.
 
 
         :param description: The description of this Backup.
@@ -262,7 +266,9 @@ class Backup(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this Backup.
-        Backup compartment identifier
+        The `OCID`__ of the compartment that contains the backup.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The compartment_id of this Backup.
@@ -274,7 +280,9 @@ class Backup(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this Backup.
-        Backup compartment identifier
+        The `OCID`__ of the compartment that contains the backup.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param compartment_id: The compartment_id of this Backup.
@@ -286,7 +294,7 @@ class Backup(object):
     def source_type(self):
         """
         Gets the source_type of this Backup.
-        Specifies whether the backup was created manually, or via scheduled backup policy
+        Specifies whether the backup was created manually, or by a management policy.
 
         Allowed values for this property are: "SCHEDULED", "MANUAL", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -301,7 +309,7 @@ class Backup(object):
     def source_type(self, source_type):
         """
         Sets the source_type of this Backup.
-        Specifies whether the backup was created manually, or via scheduled backup policy
+        Specifies whether the backup was created manually, or by a management policy.
 
 
         :param source_type: The source_type of this Backup.
@@ -316,7 +324,12 @@ class Backup(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this Backup.
-        The time the the Backup was created. An RFC3339 formatted datetime string
+        The date and time the backup was created, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The time_created of this Backup.
@@ -328,7 +341,12 @@ class Backup(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this Backup.
-        The time the the Backup was created. An RFC3339 formatted datetime string
+        The date and time the backup was created, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param time_created: The time_created of this Backup.
@@ -340,7 +358,12 @@ class Backup(object):
     def time_updated(self):
         """
         Gets the time_updated of this Backup.
-        The time the Backup was updated. An RFC3339 formatted datetime string
+        The date and time the backup was updated, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The time_updated of this Backup.
@@ -352,7 +375,12 @@ class Backup(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this Backup.
-        The time the Backup was updated. An RFC3339 formatted datetime string
+        The date and time the backup was updated, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param time_updated: The time_updated of this Backup.
@@ -364,7 +392,7 @@ class Backup(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this Backup.
-        The current state of the Backup.
+        The current state of the backup.
 
         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'.
@@ -379,7 +407,7 @@ class Backup(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this Backup.
-        The current state of the Backup.
+        The current state of the backup.
 
 
         :param lifecycle_state: The lifecycle_state of this Backup.
@@ -442,7 +470,7 @@ class Backup(object):
     def backup_size(self):
         """
         **[Required]** Gets the backup_size of this Backup.
-        Backup size in GB.
+        The size of the backup, in gigabytes.
 
 
         :return: The backup_size of this Backup.
@@ -454,7 +482,7 @@ class Backup(object):
     def backup_size(self, backup_size):
         """
         Sets the backup_size of this Backup.
-        Backup size in GB.
+        The size of the backup, in gigabytes.
 
 
         :param backup_size: The backup_size of this Backup.
@@ -466,7 +494,9 @@ class Backup(object):
     def db_system_id(self):
         """
         Gets the db_system_id of this Backup.
-        The source DbSystem OCID.
+        The `OCID`__ of the backup's source database system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The db_system_id of this Backup.
@@ -478,7 +508,9 @@ class Backup(object):
     def db_system_id(self, db_system_id):
         """
         Sets the db_system_id of this Backup.
-        The source DbSystem OCID.
+        The `OCID`__ of the backup's source database system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param db_system_id: The db_system_id of this Backup.

oci/psql/models/backup_policy.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class BackupPolicy(object):
     """
-    Posgresql DB system backup policy
+    PostgreSQL database system backup policy.
     """
 
     #: A constant which can be used with the kind property of a BackupPolicy.
@@ -93,7 +93,7 @@ class BackupPolicy(object):
     def kind(self):
         """
         Gets the kind of this BackupPolicy.
-        Backup policy kind
+        The kind of backup policy.
 
         Allowed values for this property are: "DAILY", "WEEKLY", "MONTHLY", "NONE", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -108,7 +108,7 @@ class BackupPolicy(object):
     def kind(self, kind):
         """
         Sets the kind of this BackupPolicy.
-        Backup policy kind
+        The kind of backup policy.
 
 
         :param kind: The kind of this BackupPolicy.
@@ -123,7 +123,7 @@ class BackupPolicy(object):
     def retention_days(self):
         """
         Gets the retention_days of this BackupPolicy.
-        How many days the customers data should be stored after the db system deletion.
+        How many days the data should be stored after the database system deletion.
 
 
         :return: The retention_days of this BackupPolicy.
@@ -135,7 +135,7 @@ class BackupPolicy(object):
     def retention_days(self, retention_days):
         """
         Sets the retention_days of this BackupPolicy.
-        How many days the customers data should be stored after the db system deletion.
+        How many days the data should be stored after the database system deletion.
 
 
         :param retention_days: The retention_days of this BackupPolicy.

oci/psql/models/backup_source_details.py

@@ -12,7 +12,8 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class BackupSourceDetails(SourceDetails):
     """
-    Restoring to a new DbSystem from the backup. The DbSystem details that are part of the CreateDbSystem request are not required, but if present will override the backup's DbSystem details snapshot.
+    Restoring to a new database system from the backup.
+    The database system details that are part of the CreateDbSystem request are not required, but if present will override the details from the backup's database system snapshot.
     """
 
     def __init__(self, **kwargs):
@@ -56,7 +57,9 @@ class BackupSourceDetails(SourceDetails):
     def backup_id(self):
         """
         **[Required]** Gets the backup_id of this BackupSourceDetails.
-        DbSystem backup identifier.
+        The `OCID`__ of the database system backup.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The backup_id of this BackupSourceDetails.
@@ -68,7 +71,9 @@ class BackupSourceDetails(SourceDetails):
     def backup_id(self, backup_id):
         """
         Sets the backup_id of this BackupSourceDetails.
-        DbSystem backup identifier.
+        The `OCID`__ of the database system backup.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param backup_id: The backup_id of this BackupSourceDetails.
@@ -80,7 +85,7 @@ class BackupSourceDetails(SourceDetails):
     def is_having_restore_config_overrides(self):
         """
         Gets the is_having_restore_config_overrides of this BackupSourceDetails.
-        Restore the DB config overrides from backup. Default is false
+        Deprecated. Don't use.
 
 
         :return: The is_having_restore_config_overrides of this BackupSourceDetails.
@@ -92,7 +97,7 @@ class BackupSourceDetails(SourceDetails):
     def is_having_restore_config_overrides(self, is_having_restore_config_overrides):
         """
         Sets the is_having_restore_config_overrides of this BackupSourceDetails.
-        Restore the DB config overrides from backup. Default is false
+        Deprecated. Don't use.
 
 
         :param is_having_restore_config_overrides: The is_having_restore_config_overrides of this BackupSourceDetails.

oci/psql/models/backup_summary.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class BackupSummary(object):
     """
-    Summary of the Backup.
+    Summary information for a backup.
     """
 
     def __init__(self, **kwargs):
@@ -130,7 +130,7 @@ class BackupSummary(object):
     def id(self):
         """
         **[Required]** Gets the id of this BackupSummary.
-        Unique identifier that is immutable on creation
+        A unique identifier for the backup. Immutable on creation.
 
 
         :return: The id of this BackupSummary.
@@ -142,7 +142,7 @@ class BackupSummary(object):
     def id(self, id):
         """
         Sets the id of this BackupSummary.
-        Unique identifier that is immutable on creation
+        A unique identifier for the backup. Immutable on creation.
 
 
         :param id: The id of this BackupSummary.
@@ -154,7 +154,7 @@ class BackupSummary(object):
     def display_name(self):
         """
         **[Required]** Gets the display_name of this BackupSummary.
-        Backup identifier, can be renamed
+        A user-friendly display name for the backup. Avoid entering confidential information.
 
 
         :return: The display_name of this BackupSummary.
@@ -166,7 +166,7 @@ class BackupSummary(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this BackupSummary.
-        Backup identifier, can be renamed
+        A user-friendly display name for the backup. Avoid entering confidential information.
 
 
         :param display_name: The display_name of this BackupSummary.
@@ -178,7 +178,9 @@ class BackupSummary(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this BackupSummary.
-        Compartment identifier
+        The `OCID`__ of the compartment that contains the backup.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The compartment_id of this BackupSummary.
@@ -190,7 +192,9 @@ class BackupSummary(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this BackupSummary.
-        Compartment identifier
+        The `OCID`__ of the compartment that contains the backup.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param compartment_id: The compartment_id of this BackupSummary.
@@ -202,7 +206,12 @@ class BackupSummary(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this BackupSummary.
-        The time the the Backup was created. An RFC3339 formatted datetime string
+        The date and time the backup was created, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The time_created of this BackupSummary.
@@ -214,7 +223,12 @@ class BackupSummary(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this BackupSummary.
-        The time the the Backup was created. An RFC3339 formatted datetime string
+        The date and time the backup was created, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param time_created: The time_created of this BackupSummary.
@@ -226,7 +240,12 @@ class BackupSummary(object):
     def time_updated(self):
         """
         Gets the time_updated of this BackupSummary.
-        The time the Backup was updated. An RFC3339 formatted datetime string
+        The date and time the backup was updated, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :return: The time_updated of this BackupSummary.
@@ -238,7 +257,12 @@ class BackupSummary(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this BackupSummary.
-        The time the Backup was updated. An RFC3339 formatted datetime string
+        The date and time the backup was updated, expressed in
+        `RFC 3339`__ timestamp format.
+
+        Example: `2016-08-25T21:10:29.600Z`
+
+        __ https://tools.ietf.org/rfc/rfc3339
 
 
         :param time_updated: The time_updated of this BackupSummary.
@@ -250,7 +274,7 @@ class BackupSummary(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this BackupSummary.
-        The current state of the Backup.
+        The current state of the backup.
 
 
         :return: The lifecycle_state of this BackupSummary.
@@ -262,7 +286,7 @@ class BackupSummary(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this BackupSummary.
-        The current state of the Backup.
+        The current state of the backup.
 
 
         :param lifecycle_state: The lifecycle_state of this BackupSummary.
@@ -298,7 +322,7 @@ class BackupSummary(object):
     def source_type(self):
         """
         Gets the source_type of this BackupSummary.
-        Specifies whether the backup was created manually, or via scheduled backup policy
+        Specifies whether the backup was created manually, or by a management policy.
 
 
         :return: The source_type of this BackupSummary.
@@ -310,7 +334,7 @@ class BackupSummary(object):
     def source_type(self, source_type):
         """
         Sets the source_type of this BackupSummary.
-        Specifies whether the backup was created manually, or via scheduled backup policy
+        Specifies whether the backup was created manually, or by a management policy.
 
 
         :param source_type: The source_type of this BackupSummary.
@@ -322,7 +346,7 @@ class BackupSummary(object):
     def backup_size(self):
         """
         Gets the backup_size of this BackupSummary.
-        Backup size in GB.
+        The size of the backup, in gigabytes.
 
 
         :return: The backup_size of this BackupSummary.
@@ -334,7 +358,7 @@ class BackupSummary(object):
     def backup_size(self, backup_size):
         """
         Sets the backup_size of this BackupSummary.
-        Backup size in GB.
+        The size of the backup, in gigabytes.
 
 
         :param backup_size: The backup_size of this BackupSummary.
@@ -346,7 +370,9 @@ class BackupSummary(object):
     def db_system_id(self):
         """
         Gets the db_system_id of this BackupSummary.
-        The source DbSystem OCID.
+        The backup's source database system's `OCID`__.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The db_system_id of this BackupSummary.
@@ -358,7 +384,9 @@ class BackupSummary(object):
     def db_system_id(self, db_system_id):
         """
         Sets the db_system_id of this BackupSummary.
-        The source DbSystem OCID.
+        The backup's source database system's `OCID`__.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param db_system_id: The db_system_id of this BackupSummary.

oci/psql/models/change_backup_compartment_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ChangeBackupCompartmentDetails(object):
     """
-    The backup information to move it a different compartment.
+    The information used to move a backup to a different compartment.
     """
 
     def __init__(self, **kwargs):
@@ -39,8 +39,9 @@ class ChangeBackupCompartmentDetails(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this ChangeBackupCompartmentDetails.
-        The identifier of the compartment
-        into which the resource should be moved.
+        The `OCID`__ of the compartment into which the backup will be moved.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The compartment_id of this ChangeBackupCompartmentDetails.
@@ -52,8 +53,9 @@ class ChangeBackupCompartmentDetails(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this ChangeBackupCompartmentDetails.
-        The identifier of the compartment
-        into which the resource should be moved.
+        The `OCID`__ of the compartment into which the backup will be moved.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param compartment_id: The compartment_id of this ChangeBackupCompartmentDetails.

oci/psql/models/change_configuration_compartment_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ChangeConfigurationCompartmentDetails(object):
     """
-    The Configuration information to move it a different compartment.
+    The information to move a configuration to a different compartment.
     """
 
     def __init__(self, **kwargs):
@@ -39,8 +39,9 @@ class ChangeConfigurationCompartmentDetails(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this ChangeConfigurationCompartmentDetails.
-        The identifier of the compartment
-        into which the resource should be moved.
+        The `OCID`__ of the compartment into which the configuration will be moved.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The compartment_id of this ChangeConfigurationCompartmentDetails.
@@ -52,8 +53,9 @@ class ChangeConfigurationCompartmentDetails(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this ChangeConfigurationCompartmentDetails.
-        The identifier of the compartment
-        into which the resource should be moved.
+        The `OCID`__ of the compartment into which the configuration will be moved.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param compartment_id: The compartment_id of this ChangeConfigurationCompartmentDetails.

oci/psql/models/change_db_system_compartment_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ChangeDbSystemCompartmentDetails(object):
     """
-    Change db system compartment operation details.
+    Change database system compartment operation details.
     """
 
     def __init__(self, **kwargs):
@@ -40,7 +40,7 @@ class ChangeDbSystemCompartmentDetails(object):
         """
         **[Required]** Gets the compartment_id of this ChangeDbSystemCompartmentDetails.
         The `OCID`__ of the compartment
-        into which the resource should be moved.
+        into which the database system should be moved.
 
         __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
@@ -55,7 +55,7 @@ class ChangeDbSystemCompartmentDetails(object):
         """
         Sets the compartment_id of this ChangeDbSystemCompartmentDetails.
         The `OCID`__ of the compartment
-        into which the resource should be moved.
+        into which the database system should be moved.
 
         __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 

oci/psql/models/config_overrides.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ConfigOverrides(object):
     """
-    Configuration Overrides for PGSQL instance.
+    Configuration overrides for a PostgreSQL instance.
     """
 
     def __init__(self, **kwargs):
@@ -46,7 +46,7 @@ class ConfigOverrides(object):
     def config_key(self):
         """
         **[Required]** Gets the config_key of this ConfigOverrides.
-        Key is the configuration key.
+        Configuration variable name.
 
 
         :return: The config_key of this ConfigOverrides.
@@ -58,7 +58,7 @@ class ConfigOverrides(object):
     def config_key(self, config_key):
         """
         Sets the config_key of this ConfigOverrides.
-        Key is the configuration key.
+        Configuration variable name.
 
 
         :param config_key: The config_key of this ConfigOverrides.
@@ -70,7 +70,7 @@ class ConfigOverrides(object):
     def overriden_config_value(self):
         """
         **[Required]** Gets the overriden_config_value of this ConfigOverrides.
-        User selected configuration value
+        User-selected variable value.
 
 
         :return: The overriden_config_value of this ConfigOverrides.
@@ -82,7 +82,7 @@ class ConfigOverrides(object):
     def overriden_config_value(self, overriden_config_value):
         """
         Sets the overriden_config_value of this ConfigOverrides.
-        User selected configuration value
+        User-selected variable value.
 
 
         :param overriden_config_value: The overriden_config_value of this ConfigOverrides.