PyPI - huaweicloudsdkgaussdbforopengauss - Versions diffs - 3.1.141__py2.py3-none-any.whl → 3.1.143__py2.py3-none-any.whl - Mend

huaweicloudsdkgaussdbforopengauss 3.1.141py2.py3-none-any.whl → 3.1.143py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (492) hide show

huaweicloudsdkgaussdbforopengauss/v3/model/open_gauss_instance_request.py CHANGED Viewed

@@ -67,7 +67,7 @@ class OpenGaussInstanceRequest:
     }
     def __init__(self, name=None, datastore=None, ha=None, configuration_id=None, port=None, password=None, backup_strategy=None, enterprise_project_id=None, disk_encryption_id=None, flavor_ref=None, volume=None, region=None, availability_zone=None, vpc_id=None, subnet_id=None, security_group_id=None, charge_info=None, time_zone=None, sharding_num=None, coordinator_num=None, replica_num=None, enable_force_switch=None):
-        """OpenGaussInstanceRequest
+        r"""OpenGaussInstanceRequest
         The model defined in huaweicloud sdk
@@ -179,7 +179,7 @@ class OpenGaussInstanceRequest:
     @property
     def name(self):
-        """Gets the name of this OpenGaussInstanceRequest.
+        r"""Gets the name of this OpenGaussInstanceRequest.
         实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。  取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。
@@ -190,7 +190,7 @@ class OpenGaussInstanceRequest:
     @name.setter
     def name(self, name):
-        """Sets the name of this OpenGaussInstanceRequest.
+        r"""Sets the name of this OpenGaussInstanceRequest.
         实例名称。 用于表示实例的名称，同一租户下，同类型的实例名可重名。  取值范围：4~64个字符之间，必须以字母开头，区分大小写，可以包含字母、数字、中划线或者下划线，不能包含其他的特殊字符。
@@ -201,7 +201,7 @@ class OpenGaussInstanceRequest:
     @property
     def datastore(self):
-        """Gets the datastore of this OpenGaussInstanceRequest.
+        r"""Gets the datastore of this OpenGaussInstanceRequest.
         :return: The datastore of this OpenGaussInstanceRequest.
         :rtype: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussDatastore`
@@ -210,7 +210,7 @@ class OpenGaussInstanceRequest:
     @datastore.setter
     def datastore(self, datastore):
-        """Sets the datastore of this OpenGaussInstanceRequest.
+        r"""Sets the datastore of this OpenGaussInstanceRequest.
         :param datastore: The datastore of this OpenGaussInstanceRequest.
         :type datastore: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussDatastore`
@@ -219,7 +219,7 @@ class OpenGaussInstanceRequest:
     @property
     def ha(self):
-        """Gets the ha of this OpenGaussInstanceRequest.
+        r"""Gets the ha of this OpenGaussInstanceRequest.
         :return: The ha of this OpenGaussInstanceRequest.
         :rtype: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussHa`
@@ -228,7 +228,7 @@ class OpenGaussInstanceRequest:
     @ha.setter
     def ha(self, ha):
-        """Sets the ha of this OpenGaussInstanceRequest.
+        r"""Sets the ha of this OpenGaussInstanceRequest.
         :param ha: The ha of this OpenGaussInstanceRequest.
         :type ha: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussHa`
@@ -237,7 +237,7 @@ class OpenGaussInstanceRequest:
     @property
     def configuration_id(self):
-        """Gets the configuration_id of this OpenGaussInstanceRequest.
+        r"""Gets the configuration_id of this OpenGaussInstanceRequest.
         参数模板ID。当不传该参数时，使用系统默认的参数模板。
@@ -248,7 +248,7 @@ class OpenGaussInstanceRequest:
     @configuration_id.setter
     def configuration_id(self, configuration_id):
-        """Sets the configuration_id of this OpenGaussInstanceRequest.
+        r"""Sets the configuration_id of this OpenGaussInstanceRequest.
         参数模板ID。当不传该参数时，使用系统默认的参数模板。
@@ -259,7 +259,7 @@ class OpenGaussInstanceRequest:
     @property
     def port(self):
-        """Gets the port of this OpenGaussInstanceRequest.
+        r"""Gets the port of this OpenGaussInstanceRequest.
         数据库对外开放的端口，不填默认为8000，可选范围为：1024-39998。限制端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。  - GaussDB数据库端口当前只支持设置为8000，当不传该参数时，默认端口为8000。
@@ -270,7 +270,7 @@ class OpenGaussInstanceRequest:
     @port.setter
     def port(self, port):
-        """Sets the port of this OpenGaussInstanceRequest.
+        r"""Sets the port of this OpenGaussInstanceRequest.
         数据库对外开放的端口，不填默认为8000，可选范围为：1024-39998。限制端口： 2378,2379,2380,4999,5000,5999,6000,6001,8097,8098,12016,12017,20049,20050,21731,21732,32122,32123,32124。  - GaussDB数据库端口当前只支持设置为8000，当不传该参数时，默认端口为8000。
@@ -281,7 +281,7 @@ class OpenGaussInstanceRequest:
     @property
     def password(self):
-        """Gets the password of this OpenGaussInstanceRequest.
+        r"""Gets the password of this OpenGaussInstanceRequest.
         数据库密码。必选。  取值范围：  '非空； 至少包含大写字母（A-Z），小写字母（a-z），数字（0-9），非字母数字字符（限定为~!@#%^*-_=+?,）四类字符中的三类字符；长度8~32个字符。'  '建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。'
@@ -292,7 +292,7 @@ class OpenGaussInstanceRequest:
     @password.setter
     def password(self, password):
-        """Sets the password of this OpenGaussInstanceRequest.
+        r"""Sets the password of this OpenGaussInstanceRequest.
         数据库密码。必选。  取值范围：  '非空； 至少包含大写字母（A-Z），小写字母（a-z），数字（0-9），非字母数字字符（限定为~!@#%^*-_=+?,）四类字符中的三类字符；长度8~32个字符。'  '建议您输入高强度密码，以提高安全性，防止出现密码被暴力破解等安全风险。'
@@ -303,7 +303,7 @@ class OpenGaussInstanceRequest:
     @property
     def backup_strategy(self):
-        """Gets the backup_strategy of this OpenGaussInstanceRequest.
+        r"""Gets the backup_strategy of this OpenGaussInstanceRequest.
         :return: The backup_strategy of this OpenGaussInstanceRequest.
         :rtype: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussBackupStrategy`
@@ -312,7 +312,7 @@ class OpenGaussInstanceRequest:
     @backup_strategy.setter
     def backup_strategy(self, backup_strategy):
-        """Sets the backup_strategy of this OpenGaussInstanceRequest.
+        r"""Sets the backup_strategy of this OpenGaussInstanceRequest.
         :param backup_strategy: The backup_strategy of this OpenGaussInstanceRequest.
         :type backup_strategy: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussBackupStrategy`
@@ -321,7 +321,7 @@ class OpenGaussInstanceRequest:
     @property
     def enterprise_project_id(self):
-        """Gets the enterprise_project_id of this OpenGaussInstanceRequest.
+        r"""Gets the enterprise_project_id of this OpenGaussInstanceRequest.
         企业项目ID。只有企业租户时该参数才生效。  使用请参考《企业管理 API参考》的“[查询企业项目列表](https://support.huaweicloud.com/api-em/zh-cn_topic_0121230880.html)”响应消息表“enterprise_project字段数据结构说明”的“id”。
@@ -332,7 +332,7 @@ class OpenGaussInstanceRequest:
     @enterprise_project_id.setter
     def enterprise_project_id(self, enterprise_project_id):
-        """Sets the enterprise_project_id of this OpenGaussInstanceRequest.
+        r"""Sets the enterprise_project_id of this OpenGaussInstanceRequest.
         企业项目ID。只有企业租户时该参数才生效。  使用请参考《企业管理 API参考》的“[查询企业项目列表](https://support.huaweicloud.com/api-em/zh-cn_topic_0121230880.html)”响应消息表“enterprise_project字段数据结构说明”的“id”。
@@ -343,7 +343,7 @@ class OpenGaussInstanceRequest:
     @property
     def disk_encryption_id(self):
-        """Gets the disk_encryption_id of this OpenGaussInstanceRequest.
+        r"""Gets the disk_encryption_id of this OpenGaussInstanceRequest.
         用于磁盘加密的密钥ID，默认为空。
@@ -354,7 +354,7 @@ class OpenGaussInstanceRequest:
     @disk_encryption_id.setter
     def disk_encryption_id(self, disk_encryption_id):
-        """Sets the disk_encryption_id of this OpenGaussInstanceRequest.
+        r"""Sets the disk_encryption_id of this OpenGaussInstanceRequest.
         用于磁盘加密的密钥ID，默认为空。
@@ -365,7 +365,7 @@ class OpenGaussInstanceRequest:
     @property
     def flavor_ref(self):
-        """Gets the flavor_ref of this OpenGaussInstanceRequest.
+        r"""Gets the flavor_ref of this OpenGaussInstanceRequest.
         规格码，取值范围：非空。参考[表1](https://support.huaweicloud.com/api-opengauss/opengauss_api_0037.html#opengauss_api_0037__ted9b9d433c8a4c52884e199e17f94479)中GaussDB 的“规格编码”列内容获取。
@@ -376,7 +376,7 @@ class OpenGaussInstanceRequest:
     @flavor_ref.setter
     def flavor_ref(self, flavor_ref):
-        """Sets the flavor_ref of this OpenGaussInstanceRequest.
+        r"""Sets the flavor_ref of this OpenGaussInstanceRequest.
         规格码，取值范围：非空。参考[表1](https://support.huaweicloud.com/api-opengauss/opengauss_api_0037.html#opengauss_api_0037__ted9b9d433c8a4c52884e199e17f94479)中GaussDB 的“规格编码”列内容获取。
@@ -387,7 +387,7 @@ class OpenGaussInstanceRequest:
     @property
     def volume(self):
-        """Gets the volume of this OpenGaussInstanceRequest.
+        r"""Gets the volume of this OpenGaussInstanceRequest.
         :return: The volume of this OpenGaussInstanceRequest.
         :rtype: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussVolume`
@@ -396,7 +396,7 @@ class OpenGaussInstanceRequest:
     @volume.setter
     def volume(self, volume):
-        """Sets the volume of this OpenGaussInstanceRequest.
+        r"""Sets the volume of this OpenGaussInstanceRequest.
         :param volume: The volume of this OpenGaussInstanceRequest.
         :type volume: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussVolume`
@@ -405,7 +405,7 @@ class OpenGaussInstanceRequest:
     @property
     def region(self):
-        """Gets the region of this OpenGaussInstanceRequest.
+        r"""Gets the region of this OpenGaussInstanceRequest.
         区域ID。  取值范围：非空，请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
@@ -416,7 +416,7 @@ class OpenGaussInstanceRequest:
     @region.setter
     def region(self, region):
-        """Sets the region of this OpenGaussInstanceRequest.
+        r"""Sets the region of this OpenGaussInstanceRequest.
         区域ID。  取值范围：非空，请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
@@ -427,7 +427,7 @@ class OpenGaussInstanceRequest:
     @property
     def availability_zone(self):
-        """Gets the availability_zone of this OpenGaussInstanceRequest.
+        r"""Gets the availability_zone of this OpenGaussInstanceRequest.
         可用区ID。  GaussDB取值范围：非空，可选部署在同一可用区或三个不同可用区，可用区之间用逗号隔开。详见示例。  - 部署在同一可用区：需要输入三个相同的可用区。例如：部署在“cn-north-4a”可用区，则需要在此处输入\"cn-north-4a,cn-north-4a,cn-north-4a\"。 - 部署在三个不同可用区：需要分别输入三个不同的可用区。 取值范围：非空，请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
@@ -438,7 +438,7 @@ class OpenGaussInstanceRequest:
     @availability_zone.setter
     def availability_zone(self, availability_zone):
-        """Sets the availability_zone of this OpenGaussInstanceRequest.
+        r"""Sets the availability_zone of this OpenGaussInstanceRequest.
         可用区ID。  GaussDB取值范围：非空，可选部署在同一可用区或三个不同可用区，可用区之间用逗号隔开。详见示例。  - 部署在同一可用区：需要输入三个相同的可用区。例如：部署在“cn-north-4a”可用区，则需要在此处输入\"cn-north-4a,cn-north-4a,cn-north-4a\"。 - 部署在三个不同可用区：需要分别输入三个不同的可用区。 取值范围：非空，请参见[地区和终端节点](https://developer.huaweicloud.com/endpoint)。
@@ -449,7 +449,7 @@ class OpenGaussInstanceRequest:
     @property
     def vpc_id(self):
-        """Gets the vpc_id of this OpenGaussInstanceRequest.
+        r"""Gets the vpc_id of this OpenGaussInstanceRequest.
         虚拟私有云ID，获取方法如下：  - 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。
@@ -460,7 +460,7 @@ class OpenGaussInstanceRequest:
     @vpc_id.setter
     def vpc_id(self, vpc_id):
-        """Sets the vpc_id of this OpenGaussInstanceRequest.
+        r"""Sets the vpc_id of this OpenGaussInstanceRequest.
         虚拟私有云ID，获取方法如下：  - 方法1：登录虚拟私有云服务的控制台界面，在虚拟私有云的详情页面查找VPC ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询VPC列表](https://support.huaweicloud.com/api-vpc/vpc_api01_0003.html)。
@@ -471,7 +471,7 @@ class OpenGaussInstanceRequest:
     @property
     def subnet_id(self):
-        """Gets the subnet_id of this OpenGaussInstanceRequest.
+        r"""Gets the subnet_id of this OpenGaussInstanceRequest.
         子网的网络ID信息，获取方法如下：  - 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。
@@ -482,7 +482,7 @@ class OpenGaussInstanceRequest:
     @subnet_id.setter
     def subnet_id(self, subnet_id):
-        """Sets the subnet_id of this OpenGaussInstanceRequest.
+        r"""Sets the subnet_id of this OpenGaussInstanceRequest.
         子网的网络ID信息，获取方法如下：  - 方法1：登录虚拟私有云服务的控制台界面，单击VPC下的子网，进入子网详情页面，查找网络ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询子网列表](https://support.huaweicloud.com/api-vpc/vpc_subnet01_0003.html)。
@@ -493,7 +493,7 @@ class OpenGaussInstanceRequest:
     @property
     def security_group_id(self):
-        """Gets the security_group_id of this OpenGaussInstanceRequest.
+        r"""Gets the security_group_id of this OpenGaussInstanceRequest.
         指定实例所属的安全组。如果不需要指定安全组，请联系客服申请白名单。  - 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询安全组列表](https://support.huaweicloud.com/api-vpc/vpc_sg01_0003.html)。
@@ -504,7 +504,7 @@ class OpenGaussInstanceRequest:
     @security_group_id.setter
     def security_group_id(self, security_group_id):
-        """Sets the security_group_id of this OpenGaussInstanceRequest.
+        r"""Sets the security_group_id of this OpenGaussInstanceRequest.
         指定实例所属的安全组。如果不需要指定安全组，请联系客服申请白名单。  - 方法1：登录虚拟私有云服务的控制台界面，在安全组的详情页面查找安全组ID。 - 方法2：通过虚拟私有云服务的API接口查询，具体操作可参考[查询安全组列表](https://support.huaweicloud.com/api-vpc/vpc_sg01_0003.html)。
@@ -515,7 +515,7 @@ class OpenGaussInstanceRequest:
     @property
     def charge_info(self):
-        """Gets the charge_info of this OpenGaussInstanceRequest.
+        r"""Gets the charge_info of this OpenGaussInstanceRequest.
         :return: The charge_info of this OpenGaussInstanceRequest.
         :rtype: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussChargeInfo`
@@ -524,7 +524,7 @@ class OpenGaussInstanceRequest:
     @charge_info.setter
     def charge_info(self, charge_info):
-        """Sets the charge_info of this OpenGaussInstanceRequest.
+        r"""Sets the charge_info of this OpenGaussInstanceRequest.
         :param charge_info: The charge_info of this OpenGaussInstanceRequest.
         :type charge_info: :class:`huaweicloudsdkgaussdbforopengauss.v3.OpenGaussChargeInfo`
@@ -533,7 +533,7 @@ class OpenGaussInstanceRequest:
     @property
     def time_zone(self):
-        """Gets the time_zone of this OpenGaussInstanceRequest.
+        r"""Gets the time_zone of this OpenGaussInstanceRequest.
         UTC时区。  - 不选择时，GaussDB国内站、默认为UTC时间。 - 选择填写时，取值范围为UTC-12:00~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。
@@ -544,7 +544,7 @@ class OpenGaussInstanceRequest:
     @time_zone.setter
     def time_zone(self, time_zone):
-        """Sets the time_zone of this OpenGaussInstanceRequest.
+        r"""Sets the time_zone of this OpenGaussInstanceRequest.
         UTC时区。  - 不选择时，GaussDB国内站、默认为UTC时间。 - 选择填写时，取值范围为UTC-12:00~UTC+12:00，且只支持整段时间，如UTC+08:00，不支持UTC+08:30。
@@ -555,7 +555,7 @@ class OpenGaussInstanceRequest:
     @property
     def sharding_num(self):
-        """Gets the sharding_num of this OpenGaussInstanceRequest.
+        r"""Gets the sharding_num of this OpenGaussInstanceRequest.
         仅分布式形态需要填写该参数。分片数量，取值范围1~9。
@@ -566,7 +566,7 @@ class OpenGaussInstanceRequest:
     @sharding_num.setter
     def sharding_num(self, sharding_num):
-        """Sets the sharding_num of this OpenGaussInstanceRequest.
+        r"""Sets the sharding_num of this OpenGaussInstanceRequest.
         仅分布式形态需要填写该参数。分片数量，取值范围1~9。
@@ -577,7 +577,7 @@ class OpenGaussInstanceRequest:
     @property
     def coordinator_num(self):
-        """Gets the coordinator_num of this OpenGaussInstanceRequest.
+        r"""Gets the coordinator_num of this OpenGaussInstanceRequest.
         仅分布式形态需要填写该参数。协调节点数量，取值范围1~9。CN数量必须小于或等于两倍的分片数。
@@ -588,7 +588,7 @@ class OpenGaussInstanceRequest:
     @coordinator_num.setter
     def coordinator_num(self, coordinator_num):
-        """Sets the coordinator_num of this OpenGaussInstanceRequest.
+        r"""Sets the coordinator_num of this OpenGaussInstanceRequest.
         仅分布式形态需要填写该参数。协调节点数量，取值范围1~9。CN数量必须小于或等于两倍的分片数。
@@ -599,7 +599,7 @@ class OpenGaussInstanceRequest:
     @property
     def replica_num(self):
-        """Gets the replica_num of this OpenGaussInstanceRequest.
+        r"""Gets the replica_num of this OpenGaussInstanceRequest.
         实例副本数，支持取值3。不填默认为3。仅支持1.3.0及以上版本的实例。
@@ -610,7 +610,7 @@ class OpenGaussInstanceRequest:
     @replica_num.setter
     def replica_num(self, replica_num):
-        """Sets the replica_num of this OpenGaussInstanceRequest.
+        r"""Sets the replica_num of this OpenGaussInstanceRequest.
         实例副本数，支持取值3。不填默认为3。仅支持1.3.0及以上版本的实例。
@@ -621,7 +621,7 @@ class OpenGaussInstanceRequest:
     @property
     def enable_force_switch(self):
-        """Gets the enable_force_switch of this OpenGaussInstanceRequest.
+        r"""Gets the enable_force_switch of this OpenGaussInstanceRequest.
         enable_force_switch表示是否开启备机强升主功能，enable_force_switch=true表示开启备机强升主功能，enable_force_switch=false表示关闭，默认关闭。仅支持1.2.2及以上版本。  说明：  备机强升主功能适用场景：在主机发生故障后，为了保障集群的可用性，强制拉起备机作为新主机对外提供服务的场景。 本功能在集群故障状态下，以丢失部分数据为代价换取集群尽可能快的恢复服务。本功能是集群状态为不可用时的一个逃生方法，如果操作者不清楚备机强升后丢失数据对业务的影响，请勿使用本功能。 备机强升主相关介绍请参考《故障处理》备机强升主章节。
@@ -632,7 +632,7 @@ class OpenGaussInstanceRequest:
     @enable_force_switch.setter
     def enable_force_switch(self, enable_force_switch):
-        """Sets the enable_force_switch of this OpenGaussInstanceRequest.
+        r"""Sets the enable_force_switch of this OpenGaussInstanceRequest.
         enable_force_switch表示是否开启备机强升主功能，enable_force_switch=true表示开启备机强升主功能，enable_force_switch=false表示关闭，默认关闭。仅支持1.2.2及以上版本。  说明：  备机强升主功能适用场景：在主机发生故障后，为了保障集群的可用性，强制拉起备机作为新主机对外提供服务的场景。 本功能在集群故障状态下，以丢失部分数据为代价换取集群尽可能快的恢复服务。本功能是集群状态为不可用时的一个逃生方法，如果操作者不清楚备机强升后丢失数据对业务的影响，请勿使用本功能。 备机强升主相关介绍请参考《故障处理》备机强升主章节。

huaweicloudsdkgaussdbforopengauss 3.1.141__py2.py3-none-any.whl → 3.1.143__py2.py3-none-any.whl

huaweicloudsdkgaussdbforopengauss 3.1.141py2.py3-none-any.whl → 3.1.143py2.py3-none-any.whl