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

oci/psql/models/db_system_summary.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DbSystemSummary(object):
     """
-    Summary of the DbSystem.
+    Summary information about a database system.
     """
 
     def __init__(self, **kwargs):
@@ -151,7 +151,7 @@ class DbSystemSummary(object):
     def id(self):
         """
         **[Required]** Gets the id of this DbSystemSummary.
-        Unique identifier that is immutable on creation
+        A unique identifier for the database system. Immutable on creation.
 
 
         :return: The id of this DbSystemSummary.
@@ -163,7 +163,7 @@ class DbSystemSummary(object):
     def id(self, id):
         """
         Sets the id of this DbSystemSummary.
-        Unique identifier that is immutable on creation
+        A unique identifier for the database system. Immutable on creation.
 
 
         :param id: The id of this DbSystemSummary.
@@ -175,7 +175,7 @@ class DbSystemSummary(object):
     def display_name(self):
         """
         **[Required]** Gets the display_name of this DbSystemSummary.
-        DbSystem display name
+        A user-friendly display name for the database system. Avoid entering confidential information.
 
 
         :return: The display_name of this DbSystemSummary.
@@ -187,7 +187,7 @@ class DbSystemSummary(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this DbSystemSummary.
-        DbSystem display name
+        A user-friendly display name for the database system. Avoid entering confidential information.
 
 
         :param display_name: The display_name of this DbSystemSummary.
@@ -199,7 +199,9 @@ class DbSystemSummary(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this DbSystemSummary.
-        Compartment identifier
+        The `OCID`__ of the compartment that contains the database system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The compartment_id of this DbSystemSummary.
@@ -211,7 +213,9 @@ class DbSystemSummary(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this DbSystemSummary.
-        Compartment identifier
+        The `OCID`__ of the compartment that contains the database system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param compartment_id: The compartment_id of this DbSystemSummary.
@@ -223,7 +227,12 @@ class DbSystemSummary(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this DbSystemSummary.
-        The time the the DbSystem was created. An RFC3339 formatted datetime string
+        The date and time that the database system 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 DbSystemSummary.
@@ -235,7 +244,12 @@ class DbSystemSummary(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this DbSystemSummary.
-        The time the the DbSystem was created. An RFC3339 formatted datetime string
+        The date and time that the database system 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 DbSystemSummary.
@@ -247,7 +261,12 @@ class DbSystemSummary(object):
     def time_updated(self):
         """
         Gets the time_updated of this DbSystemSummary.
-        The time the DbSystem was updated. An RFC3339 formatted datetime string
+        The date and time that the database system 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 DbSystemSummary.
@@ -259,7 +278,12 @@ class DbSystemSummary(object):
     def time_updated(self, time_updated):
         """
         Sets the time_updated of this DbSystemSummary.
-        The time the DbSystem was updated. An RFC3339 formatted datetime string
+        The date and time that the database system 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 DbSystemSummary.
@@ -271,7 +295,7 @@ class DbSystemSummary(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this DbSystemSummary.
-        The current state of the DbSystem.
+        The current state of the database system.
 
 
         :return: The lifecycle_state of this DbSystemSummary.
@@ -283,7 +307,7 @@ class DbSystemSummary(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this DbSystemSummary.
-        The current state of the DbSystem.
+        The current state of the database system.
 
 
         :param lifecycle_state: The lifecycle_state of this DbSystemSummary.
@@ -319,7 +343,7 @@ class DbSystemSummary(object):
     def system_type(self):
         """
         **[Required]** Gets the system_type of this DbSystemSummary.
-        Type of the DbSystem.
+        Type of the database system.
 
 
         :return: The system_type of this DbSystemSummary.
@@ -331,7 +355,7 @@ class DbSystemSummary(object):
     def system_type(self, system_type):
         """
         Sets the system_type of this DbSystemSummary.
-        Type of the DbSystem.
+        Type of the database system.
 
 
         :param system_type: The system_type of this DbSystemSummary.
@@ -343,7 +367,7 @@ class DbSystemSummary(object):
     def instance_count(self):
         """
         **[Required]** Gets the instance_count of this DbSystemSummary.
-        Count of DbInstances in the DbSystem.
+        Count of database instances, or nodes, in the database system.
 
 
         :return: The instance_count of this DbSystemSummary.
@@ -355,7 +379,7 @@ class DbSystemSummary(object):
     def instance_count(self, instance_count):
         """
         Sets the instance_count of this DbSystemSummary.
-        Count of DbInstances in the DbSystem.
+        Count of database instances, or nodes, in the database system.
 
 
         :param instance_count: The instance_count of this DbSystemSummary.
@@ -367,7 +391,8 @@ class DbSystemSummary(object):
     def shape(self):
         """
         Gets the shape of this DbSystemSummary.
-        Shape of dbInstance.
+        The name of the shape for the database instance node.
+        Example: `VM.Standard.E4.Flex`
 
 
         :return: The shape of this DbSystemSummary.
@@ -379,7 +404,8 @@ class DbSystemSummary(object):
     def shape(self, shape):
         """
         Sets the shape of this DbSystemSummary.
-        Shape of dbInstance.
+        The name of the shape for the database instance node.
+        Example: `VM.Standard.E4.Flex`
 
 
         :param shape: The shape of this DbSystemSummary.
@@ -391,7 +417,7 @@ class DbSystemSummary(object):
     def instance_ocpu_count(self):
         """
         **[Required]** Gets the instance_ocpu_count of this DbSystemSummary.
-        The total number of OCPUs available to each DbInstance.
+        The total number of OCPUs available to each database instance node.
 
 
         :return: The instance_ocpu_count of this DbSystemSummary.
@@ -403,7 +429,7 @@ class DbSystemSummary(object):
     def instance_ocpu_count(self, instance_ocpu_count):
         """
         Sets the instance_ocpu_count of this DbSystemSummary.
-        The total number of OCPUs available to each DbInstance.
+        The total number of OCPUs available to each database instance node.
 
 
         :param instance_ocpu_count: The instance_ocpu_count of this DbSystemSummary.
@@ -415,7 +441,7 @@ class DbSystemSummary(object):
     def instance_memory_size_in_gbs(self):
         """
         **[Required]** Gets the instance_memory_size_in_gbs of this DbSystemSummary.
-        The total amount of memory available to each DbInstance, in gigabytes.
+        The total amount of memory available to each database instance node, in gigabytes.
 
 
         :return: The instance_memory_size_in_gbs of this DbSystemSummary.
@@ -427,7 +453,7 @@ class DbSystemSummary(object):
     def instance_memory_size_in_gbs(self, instance_memory_size_in_gbs):
         """
         Sets the instance_memory_size_in_gbs of this DbSystemSummary.
-        The total amount of memory available to each DbInstance, in gigabytes.
+        The total amount of memory available to each database instance node, in gigabytes.
 
 
         :param instance_memory_size_in_gbs: The instance_memory_size_in_gbs of this DbSystemSummary.
@@ -439,7 +465,7 @@ class DbSystemSummary(object):
     def db_version(self):
         """
         **[Required]** Gets the db_version of this DbSystemSummary.
-        Version of DbSystem software.
+        Version of database system software.
 
 
         :return: The db_version of this DbSystemSummary.
@@ -451,7 +477,7 @@ class DbSystemSummary(object):
     def db_version(self, db_version):
         """
         Sets the db_version of this DbSystemSummary.
-        Version of DbSystem software.
+        Version of database system software.
 
 
         :param db_version: The db_version of this DbSystemSummary.
@@ -463,7 +489,9 @@ class DbSystemSummary(object):
     def config_id(self):
         """
         Gets the config_id of this DbSystemSummary.
-        Configuration identifier
+        The `OCID`__ of the configuration associated with the database system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The config_id of this DbSystemSummary.
@@ -475,7 +503,9 @@ class DbSystemSummary(object):
     def config_id(self, config_id):
         """
         Sets the config_id of this DbSystemSummary.
-        Configuration identifier
+        The `OCID`__ of the configuration associated with the database system.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param config_id: The config_id of this DbSystemSummary.

oci/psql/models/default_config_params.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DefaultConfigParams(object):
     """
-    Default DB Configuration
+    Default database configuration.
     """
 
     def __init__(self, **kwargs):
@@ -81,7 +81,7 @@ class DefaultConfigParams(object):
     def config_key(self):
         """
         **[Required]** Gets the config_key of this DefaultConfigParams.
-        Key is the configuration key.
+        The configuration variable name.
 
 
         :return: The config_key of this DefaultConfigParams.
@@ -93,7 +93,7 @@ class DefaultConfigParams(object):
     def config_key(self, config_key):
         """
         Sets the config_key of this DefaultConfigParams.
-        Key is the configuration key.
+        The configuration variable name.
 
 
         :param config_key: The config_key of this DefaultConfigParams.
@@ -105,7 +105,7 @@ class DefaultConfigParams(object):
     def default_config_value(self):
         """
         **[Required]** Gets the default_config_value of this DefaultConfigParams.
-        Default value
+        Default value for the variable.
 
 
         :return: The default_config_value of this DefaultConfigParams.
@@ -117,7 +117,7 @@ class DefaultConfigParams(object):
     def default_config_value(self, default_config_value):
         """
         Sets the default_config_value of this DefaultConfigParams.
-        Default value
+        Default value for the variable.
 
 
         :param default_config_value: The default_config_value of this DefaultConfigParams.
@@ -129,7 +129,7 @@ class DefaultConfigParams(object):
     def allowed_values(self):
         """
         **[Required]** Gets the allowed_values of this DefaultConfigParams.
-        Range or list of allowed values
+        Range or list of allowed values.
 
 
         :return: The allowed_values of this DefaultConfigParams.
@@ -141,7 +141,7 @@ class DefaultConfigParams(object):
     def allowed_values(self, allowed_values):
         """
         Sets the allowed_values of this DefaultConfigParams.
-        Range or list of allowed values
+        Range or list of allowed values.
 
 
         :param allowed_values: The allowed_values of this DefaultConfigParams.
@@ -153,7 +153,7 @@ class DefaultConfigParams(object):
     def is_restart_required(self):
         """
         **[Required]** Gets the is_restart_required of this DefaultConfigParams.
-        If true, modfying this configuration value will requires restart.
+        If true, modifying this configuration value will require a restart.
 
 
         :return: The is_restart_required of this DefaultConfigParams.
@@ -165,7 +165,7 @@ class DefaultConfigParams(object):
     def is_restart_required(self, is_restart_required):
         """
         Sets the is_restart_required of this DefaultConfigParams.
-        If true, modfying this configuration value will requires restart.
+        If true, modifying this configuration value will require a restart.
 
 
         :param is_restart_required: The is_restart_required of this DefaultConfigParams.
@@ -177,7 +177,7 @@ class DefaultConfigParams(object):
     def data_type(self):
         """
         **[Required]** Gets the data_type of this DefaultConfigParams.
-        Describes about the Datatype value.
+        Data type of the variable.
 
 
         :return: The data_type of this DefaultConfigParams.
@@ -189,7 +189,7 @@ class DefaultConfigParams(object):
     def data_type(self, data_type):
         """
         Sets the data_type of this DefaultConfigParams.
-        Describes about the Datatype value.
+        Data type of the variable.
 
 
         :param data_type: The data_type of this DefaultConfigParams.
@@ -201,7 +201,7 @@ class DefaultConfigParams(object):
     def is_overridable(self):
         """
         **[Required]** Gets the is_overridable of this DefaultConfigParams.
-        This flags tells whether the value is overridable or not.
+        Whether the value can be overridden or not.
 
 
         :return: The is_overridable of this DefaultConfigParams.
@@ -213,7 +213,7 @@ class DefaultConfigParams(object):
     def is_overridable(self, is_overridable):
         """
         Sets the is_overridable of this DefaultConfigParams.
-        This flags tells whether the value is overridable or not.
+        Whether the value can be overridden or not.
 
 
         :param is_overridable: The is_overridable of this DefaultConfigParams.
@@ -225,7 +225,7 @@ class DefaultConfigParams(object):
     def description(self):
         """
         **[Required]** Gets the description of this DefaultConfigParams.
-        Details about the Postgresql params.
+        Details about the PostgreSQL variable.
 
 
         :return: The description of this DefaultConfigParams.
@@ -237,7 +237,7 @@ class DefaultConfigParams(object):
     def description(self, description):
         """
         Sets the description of this DefaultConfigParams.
-        Details about the Postgresql params.
+        Details about the PostgreSQL variable.
 
 
         :param description: The description of this DefaultConfigParams.

oci/psql/models/default_configuration.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DefaultConfiguration(object):
     """
-    Db system Postgresql Default Configuration
+    Default configurations for PostgreSQL database systems.
     """
 
     #: A constant which can be used with the lifecycle_state property of a DefaultConfiguration.
@@ -131,7 +131,7 @@ class DefaultConfiguration(object):
     def id(self):
         """
         **[Required]** Gets the id of this DefaultConfiguration.
-        Unique identifier that is immutable on creation
+        A unique identifier for the configuration.
 
 
         :return: The id of this DefaultConfiguration.
@@ -143,7 +143,7 @@ class DefaultConfiguration(object):
     def id(self, id):
         """
         Sets the id of this DefaultConfiguration.
-        Unique identifier that is immutable on creation
+        A unique identifier for the configuration.
 
 
         :param id: The id of this DefaultConfiguration.
@@ -155,7 +155,7 @@ class DefaultConfiguration(object):
     def display_name(self):
         """
         **[Required]** Gets the display_name of this DefaultConfiguration.
-        Config display name
+        A user-friendly display name for the configuration.
 
 
         :return: The display_name of this DefaultConfiguration.
@@ -167,7 +167,7 @@ class DefaultConfiguration(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this DefaultConfiguration.
-        Config display name
+        A user-friendly display name for the configuration.
 
 
         :param display_name: The display_name of this DefaultConfiguration.
@@ -179,7 +179,7 @@ class DefaultConfiguration(object):
     def description(self):
         """
         Gets the description of this DefaultConfiguration.
-        Config description
+        A description for the configuration.
 
 
         :return: The description of this DefaultConfiguration.
@@ -191,7 +191,7 @@ class DefaultConfiguration(object):
     def description(self, description):
         """
         Sets the description of this DefaultConfiguration.
-        Config description
+        A description for the configuration.
 
 
         :param description: The description of this DefaultConfiguration.
@@ -203,7 +203,12 @@ class DefaultConfiguration(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this DefaultConfiguration.
-        The time Configuration was created. An RFC3339 formatted datetime string
+        The date and time that the configuration 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 DefaultConfiguration.
@@ -215,7 +220,12 @@ class DefaultConfiguration(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this DefaultConfiguration.
-        The time Configuration was created. An RFC3339 formatted datetime string
+        The date and time that the configuration 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 DefaultConfiguration.
@@ -227,7 +237,7 @@ class DefaultConfiguration(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this DefaultConfiguration.
-        The current state of the Configuration.
+        The current state of the configuration.
 
         Allowed values for this property are: "ACTIVE", "INACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -242,7 +252,7 @@ class DefaultConfiguration(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this DefaultConfiguration.
-        The current state of the Configuration.
+        The current state of the configuration.
 
 
         :param lifecycle_state: The lifecycle_state of this DefaultConfiguration.
@@ -281,7 +291,8 @@ class DefaultConfiguration(object):
     def shape(self):
         """
         **[Required]** Gets the shape of this DefaultConfiguration.
-        Compute Shape Name like VM.Standard3.Flex.
+        The name of the shape for the configuration.
+        Example: `VM.Standard.E4.Flex`
 
 
         :return: The shape of this DefaultConfiguration.
@@ -293,7 +304,8 @@ class DefaultConfiguration(object):
     def shape(self, shape):
         """
         Sets the shape of this DefaultConfiguration.
-        Compute Shape Name like VM.Standard3.Flex.
+        The name of the shape for the configuration.
+        Example: `VM.Standard.E4.Flex`
 
 
         :param shape: The shape of this DefaultConfiguration.
@@ -305,7 +317,7 @@ class DefaultConfiguration(object):
     def instance_ocpu_count(self):
         """
         **[Required]** Gets the instance_ocpu_count of this DefaultConfiguration.
-        CPU cpuCoreCount. Min value is 1. Max value depends on the shape.
+        CPU core count. Minimum value is 1.
 
 
         :return: The instance_ocpu_count of this DefaultConfiguration.
@@ -317,7 +329,7 @@ class DefaultConfiguration(object):
     def instance_ocpu_count(self, instance_ocpu_count):
         """
         Sets the instance_ocpu_count of this DefaultConfiguration.
-        CPU cpuCoreCount. Min value is 1. Max value depends on the shape.
+        CPU core count. Minimum value is 1.
 
 
         :param instance_ocpu_count: The instance_ocpu_count of this DefaultConfiguration.
@@ -329,7 +341,7 @@ class DefaultConfiguration(object):
     def instance_memory_size_in_gbs(self):
         """
         **[Required]** Gets the instance_memory_size_in_gbs of this DefaultConfiguration.
-        Memory Size in GB with 1GB increment. Min value matches the cpuCoreCount. Max value depends on the shape.
+        Memory size in gigabytes with 1GB increment.
 
 
         :return: The instance_memory_size_in_gbs of this DefaultConfiguration.
@@ -341,7 +353,7 @@ class DefaultConfiguration(object):
     def instance_memory_size_in_gbs(self, instance_memory_size_in_gbs):
         """
         Sets the instance_memory_size_in_gbs of this DefaultConfiguration.
-        Memory Size in GB with 1GB increment. Min value matches the cpuCoreCount. Max value depends on the shape.
+        Memory size in gigabytes with 1GB increment.
 
 
         :param instance_memory_size_in_gbs: The instance_memory_size_in_gbs of this DefaultConfiguration.
@@ -353,7 +365,7 @@ class DefaultConfiguration(object):
     def db_version(self):
         """
         **[Required]** Gets the db_version of this DefaultConfiguration.
-        Version of the Postgresql DB
+        Version of the PostgreSQL database.
 
 
         :return: The db_version of this DefaultConfiguration.
@@ -365,7 +377,7 @@ class DefaultConfiguration(object):
     def db_version(self, db_version):
         """
         Sets the db_version of this DefaultConfiguration.
-        Version of the Postgresql DB
+        Version of the PostgreSQL database.
 
 
         :param db_version: The db_version of this DefaultConfiguration.

oci/psql/models/default_configuration_collection.py

@@ -39,7 +39,7 @@ class DefaultConfigurationCollection(object):
     def items(self):
         """
         **[Required]** Gets the items of this DefaultConfigurationCollection.
-        List of Configurations.
+        List of configurations.
 
 
         :return: The items of this DefaultConfigurationCollection.
@@ -51,7 +51,7 @@ class DefaultConfigurationCollection(object):
     def items(self, items):
         """
         Sets the items of this DefaultConfigurationCollection.
-        List of Configurations.
+        List of configurations.
 
 
         :param items: The items of this DefaultConfigurationCollection.

oci/psql/models/default_configuration_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class DefaultConfigurationDetails(object):
     """
-    List of DB default Configuration Values.
+    List of default configuration values for databases.
     """
 
     def __init__(self, **kwargs):