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

oci/psql/models/config_params.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ConfigParams(object):
     """
-    DB Configuration
+    Database configuration.
     """
 
     def __init__(self, **kwargs):
@@ -88,7 +88,7 @@ class ConfigParams(object):
     def config_key(self):
         """
         **[Required]** Gets the config_key of this ConfigParams.
-        Key is the configuration key.
+        The configuration variable name.
 
 
         :return: The config_key of this ConfigParams.
@@ -100,7 +100,7 @@ class ConfigParams(object):
     def config_key(self, config_key):
         """
         Sets the config_key of this ConfigParams.
-        Key is the configuration key.
+        The configuration variable name.
 
 
         :param config_key: The config_key of this ConfigParams.
@@ -112,7 +112,7 @@ class ConfigParams(object):
     def default_config_value(self):
         """
         **[Required]** Gets the default_config_value of this ConfigParams.
-        Default value
+        Default value for the configuration variable.
 
 
         :return: The default_config_value of this ConfigParams.
@@ -124,7 +124,7 @@ class ConfigParams(object):
     def default_config_value(self, default_config_value):
         """
         Sets the default_config_value of this ConfigParams.
-        Default value
+        Default value for the configuration variable.
 
 
         :param default_config_value: The default_config_value of this ConfigParams.
@@ -136,7 +136,7 @@ class ConfigParams(object):
     def overriden_config_value(self):
         """
         Gets the overriden_config_value of this ConfigParams.
-        User selected configuration value
+        User-selected configuration variable value.
 
 
         :return: The overriden_config_value of this ConfigParams.
@@ -148,7 +148,7 @@ class ConfigParams(object):
     def overriden_config_value(self, overriden_config_value):
         """
         Sets the overriden_config_value of this ConfigParams.
-        User selected configuration value
+        User-selected configuration variable value.
 
 
         :param overriden_config_value: The overriden_config_value of this ConfigParams.
@@ -160,7 +160,7 @@ class ConfigParams(object):
     def allowed_values(self):
         """
         **[Required]** Gets the allowed_values of this ConfigParams.
-        Range or list of allowed values
+        Range or list of allowed values.
 
 
         :return: The allowed_values of this ConfigParams.
@@ -172,7 +172,7 @@ class ConfigParams(object):
     def allowed_values(self, allowed_values):
         """
         Sets the allowed_values of this ConfigParams.
-        Range or list of allowed values
+        Range or list of allowed values.
 
 
         :param allowed_values: The allowed_values of this ConfigParams.
@@ -184,7 +184,7 @@ class ConfigParams(object):
     def is_restart_required(self):
         """
         **[Required]** Gets the is_restart_required of this ConfigParams.
-        If true, modfying this configuration value will requires restart.
+        If true, modifying this configuration value will require a restart of the database.
 
 
         :return: The is_restart_required of this ConfigParams.
@@ -196,7 +196,7 @@ class ConfigParams(object):
     def is_restart_required(self, is_restart_required):
         """
         Sets the is_restart_required of this ConfigParams.
-        If true, modfying this configuration value will requires restart.
+        If true, modifying this configuration value will require a restart of the database.
 
 
         :param is_restart_required: The is_restart_required of this ConfigParams.
@@ -208,7 +208,7 @@ class ConfigParams(object):
     def data_type(self):
         """
         **[Required]** Gets the data_type of this ConfigParams.
-        Describes about the Datatype value.
+        Data type of the variable.
 
 
         :return: The data_type of this ConfigParams.
@@ -220,7 +220,7 @@ class ConfigParams(object):
     def data_type(self, data_type):
         """
         Sets the data_type of this ConfigParams.
-        Describes about the Datatype value.
+        Data type of the variable.
 
 
         :param data_type: The data_type of this ConfigParams.
@@ -232,7 +232,7 @@ class ConfigParams(object):
     def is_overridable(self):
         """
         **[Required]** Gets the is_overridable of this ConfigParams.
-        This flags tells whether the value is overridable or not.
+        Whether the value can be overridden or not.
 
 
         :return: The is_overridable of this ConfigParams.
@@ -244,7 +244,7 @@ class ConfigParams(object):
     def is_overridable(self, is_overridable):
         """
         Sets the is_overridable of this ConfigParams.
-        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 ConfigParams.
@@ -256,7 +256,7 @@ class ConfigParams(object):
     def description(self):
         """
         **[Required]** Gets the description of this ConfigParams.
-        Details about the Postgresql params.
+        Details about the PostgreSQL parameter.
 
 
         :return: The description of this ConfigParams.
@@ -268,7 +268,7 @@ class ConfigParams(object):
     def description(self, description):
         """
         Sets the description of this ConfigParams.
-        Details about the Postgresql params.
+        Details about the PostgreSQL parameter.
 
 
         :param description: The description of this ConfigParams.

oci/psql/models/configuration.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class Configuration(object):
     """
-    Db system Postgresql Configuration
+    PostgreSQL configuration for a database system.
     """
 
     #: A constant which can be used with the lifecycle_state property of a Configuration.
@@ -155,7 +155,7 @@ class Configuration(object):
     def id(self):
         """
         **[Required]** Gets the id of this Configuration.
-        Unique identifier that is immutable on creation
+        A unique identifier for the configuration. Immutable on creation.
 
 
         :return: The id of this Configuration.
@@ -167,7 +167,7 @@ class Configuration(object):
     def id(self, id):
         """
         Sets the id of this Configuration.
-        Unique identifier that is immutable on creation
+        A unique identifier for the configuration. Immutable on creation.
 
 
         :param id: The id of this Configuration.
@@ -179,7 +179,7 @@ class Configuration(object):
     def display_name(self):
         """
         **[Required]** Gets the display_name of this Configuration.
-        Config display name
+        A user-friendly display name for the configuration. Avoid entering confidential information.
 
 
         :return: The display_name of this Configuration.
@@ -191,7 +191,7 @@ class Configuration(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this Configuration.
-        Config display name
+        A user-friendly display name for the configuration. Avoid entering confidential information.
 
 
         :param display_name: The display_name of this Configuration.
@@ -203,7 +203,7 @@ class Configuration(object):
     def description(self):
         """
         Gets the description of this Configuration.
-        Config description
+        A description for the configuration.
 
 
         :return: The description of this Configuration.
@@ -215,7 +215,7 @@ class Configuration(object):
     def description(self, description):
         """
         Sets the description of this Configuration.
-        Config description
+        A description for the configuration.
 
 
         :param description: The description of this Configuration.
@@ -227,7 +227,9 @@ class Configuration(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this Configuration.
-        Config compartment identifier
+        The `OCID`__ of the compartment that contains the configuration.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The compartment_id of this Configuration.
@@ -239,7 +241,9 @@ class Configuration(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this Configuration.
-        Config compartment identifier
+        The `OCID`__ of the compartment that contains the configuration.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param compartment_id: The compartment_id of this Configuration.
@@ -251,7 +255,12 @@ class Configuration(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this Configuration.
-        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 Configuration.
@@ -263,7 +272,12 @@ class Configuration(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this Configuration.
-        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 Configuration.
@@ -275,7 +289,7 @@ class Configuration(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this Configuration.
-        The current state of the Configuration.
+        The current state of the configuration.
 
         Allowed values for this property are: "ACTIVE", "DELETING", "DELETED", "FAILED", 'UNKNOWN_ENUM_VALUE'.
         Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
@@ -290,7 +304,7 @@ class Configuration(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this Configuration.
-        The current state of the Configuration.
+        The current state of the configuration.
 
 
         :param lifecycle_state: The lifecycle_state of this Configuration.
@@ -329,7 +343,8 @@ class Configuration(object):
     def shape(self):
         """
         **[Required]** Gets the shape of this Configuration.
-        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 Configuration.
@@ -341,7 +356,8 @@ class Configuration(object):
     def shape(self, shape):
         """
         Sets the shape of this Configuration.
-        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 Configuration.
@@ -353,7 +369,7 @@ class Configuration(object):
     def instance_ocpu_count(self):
         """
         **[Required]** Gets the instance_ocpu_count of this Configuration.
-        CPU cpuCoreCount. Min value is 1. Max value depends on the shape.
+        CPU core count.
 
 
         :return: The instance_ocpu_count of this Configuration.
@@ -365,7 +381,7 @@ class Configuration(object):
     def instance_ocpu_count(self, instance_ocpu_count):
         """
         Sets the instance_ocpu_count of this Configuration.
-        CPU cpuCoreCount. Min value is 1. Max value depends on the shape.
+        CPU core count.
 
 
         :param instance_ocpu_count: The instance_ocpu_count of this Configuration.
@@ -377,7 +393,7 @@ class Configuration(object):
     def instance_memory_size_in_gbs(self):
         """
         **[Required]** Gets the instance_memory_size_in_gbs of this Configuration.
-        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 Configuration.
@@ -389,7 +405,7 @@ class Configuration(object):
     def instance_memory_size_in_gbs(self, instance_memory_size_in_gbs):
         """
         Sets the instance_memory_size_in_gbs of this Configuration.
-        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 Configuration.
@@ -401,7 +417,7 @@ class Configuration(object):
     def db_version(self):
         """
         **[Required]** Gets the db_version of this Configuration.
-        Version of the Postgresql DB
+        Version of the PostgreSQL database.
 
 
         :return: The db_version of this Configuration.
@@ -413,7 +429,7 @@ class Configuration(object):
     def db_version(self, db_version):
         """
         Sets the db_version of this Configuration.
-        Version of the Postgresql DB
+        Version of the PostgreSQL database.
 
 
         :param db_version: The db_version of this Configuration.

oci/psql/models/configuration_collection.py

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

oci/psql/models/configuration_details.py

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

oci/psql/models/configuration_summary.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ConfigurationSummary(object):
     """
-    Summary of the Configuration.
+    Summary of the configuration.
     """
 
     def __init__(self, **kwargs):
@@ -123,7 +123,9 @@ class ConfigurationSummary(object):
     def id(self):
         """
         **[Required]** Gets the id of this ConfigurationSummary.
-        Unique identifier that is immutable on creation
+        The `OCID`__ of the configuration. Immutable on creation.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The id of this ConfigurationSummary.
@@ -135,7 +137,9 @@ class ConfigurationSummary(object):
     def id(self, id):
         """
         Sets the id of this ConfigurationSummary.
-        Unique identifier that is immutable on creation
+        The `OCID`__ of the configuration. Immutable on creation.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param id: The id of this ConfigurationSummary.
@@ -147,7 +151,7 @@ class ConfigurationSummary(object):
     def display_name(self):
         """
         **[Required]** Gets the display_name of this ConfigurationSummary.
-        Configuration identifier name
+        A user-friendly display name for the configuration. Avoid entering confidential information.
 
 
         :return: The display_name of this ConfigurationSummary.
@@ -159,7 +163,7 @@ class ConfigurationSummary(object):
     def display_name(self, display_name):
         """
         Sets the display_name of this ConfigurationSummary.
-        Configuration identifier name
+        A user-friendly display name for the configuration. Avoid entering confidential information.
 
 
         :param display_name: The display_name of this ConfigurationSummary.
@@ -171,7 +175,9 @@ class ConfigurationSummary(object):
     def compartment_id(self):
         """
         **[Required]** Gets the compartment_id of this ConfigurationSummary.
-        Compartment identifier
+        The `OCID`__ of the compartment that contains the configuration.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :return: The compartment_id of this ConfigurationSummary.
@@ -183,7 +189,9 @@ class ConfigurationSummary(object):
     def compartment_id(self, compartment_id):
         """
         Sets the compartment_id of this ConfigurationSummary.
-        Compartment identifier
+        The `OCID`__ of the compartment that contains the configuration.
+
+        __ https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm
 
 
         :param compartment_id: The compartment_id of this ConfigurationSummary.
@@ -195,7 +203,12 @@ class ConfigurationSummary(object):
     def time_created(self):
         """
         **[Required]** Gets the time_created of this ConfigurationSummary.
-        The time the the Configuration was created. An RFC3339 formatted datetime string
+        The date and time 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 ConfigurationSummary.
@@ -207,7 +220,12 @@ class ConfigurationSummary(object):
     def time_created(self, time_created):
         """
         Sets the time_created of this ConfigurationSummary.
-        The time the the Configuration was created. An RFC3339 formatted datetime string
+        The date and time 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 ConfigurationSummary.
@@ -219,7 +237,7 @@ class ConfigurationSummary(object):
     def lifecycle_state(self):
         """
         **[Required]** Gets the lifecycle_state of this ConfigurationSummary.
-        The current state of the Configuration.
+        The current state of the configuration.
 
 
         :return: The lifecycle_state of this ConfigurationSummary.
@@ -231,7 +249,7 @@ class ConfigurationSummary(object):
     def lifecycle_state(self, lifecycle_state):
         """
         Sets the lifecycle_state of this ConfigurationSummary.
-        The current state of the Configuration.
+        The current state of the configuration.
 
 
         :param lifecycle_state: The lifecycle_state of this ConfigurationSummary.
@@ -267,7 +285,8 @@ class ConfigurationSummary(object):
     def shape(self):
         """
         **[Required]** Gets the shape of this ConfigurationSummary.
-        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 ConfigurationSummary.
@@ -279,7 +298,8 @@ class ConfigurationSummary(object):
     def shape(self, shape):
         """
         Sets the shape of this ConfigurationSummary.
-        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 ConfigurationSummary.
@@ -291,7 +311,7 @@ class ConfigurationSummary(object):
     def db_version(self):
         """
         **[Required]** Gets the db_version of this ConfigurationSummary.
-        Version of the Postgresql DB
+        Version of the PostgreSQL database.
 
 
         :return: The db_version of this ConfigurationSummary.
@@ -303,7 +323,7 @@ class ConfigurationSummary(object):
     def db_version(self, db_version):
         """
         Sets the db_version of this ConfigurationSummary.
-        Version of the Postgresql DB
+        Version of the PostgreSQL database.
 
 
         :param db_version: The db_version of this ConfigurationSummary.
@@ -315,7 +335,7 @@ class ConfigurationSummary(object):
     def instance_ocpu_count(self):
         """
         **[Required]** Gets the instance_ocpu_count of this ConfigurationSummary.
-        CPU cpuCoreCount. Min value is 1. Max value depends on the shape.
+        CPU core count.
 
 
         :return: The instance_ocpu_count of this ConfigurationSummary.
@@ -327,7 +347,7 @@ class ConfigurationSummary(object):
     def instance_ocpu_count(self, instance_ocpu_count):
         """
         Sets the instance_ocpu_count of this ConfigurationSummary.
-        CPU cpuCoreCount. Min value is 1. Max value depends on the shape.
+        CPU core count.
 
 
         :param instance_ocpu_count: The instance_ocpu_count of this ConfigurationSummary.
@@ -339,7 +359,7 @@ class ConfigurationSummary(object):
     def instance_memory_size_in_gbs(self):
         """
         **[Required]** Gets the instance_memory_size_in_gbs of this ConfigurationSummary.
-        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 ConfigurationSummary.
@@ -351,7 +371,7 @@ class ConfigurationSummary(object):
     def instance_memory_size_in_gbs(self, instance_memory_size_in_gbs):
         """
         Sets the instance_memory_size_in_gbs of this ConfigurationSummary.
-        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 ConfigurationSummary.

oci/psql/models/connection_details.py

@@ -12,7 +12,7 @@ from oci.decorators import init_model_state_from_kwargs
 @init_model_state_from_kwargs
 class ConnectionDetails(object):
     """
-    The real-time DbSystem configuration that customers can use for getting access to the PostgreSQL instance.
+    Database system connection information. Used to connect to PostgreSQL instance(s).
     """
 
     def __init__(self, **kwargs):
@@ -53,7 +53,7 @@ class ConnectionDetails(object):
     def ca_certificate(self):
         """
         **[Required]** Gets the ca_certificate of this ConnectionDetails.
-        The CA certificate to be used by the Posgresql client to connect to the database.
+        The CA certificate to be used by the PosgreSQL client to connect to the database.
         The CA certificate is used to authenticate the server identity.
         It is issued by PostgreSQL Service Private CA.
 
@@ -67,7 +67,7 @@ class ConnectionDetails(object):
     def ca_certificate(self, ca_certificate):
         """
         Sets the ca_certificate of this ConnectionDetails.
-        The CA certificate to be used by the Posgresql client to connect to the database.
+        The CA certificate to be used by the PosgreSQL client to connect to the database.
         The CA certificate is used to authenticate the server identity.
         It is issued by PostgreSQL Service Private CA.
 
@@ -101,7 +101,7 @@ class ConnectionDetails(object):
     def instance_endpoints(self):
         """
         **[Required]** Gets the instance_endpoints of this ConnectionDetails.
-        The list of DbInstance endpoints in the DbSystem.
+        The list of database instance node endpoints in the database system.
 
 
         :return: The instance_endpoints of this ConnectionDetails.
@@ -113,7 +113,7 @@ class ConnectionDetails(object):
     def instance_endpoints(self, instance_endpoints):
         """
         Sets the instance_endpoints of this ConnectionDetails.
-        The list of DbInstance endpoints in the DbSystem.
+        The list of database instance node endpoints in the database system.
 
 
         :param instance_endpoints: The instance_endpoints of this ConnectionDetails.