tencentcloud-sdk-python-intl-en 3.0.941__tar.gz → 3.0.944__tar.gz

{tencentcloud-sdk-python-intl-en-3.0.941/tencentcloud_sdk_python_intl_en.egg-info → tencentcloud-sdk-python-intl-en-3.0.944}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-intl-en
-Version: 3.0.941
+Version: 3.0.944
 Summary: Tencent Cloud SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python-intl-en
 Author: Tencent Cloud

{tencentcloud-sdk-python-intl-en-3.0.941 → tencentcloud-sdk-python-intl-en-3.0.944}/tencentcloud/__init__.py

@@ -13,4 +13,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '3.0.941'
+__version__ = '3.0.944'

{tencentcloud-sdk-python-intl-en-3.0.941 → tencentcloud-sdk-python-intl-en-3.0.944}/tencentcloud/cls/v20201016/cls_client.py

@@ -50,7 +50,7 @@ class ClsClient(AbstractClient):
 
 
     def ApplyConfigToMachineGroup(self, request):
-        """This API is used to apply the collection configuration to the specified machine group.
+        """This API is used to apply the collection configuration to a specified machine group.
 
         :param request: Request instance for ApplyConfigToMachineGroup.
         :type request: :class:`tencentcloud.cls.v20201016.models.ApplyConfigToMachineGroupRequest`
@@ -211,7 +211,7 @@ class ClsClient(AbstractClient):
 
 
     def CreateConfig(self, request):
-        """This API is used to create a collection rule configuration.
+        """This API is used to create collection rule configuration.
 
         :param request: Request instance for CreateConfig.
         :type request: :class:`tencentcloud.cls.v20201016.models.CreateConfigRequest`
@@ -326,7 +326,7 @@ class ClsClient(AbstractClient):
 
 
     def CreateExport(self, request):
-        """This API is used to create a download task. To get the returned download address, call `DescribeExports` to view the task list. The `CosPath` parameter is also included for download address. For more information, visit https://intl.cloud.tencent.com/document/product/614/56449.?from_cn_redirect=1
+        """This API is used to create a download task. To get the returned download address, call DescribeExports to view the task list. The CosPath parameter is also included for download address. For more information, visit https://intl.cloud.tencent.com/document/product/614/56449.?from_cn_redirect=1
 
         :param request: Request instance for CreateExport.
         :type request: :class:`tencentcloud.cls.v20201016.models.CreateExportRequest`
@@ -579,7 +579,7 @@ class ClsClient(AbstractClient):
 
 
     def DeleteConfig(self, request):
-        """This API is used to delete a collection rule configuration.
+        """This API is used to delete collection rule configuration.
 
         :param request: Request instance for DeleteConfig.
         :type request: :class:`tencentcloud.cls.v20201016.models.DeleteConfigRequest`
@@ -809,7 +809,7 @@ class ClsClient(AbstractClient):
 
 
     def DeleteScheduledSql(self, request):
-        """This API is used to delete scheduled SQL analysis tasks.
+        """This API is used to delete a scheduled SQL analysis task.
 
         :param request: Request instance for DeleteScheduledSql.
         :type request: :class:`tencentcloud.cls.v20201016.models.DeleteScheduledSqlRequest`
@@ -901,7 +901,7 @@ class ClsClient(AbstractClient):
 
 
     def DescribeAlarmShields(self, request):
-        """Accesses alarm blocking configuration rules
+        """This API is used to access alarm blocking configuration rules.
 
         :param request: Request instance for DescribeAlarmShields.
         :type request: :class:`tencentcloud.cls.v20201016.models.DescribeAlarmShieldsRequest`
@@ -970,7 +970,7 @@ class ClsClient(AbstractClient):
 
 
     def DescribeConfigMachineGroups(self, request):
-        """This API is used to get the machine group bound to a collection rule configuration.
+        """This API is used to get the machine group bound to collection rule configuration.
 
         :param request: Request instance for DescribeConfigMachineGroups.
         :type request: :class:`tencentcloud.cls.v20201016.models.DescribeConfigMachineGroupsRequest`
@@ -993,7 +993,7 @@ class ClsClient(AbstractClient):
 
 
     def DescribeConfigs(self, request):
-        """This API is used to get a collection rule configuration.
+        """This API is used to get collection rule configuration.
 
         :param request: Request instance for DescribeConfigs.
         :type request: :class:`tencentcloud.cls.v20201016.models.DescribeConfigsRequest`
@@ -1131,7 +1131,7 @@ class ClsClient(AbstractClient):
 
 
     def DescribeKafkaConsumer(self, request):
-        """Accesses Kafka protocol consumption information
+        """This API is used to access Kafka protocol consumption information.
 
         :param request: Request instance for DescribeKafkaConsumer.
         :type request: :class:`tencentcloud.cls.v20201016.models.DescribeKafkaConsumerRequest`
@@ -1292,7 +1292,7 @@ class ClsClient(AbstractClient):
 
 
     def DescribeMachines(self, request):
-        """Gets the status of a machine under the specified machine group
+        """This API is used to get the status of a machine under the specified machine group.
 
         :param request: Request instance for DescribeMachines.
         :type request: :class:`tencentcloud.cls.v20201016.models.DescribeMachinesRequest`
@@ -1384,7 +1384,7 @@ class ClsClient(AbstractClient):
 
 
     def DescribeShippers(self, request):
-        """This API is used to get the configuration of the task of shipping to COS.
+        """This API is used to get the configuration of the task shipped to COS.
 
         :param request: Request instance for DescribeShippers.
         :type request: :class:`tencentcloud.cls.v20201016.models.DescribeShippersRequest`
@@ -1545,7 +1545,7 @@ class ClsClient(AbstractClient):
 
 
     def ModifyConfig(self, request):
-        """This API is used to modify a collection rule configuration.
+        """This API is used to modify collection rule configuration.
 
         :param request: Request instance for ModifyConfig.
         :type request: :class:`tencentcloud.cls.v20201016.models.ModifyConfigRequest`
@@ -1568,7 +1568,7 @@ class ClsClient(AbstractClient):
 
 
     def ModifyConsumer(self, request):
-        """This API is used to modify a CKafka delivery task
+        """This API is used to modify a CKafka delivery task.
 
         :param request: Request instance for ModifyConsumer.
         :type request: :class:`tencentcloud.cls.v20201016.models.ModifyConsumerRequest`
@@ -1660,7 +1660,7 @@ class ClsClient(AbstractClient):
 
 
     def ModifyKafkaConsumer(self, request):
-        """Modifies Kafka Protocol consumption information
+        """This API is used to modify Kafka protocol consumption information.
 
         :param request: Request instance for ModifyKafkaConsumer.
         :type request: :class:`tencentcloud.cls.v20201016.models.ModifyKafkaConsumerRequest`
@@ -1752,7 +1752,7 @@ class ClsClient(AbstractClient):
 
 
     def ModifyScheduledSql(self, request):
-        """This API is used to modify scheduled SQL analysis tasks.
+        """This API is used to modify a scheduled SQL analysis task.
 
         :param request: Request instance for ModifyScheduledSql.
         :type request: :class:`tencentcloud.cls.v20201016.models.ModifyScheduledSqlRequest`
@@ -1867,7 +1867,7 @@ class ClsClient(AbstractClient):
 
 
     def QueryMetric(self, request):
-        """Queries the latest metric value at a specified time
+        """This API is used to query the latest metric value at a specified time.
 
         :param request: Request instance for QueryMetric.
         :type request: :class:`tencentcloud.cls.v20201016.models.QueryMetricRequest`
@@ -2072,7 +2072,7 @@ class ClsClient(AbstractClient):
 
         > ?Currently, protoc supports compilation in multiple programming languages such as Java, C++, and Python. For more information, see [protoc](https://github.com/protocolbuffers/protobuf).
 
-        #### 1. Install Protocol Buffers
+        #### 1. Install protocol buffers
 
         Download [Protocol Buffers](https://main.qcloudimg.com/raw/d7810aaf8b3073fbbc9d4049c21532aa/protobuf-2.6.1.tar.gz), decompress the package, and install the tool. The version used in the example is protobuf 2.6.1 running on CentOS 7.3. Run the following command to decompress the `protobuf-2.6.1.tar.gz` package to the `/usr/local` directory and go to the directory:
 

{tencentcloud-sdk-python-intl-en-3.0.941 → tencentcloud-sdk-python-intl-en-3.0.944}/tencentcloud/cls/v20201016/models.py

@@ -1490,11 +1490,11 @@ class CheckFunctionRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _EtlContent: The processing statement entered by the user
+        :param _EtlContent: Processing statement entered by the user
         :type EtlContent: str
         :param _DstResources: Target topic ID and alias of the data processing task
         :type DstResources: list of DataTransformResouceInfo
-        :param _FuncType: The type of the target topic for data processing. Valid values: 1 (fixed Topic) and 2 (dynamic creation)
+        :param _FuncType: Type of the target topic for data processing. Valid values: 1 (fixed Topic) and 2 (dynamic creation)
         :type FuncType: int
         """
         self._EtlContent = None
@@ -1552,9 +1552,9 @@ class CheckFunctionResponse(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _ErrorCode: Failure Error Code
+        :param _ErrorCode: Failure error code
         :type ErrorCode: int
-        :param _ErrorMsg: Failure Error Message
+        :param _ErrorMsg: Failure error message
         :type ErrorMsg: str
         :param _RequestId: The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
         :type RequestId: str
@@ -1815,7 +1815,7 @@ class CloseKafkaConsumerRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _FromTopicId: Log Topic ID
+        :param _FromTopicId: Log topic ID
         :type FromTopicId: str
         """
         self._FromTopicId = None
@@ -3273,7 +3273,7 @@ class CreateConsumerRequest(AbstractModel):
         :type Content: :class:`tencentcloud.cls.v20201016.models.ConsumerContent`
         :param _Ckafka: CKafka information
         :type Ckafka: :class:`tencentcloud.cls.v20201016.models.Ckafka`
-        :param _Compression: Compression method during delivery. Valid values: 0, 2, and 3. [0：NONE；2：SNAPPY；3：LZ4]
+        :param _Compression: Compression method during delivery. Valid values: 0, 2, and 3. [0: NONE; 2: SNAPPY; 3: LZ4]
         :type Compression: int
         """
         self._TopicId = None
@@ -4566,29 +4566,29 @@ class CreateScheduledSqlRequest(AbstractModel):
 
     def __init__(self):
         r"""
-        :param _SrcTopicId: Source Log Topic
+        :param _SrcTopicId: Source log topic
         :type SrcTopicId: str
-        :param _Name: Task Name
+        :param _Name: Task name
         :type Name: str
         :param _EnableFlag: Task start status. 1: Enabled, 2: Disabled
         :type EnableFlag: int
         :param _DstResource: Target log topic for scheduled SQL analysis
         :type DstResource: :class:`tencentcloud.cls.v20201016.models.ScheduledSqlResouceInfo`
-        :param _ScheduledSqlContent: Query Statement
+        :param _ScheduledSqlContent: Query statement
         :type ScheduledSqlContent: str
-        :param _ProcessStartTime: Schedule Start Time, Unix timestamp, in milliseconds
+        :param _ProcessStartTime: Schedule start time, Unix timestamp, in milliseconds
         :type ProcessStartTime: int
-        :param _ProcessType: Schedule Type: 1 Continuous Running 2 Specified Time Range
+        :param _ProcessType: Schedule type: 1: Continuous running; 2: Specified time range
         :type ProcessType: int
-        :param _ProcessPeriod: Scheduling Interval (Minutes)
+        :param _ProcessPeriod: Scheduling interval (minutes)
         :type ProcessPeriod: int
         :param _ProcessTimeWindow: Time window for a single query. If your target topic is a metric topic, it is recommended that the size of this parameter not exceed 30 minutes, otherwise, metric conversion may fail.
         :type ProcessTimeWindow: str
-        :param _ProcessDelay: Execution Delay (Seconds)
+        :param _ProcessDelay: Execution delay (Seconds)
         :type ProcessDelay: int
-        :param _SrcTopicRegion: Source Topic ID Region Information
+        :param _SrcTopicRegion: Source topic ID region information
         :type SrcTopicRegion: str
-        :param _ProcessEndTime: Schedule End Time. Required field when ProcessType=2, Unix timestamp, in milliseconds
+        :param _ProcessEndTime: Schedule end time. Required field when ProcessType=2, Unix timestamp, in milliseconds
         :type ProcessEndTime: int
         :param _SyntaxRule: Query syntax rules. Default value is 0. 0: Lucene syntax, 1: CQL syntax
         :type SyntaxRule: int
@@ -5031,7 +5031,7 @@ class CreateTopicRequest(AbstractModel):
         :type MaxSplitPartitions: int
         :param _StorageType: Log topic storage type. Valid values: `hot` (STANDARD storage); `cold` (IA storage). Default value: `hot`.
         :type StorageType: str
-        :param _Period: lifetime. Unit: days. Standard storage value range: 1~3600. Infrequent storage value range: 7~3600 days. A value of 3640 indicates permanent retention.If this value is not input, it defaults to the Period value of the log set corresponding to the accessed log topic (defaults to 30 days in case of access failure).
+        :param _Period: lifetime. Unit: days. Standard storage value range: 1 to 3600. Infrequent storage value range: 7 to 3600 days. A value of 3640 indicates permanent retention.If this value is not input, it defaults to the Period value of the log set corresponding to the accessed log topic (defaults to 30 days in case of access failure).
         :type Period: int
         :param _Describes: Log topic description
         :type Describes: str
@@ -7938,7 +7938,7 @@ class DescribeKafkaConsumerResponse(AbstractModel):
         :type Status: bool
         :param _TopicID: Topic Parameter used by KafkaConsumer during consumption
         :type TopicID: str
-        :param _Compression: Compression mode [0:NONE；2:SNAPPY；3:LZ4]
+        :param _Compression: Compression mode [0: NONE; 2: SNAPPY; 3: LZ4]
         :type Compression: int
         :param _ConsumerContent: Kafka protocol consumer data format
         :type ConsumerContent: :class:`tencentcloud.cls.v20201016.models.KafkaConsumerContent`
@@ -8288,7 +8288,7 @@ class DescribeLogHistogramRequest(AbstractModel):
         :type Query: str
         :param _TopicId: ID of the log topic to be queried
         :type TopicId: str
-        :param _Interval: Interval in milliseconds. Condition: (To – From) / Interval ≤ 200
+        :param _Interval: Interval in milliseconds. Condition: (To-From) / Interval <= 200
         :type Interval: int
         :param _SyntaxRule: Search syntax. Valid values:
 `0` (default): Lucene; `1`: CQL
@@ -12599,17 +12599,17 @@ class ModifyAlarmRequest(AbstractModel):
         :type Name: str
         :param _MonitorTime: Monitoring task running time point
         :type MonitorTime: :class:`tencentcloud.cls.v20201016.models.MonitorTime`
-        :param _Condition: Trigger condition.Note:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
+        :param _Condition: Trigger condition. Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
         :type Condition: str
         :param _AlarmLevel: Alarm level.0: Warning (Warn); 1: Reminder (Info); 2: Urgent (Critical)
 
-Note:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
+Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
         :type AlarmLevel: int
-        :param _MultiConditions: Multiple ttrigger conditions.Note:- Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
+        :param _MultiConditions: Multiple trigger conditions. Note: - Condition and AlarmLevel are one set of configurations, MultiConditions is another set of configurations. The two sets of configurations are mutually exclusive.
         :type MultiConditions: list of MultiCondition
-        :param _TriggerCount: Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1–10.
+        :param _TriggerCount: Alarm persistence cycle. An alarm will be triggered only after the corresponding trigger condition is met for the number of times specified by `TriggerCount`. Value range: 1 to 10
         :type TriggerCount: int
-        :param _AlarmPeriod: Repeated alarm interval in minutes. Value range: 0–1440.
+        :param _AlarmPeriod: Repeated alarm interval in minutes. Value range: 0 to 1440
         :type AlarmPeriod: int
         :param _AlarmNoticeIds: List of associated alarm notification templates
         :type AlarmNoticeIds: list of str
@@ -12625,7 +12625,7 @@ Note:- Condition and AlarmLevel are one set of configurations, MultiConditions i
         :type CallBack: :class:`tencentcloud.cls.v20201016.models.CallBackInfo`
         :param _Analysis: Multi-Dimensional analysis
         :type Analysis: list of AnalysisDimensional
-        :param _GroupTriggerStatus: Group trigger status. true: enabled, false: disabled (default)
+        :param _GroupTriggerStatus: Group trigger status. true: enabled; false: disabled (default)
         :type GroupTriggerStatus: bool
         :param _GroupTriggerCondition: Grouping trigger conditions.
         :type GroupTriggerCondition: list of str
@@ -13230,7 +13230,7 @@ class ModifyConsumerRequest(AbstractModel):
         :type Content: :class:`tencentcloud.cls.v20201016.models.ConsumerContent`
         :param _Ckafka: CKafka information
         :type Ckafka: :class:`tencentcloud.cls.v20201016.models.Ckafka`
-        :param _Compression: Compression method during delivery. Valid values: 0, 2, and 3. [0：NONE；2：SNAPPY；3：LZ4]
+        :param _Compression: Compression method during delivery. Valid values: 0, 2, and 3. [0: NONE; 2: SNAPPY; 3: LZ4]
         :type Compression: int
         """
         self._TopicId = None
@@ -13674,7 +13674,7 @@ class ModifyKafkaConsumerRequest(AbstractModel):
         r"""
         :param _FromTopicId: Log Topic ID
         :type FromTopicId: str
-        :param _Compression: Compression mode [0:NONE；2:SNAPPY；3:LZ4]
+        :param _Compression: Compression mode [0: NONE; 2: SNAPPY; 3: LZ4]
         :type Compression: int
         :param _ConsumerContent: Kafka protocol consumer data format
         :type ConsumerContent: :class:`tencentcloud.cls.v20201016.models.KafkaConsumerContent`
@@ -14217,7 +14217,7 @@ class ModifyScheduledSqlRequest(AbstractModel):
         r"""
         :param _TaskId: Task ID
         :type TaskId: str
-        :param _SrcTopicId: Source Log Topic
+        :param _SrcTopicId: Source log topic
         :type SrcTopicId: str
         :param _EnableFlag: Task start status. 1: Enabled, 2: Disabled
         :type EnableFlag: int
@@ -14405,9 +14405,9 @@ class ModifyShipperRequest(AbstractModel):
         :type Status: bool
         :param _ShipperName: Shipping rule name
         :type ShipperName: str
-        :param _Interval: Shipping time interval in seconds. Default value: 300. Value range: 300–900
+        :param _Interval: Shipping time interval in seconds. Default value: 300. Value range: 300 to 900
         :type Interval: int
-        :param _MaxSize: Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 5-256
+        :param _MaxSize: Maximum size of a file to be shipped, in MB. Default value: 256. Value range: 5 to 256
         :type MaxSize: int
         :param _FilterRules: Filter rules for shipped logs. Only logs matching the rules can be shipped. All rules are in the AND relationship, and up to five rules can be added. If the array is empty, no filtering will be performed, and all logs will be shipped.
         :type FilterRules: list of FilterRuleInfo
@@ -14419,7 +14419,7 @@ class ModifyShipperRequest(AbstractModel):
         :type Content: :class:`tencentcloud.cls.v20201016.models.ContentInfo`
         :param _FilenameMode: Naming a shipping file. Valid values: `0` (by random number), `1` (by shipping time). Default value: `0`.
         :type FilenameMode: int
-        :param _StorageType: COS Bucket Type
+        :param _StorageType: COS bucket type
         :type StorageType: str
         """
         self._ShipperId = None
@@ -14618,7 +14618,7 @@ class ModifyTopicRequest(AbstractModel):
         :type AutoSplit: bool
         :param _MaxSplitPartitions: Maximum number of partitions to split into for this topic if automatic split is enabled
         :type MaxSplitPartitions: int
-        :param _Period: Lifecycle in days. Value range: 1–3600 (STANDARD storage); 7–3600 (IA storage). `3640` indicates permanent retention.
+        :param _Period: Lifecycle in days. Value range: 1 to 3600 (STANDARD storage); 7 to 3600 (IA storage). 3640 indicates permanent retention.
         :type Period: int
         :param _Describes: Log topic description
         :type Describes: str
@@ -16522,7 +16522,7 @@ class SearchCosRechargeInfoRequest(AbstractModel):
         :type BucketRegion: str
         :param _Prefix: The prefix of the folder where COS files are located
         :type Prefix: str
-        :param _Compress: Compression mode: "", "gzip", "lzop", and "snappy”. The default mode is "".
+        :param _Compress: Compression mode: "", "gzip", "lzop", and "snappy". The default mode is "".
         :type Compress: str
         """
         self._TopicId = None
@@ -16844,7 +16844,7 @@ Notes:
         :type Context: str
         :param _SamplingRate: Indicates whether to sample raw logs before statistical analysis (`Query` includes SQL statements).
 `0`: Auto-sample.
-`0–1`: Sample by the specified sample rate, such as `0.02`.
+`0-1`: Sample by the specified sample rate, such as `0.02`.
 `1`: Precise analysis without sampling.
 Default value: `1`
         :type SamplingRate: float

{tencentcloud-sdk-python-intl-en-3.0.941 → tencentcloud-sdk-python-intl-en-3.0.944/tencentcloud_sdk_python_intl_en.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tencentcloud-sdk-python-intl-en
-Version: 3.0.941
+Version: 3.0.944
 Summary: Tencent Cloud SDK for Python
 Home-page: https://github.com/TencentCloud/tencentcloud-sdk-python-intl-en
 Author: Tencent Cloud