tencentcloud-sdk-nodejs-intl-en
Version:
1,739 lines (1,460 loc) • 963 kB
JavaScript
/*
* Copyright (c) 2018 Tencent. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
const AbstractModel = require("../../common/abstract_model");
/**
* Alarm policy description
* @class
*/
class AlarmInfo extends AbstractModel {
constructor(){
super();
/**
* Alarm policy name
* @type {string || null}
*/
this.Name = null;
/**
* Monitoring object list
* @type {Array.<AlarmTargetInfo> || null}
*/
this.AlarmTargets = null;
/**
* Monitoring task running time point
* @type {MonitorTime || null}
*/
this.MonitorTime = null;
/**
* Single trigger condition for whether to trigger alarm. Mutually exclusive with the MultiConditions parameter.
* @type {string || null}
*/
this.Condition = null;
/**
* 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.
* @type {number || null}
*/
this.TriggerCount = null;
/**
* Repeated alarm interval in minutes. Value range: 0–1440.
* @type {number || null}
*/
this.AlarmPeriod = null;
/**
* List of associated alarm notification channel groups. - Search the list of associated alarm notification channel groups via [Query notification channel group list](https://www.tencentcloud.com/document/product/614/56462?from_cn_redirect=1). It is mutually exclusive with MonitorNotice.
* @type {Array.<string> || null}
*/
this.AlarmNoticeIds = null;
/**
* Enablement status
* @type {boolean || null}
*/
this.Status = null;
/**
* Alarm policy ID
* @type {string || null}
*/
this.AlarmId = null;
/**
* Creation time. Format: YYYY-MM-DD HH:MM:SS
* @type {string || null}
*/
this.CreateTime = null;
/**
* Latest update time. Format: YYYY-MM-DD HH:MM:SS
* @type {string || null}
*/
this.UpdateTime = null;
/**
* Custom notification template
Note: this field may return `null`, indicating that no valid values can be obtained.
* @type {string || null}
*/
this.MessageTemplate = null;
/**
* Custom callback template
* @type {CallBackInfo || null}
*/
this.CallBack = null;
/**
* Multidimensional analysis settings
* @type {Array.<AnalysisDimensional> || null}
*/
this.Analysis = null;
/**
* Group trigger status. true: enabled, false: disabled (default)
* @type {boolean || null}
*/
this.GroupTriggerStatus = null;
/**
* Grouping Trigger Conditions.
* @type {Array.<string> || null}
*/
this.GroupTriggerCondition = null;
/**
* Tag information bound to the alarm policy.
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* Monitored object type. 0: shared monitored object for execution statements; 1: separate monitored object for each execution statement.
* @type {number || null}
*/
this.MonitorObjectType = null;
/**
* Alarm level. 0: Warn; 1: Information; 2: Critical.
* @type {number || null}
*/
this.AlarmLevel = null;
/**
* Additional classification field for alerts.
* @type {Array.<AlarmClassification> || null}
*/
this.Classifications = null;
/**
* Multiple trigger conditions.
Mutually exclusive conditions.
* @type {Array.<MultiCondition> || null}
*/
this.MultiConditions = null;
/**
* Tencent Cloud observability platform channel-related information, mutually exclusive with AlarmNoticeIds
* @type {MonitorNotice || null}
*/
this.MonitorNotice = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Name = 'Name' in params ? params.Name : null;
if (params.AlarmTargets) {
this.AlarmTargets = new Array();
for (let z in params.AlarmTargets) {
let obj = new AlarmTargetInfo();
obj.deserialize(params.AlarmTargets[z]);
this.AlarmTargets.push(obj);
}
}
if (params.MonitorTime) {
let obj = new MonitorTime();
obj.deserialize(params.MonitorTime)
this.MonitorTime = obj;
}
this.Condition = 'Condition' in params ? params.Condition : null;
this.TriggerCount = 'TriggerCount' in params ? params.TriggerCount : null;
this.AlarmPeriod = 'AlarmPeriod' in params ? params.AlarmPeriod : null;
this.AlarmNoticeIds = 'AlarmNoticeIds' in params ? params.AlarmNoticeIds : null;
this.Status = 'Status' in params ? params.Status : null;
this.AlarmId = 'AlarmId' in params ? params.AlarmId : null;
this.CreateTime = 'CreateTime' in params ? params.CreateTime : null;
this.UpdateTime = 'UpdateTime' in params ? params.UpdateTime : null;
this.MessageTemplate = 'MessageTemplate' in params ? params.MessageTemplate : null;
if (params.CallBack) {
let obj = new CallBackInfo();
obj.deserialize(params.CallBack)
this.CallBack = obj;
}
if (params.Analysis) {
this.Analysis = new Array();
for (let z in params.Analysis) {
let obj = new AnalysisDimensional();
obj.deserialize(params.Analysis[z]);
this.Analysis.push(obj);
}
}
this.GroupTriggerStatus = 'GroupTriggerStatus' in params ? params.GroupTriggerStatus : null;
this.GroupTriggerCondition = 'GroupTriggerCondition' in params ? params.GroupTriggerCondition : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
this.MonitorObjectType = 'MonitorObjectType' in params ? params.MonitorObjectType : null;
this.AlarmLevel = 'AlarmLevel' in params ? params.AlarmLevel : null;
if (params.Classifications) {
this.Classifications = new Array();
for (let z in params.Classifications) {
let obj = new AlarmClassification();
obj.deserialize(params.Classifications[z]);
this.Classifications.push(obj);
}
}
if (params.MultiConditions) {
this.MultiConditions = new Array();
for (let z in params.MultiConditions) {
let obj = new MultiCondition();
obj.deserialize(params.MultiConditions[z]);
this.MultiConditions.push(obj);
}
}
if (params.MonitorNotice) {
let obj = new MonitorNotice();
obj.deserialize(params.MonitorNotice)
this.MonitorNotice = obj;
}
}
}
/**
* DescribeLogHistogram request structure.
* @class
*/
class DescribeLogHistogramRequest extends AbstractModel {
constructor(){
super();
/**
* Start time of the log to be queried, which is a Unix timestamp in milliseconds
* @type {number || null}
*/
this.From = null;
/**
* End time of the log to be queried, which is a Unix timestamp in milliseconds
* @type {number || null}
*/
this.To = null;
/**
* Retrieval analysis statement.
The statement consists of [retrieval condition] | [SQL statement]. When there is no need to perform statistical analysis on logs, the pipe character | and SQL statement can be omitted.
Use * or an empty string to search all logs.
* @type {string || null}
*/
this.Query = null;
/**
* Log topic ID to query
-Obtain the log topic Id through [Get Log Topic List](https://www.tencentcloud.com/document/product/614/56454?from_cn_redirect=1).
* @type {string || null}
*/
this.TopicId = null;
/**
* Interval in milliseconds. Condition: (To-From) / Interval <= 200
* @type {number || null}
*/
this.Interval = null;
/**
* Search syntax. Valid values:
`0` (default): Lucene; `1`: CQL
For more information, see <a href="https://intl.cloud.tencent.com/document/product/614/47044?from_cn_redirect=1#RetrievesConditionalRules" target="_blank">Search Syntax</a>.
* @type {number || null}
*/
this.SyntaxRule = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.From = 'From' in params ? params.From : null;
this.To = 'To' in params ? params.To : null;
this.Query = 'Query' in params ? params.Query : null;
this.TopicId = 'TopicId' in params ? params.TopicId : null;
this.Interval = 'Interval' in params ? params.Interval : null;
this.SyntaxRule = 'SyntaxRule' in params ? params.SyntaxRule : null;
}
}
/**
* Task data filtering statistical information for delivery
* @class
*/
class FilterStatistics extends AbstractModel {
constructor(){
super();
/**
* <p>Number of raw logs</p>
* @type {number || null}
*/
this.OriginalCount = null;
/**
* <p>Number of filtered logs</p>
* @type {number || null}
*/
this.FilteredCount = null;
/**
* <p>Filtered results</p>
* @type {Array.<string> || null}
*/
this.FilteredResult = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.OriginalCount = 'OriginalCount' in params ? params.OriginalCount : null;
this.FilteredCount = 'FilteredCount' in params ? params.FilteredCount : null;
this.FilteredResult = 'FilteredResult' in params ? params.FilteredResult : null;
}
}
/**
* DescribeNetworkApplicationDetail request structure.
* @class
*/
class DescribeNetworkApplicationDetailRequest extends AbstractModel {
constructor(){
super();
/**
* <p>Web application id</p>
* @type {string || null}
*/
this.NetworkAppId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.NetworkAppId = 'NetworkAppId' in params ? params.NetworkAppId : null;
}
}
/**
* DeleteShipper request structure.
* @class
*/
class DeleteShipperRequest extends AbstractModel {
constructor(){
super();
/**
* Shipping Rule Id.
-Obtain the ShipperId by [obtaining the shipping task list](https://www.tencentcloud.com/document/product/614/58745?from_cn_redirect=1).
* @type {string || null}
*/
this.ShipperId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ShipperId = 'ShipperId' in params ? params.ShipperId : null;
}
}
/**
* DeleteConsole response structure.
* @class
*/
class DeleteConsoleResponse extends AbstractModel {
constructor(){
super();
/**
* 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 {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Key-value index auto-configuration enables automatic addition of fields from logs into the key-value index, including subsequently added fields in the logs.
* @class
*/
class DynamicIndex extends AbstractModel {
constructor(){
super();
/**
* Automatic configuration switch of the key-value index.
* @type {boolean || null}
*/
this.Status = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Status = 'Status' in params ? params.Status : null;
}
}
/**
* CreateRebuildIndexTask response structure.
* @class
*/
class CreateRebuildIndexTaskResponse extends AbstractModel {
constructor(){
super();
/**
* Reindexing task ID
* @type {string || null}
*/
this.TaskId = null;
/**
* 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 {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TaskId = 'TaskId' in params ? params.TaskId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* CreateSearchView request structure.
* @class
*/
class CreateSearchViewRequest extends AbstractModel {
constructor(){
super();
/**
* <p>log set id</p><p>Logset to which the query view belongs. It is only used to manage the query view. Topics contained in the query view can be irrelevant to this logset.</p>
* @type {string || null}
*/
this.LogsetId = null;
/**
* <p>Region of the logset</p><p>Parameter format: ap-guangzhou</p>
* @type {string || null}
*/
this.LogsetRegion = null;
/**
* <p>View name</p><p>Input parameter limit: Supports up to 255 characters. Cannot contain "|" character.</p>
* @type {string || null}
*/
this.ViewName = null;
/**
* <p>View type</p><p>Enumeration value:</p><ul><li>log: Log topic</li><li>metric: Metric topic</li></ul><p>The topic type in the field of Topics should match the ViewType.</p>
* @type {string || null}
*/
this.ViewType = null;
/**
* <p>The query view contains topics, with a maximum of 10 topics.</p><p>The topic information configured in the Topics field should match the ViewType.</p>
* @type {Array.<ViewSearchTopic> || null}
*/
this.Topics = null;
/**
* <p>Custom query view id prefix</p><p>Parameter format: <code>^[a-z0-9][a-z0-9_-]{1,61}[a-z0-9]$</code></p><p>ViewId format of successfully created query view is ${ViewIdPrefix}-view</p>
* @type {string || null}
*/
this.ViewIdPrefix = null;
/**
* <p>Description</p>
* @type {string || null}
*/
this.Description = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.LogsetId = 'LogsetId' in params ? params.LogsetId : null;
this.LogsetRegion = 'LogsetRegion' in params ? params.LogsetRegion : null;
this.ViewName = 'ViewName' in params ? params.ViewName : null;
this.ViewType = 'ViewType' in params ? params.ViewType : null;
if (params.Topics) {
this.Topics = new Array();
for (let z in params.Topics) {
let obj = new ViewSearchTopic();
obj.deserialize(params.Topics[z]);
this.Topics.push(obj);
}
}
this.ViewIdPrefix = 'ViewIdPrefix' in params ? params.ViewIdPrefix : null;
this.Description = 'Description' in params ? params.Description : null;
}
}
/**
* CheckFunction request structure.
* @class
*/
class CheckFunctionRequest extends AbstractModel {
constructor(){
super();
/**
* Processing statement. When FuncType is 2, EtlContent must use [log_auto_output](https://www.tencentcloud.com/document/product/614/70733?from_cn_redirect=1#b3c58797-4825-4807-bef4-68106e25024f).
Other reference documents
-[Create processing task](https://www.tencentcloud.com/document/product/614/63940?from_cn_redirect=1)
-[Function overview](https://www.tencentcloud.com/document/product/614/70395?from_cn_redirect=1)
* @type {string || null}
*/
this.EtlContent = null;
/**
* Target topic_id and alias of the processing task. This parameter is required when FuncType is 1.
Obtain the target log topic ID through [Get Log Topic List](https://www.tencentcloud.com/document/product/614/56454?from_cn_redirect=1).
* @type {Array.<DataTransformResouceInfo> || null}
*/
this.DstResources = null;
/**
* Type of the target topic for data processing. Valid values: 1 (fixed Topic) and 2 (dynamic creation)
* @type {number || null}
*/
this.FuncType = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.EtlContent = 'EtlContent' in params ? params.EtlContent : null;
if (params.DstResources) {
this.DstResources = new Array();
for (let z in params.DstResources) {
let obj = new DataTransformResouceInfo();
obj.deserialize(params.DstResources[z]);
this.DstResources.push(obj);
}
}
this.FuncType = 'FuncType' in params ? params.FuncType : null;
}
}
/**
* ModifyNetworkApplication response structure.
* @class
*/
class ModifyNetworkApplicationResponse extends AbstractModel {
constructor(){
super();
/**
* 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 {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Splunk delivery task - Configure network information related to the target
* @class
*/
class NetInfo extends AbstractModel {
constructor(){
super();
/**
* Network address.
* @type {string || null}
*/
this.Host = null;
/**
* Port.
* @type {number || null}
*/
this.Port = null;
/**
* Authentication token
* @type {string || null}
*/
this.Token = null;
/**
* Network type; 1: Private network; 2: Public network
* @type {number || null}
*/
this.NetType = null;
/**
* Associated network; If the network type is private network, this field is required.
* @type {string || null}
*/
this.VpcId = null;
/**
* Network service type. If the network type is private network, this field is required.
-0: Cloud cvm
-3: Cloud Direct Connect Gateway
-CCN
-1025: Cloud clb
* @type {number || null}
*/
this.VirtualGatewayType = null;
/**
* Authentication mechanism, whether to use SSL, default non-use
* @type {boolean || null}
*/
this.IsSSL = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Host = 'Host' in params ? params.Host : null;
this.Port = 'Port' in params ? params.Port : null;
this.Token = 'Token' in params ? params.Token : null;
this.NetType = 'NetType' in params ? params.NetType : null;
this.VpcId = 'VpcId' in params ? params.VpcId : null;
this.VirtualGatewayType = 'VirtualGatewayType' in params ? params.VirtualGatewayType : null;
this.IsSSL = 'IsSSL' in params ? params.IsSSL : null;
}
}
/**
* CreateLogset request structure.
* @class
*/
class CreateLogsetRequest extends AbstractModel {
constructor(){
super();
/**
* Log set name.
-Supports a maximum of 255 characters. The `|` character is not supported.
* @type {string || null}
*/
this.LogsetName = null;
/**
* Tag description list. Up to 10 tag key-value pairs are supported and must be unique.
* @type {Array.<Tag> || null}
*/
this.Tags = null;
/**
* Logset ID, format: custom part-User APPID. Automatically generate ID if left empty.
-The custom part only supports lowercase letters, digits, and -, cannot start or end with -, and has a length of 3 to 40 characters.
-The end requires the use of - to concatenate the User APPID, which can be queried on the https://console.cloud.tencent.com/developer page.
-If you specify this field, ensure uniqueness across all regions.
* @type {string || null}
*/
this.LogsetId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.LogsetName = 'LogsetName' in params ? params.LogsetName : null;
if (params.Tags) {
this.Tags = new Array();
for (let z in params.Tags) {
let obj = new Tag();
obj.deserialize(params.Tags[z]);
this.Tags.push(obj);
}
}
this.LogsetId = 'LogsetId' in params ? params.LogsetId : null;
}
}
/**
* CreateScheduledSql response structure.
* @class
*/
class CreateScheduledSqlResponse extends AbstractModel {
constructor(){
super();
/**
* <p>Task ID.</p>
* @type {string || null}
*/
this.TaskId = null;
/**
* 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 {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TaskId = 'TaskId' in params ? params.TaskId : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* Pre-aggregation YAML task details.
* @class
*/
class RecordingRuleYamlTaskInfo extends AbstractModel {
constructor(){
super();
/**
* YAML configuration file ID.
* @type {string || null}
*/
this.YamlId = null;
/**
* Source Log Topic ID
* @type {string || null}
*/
this.TopicId = null;
/**
* Log topic ID for the write description.
* @type {string || null}
*/
this.DstTopicId = null;
/**
* Creation Time
* @type {string || null}
*/
this.CreateTime = null;
/**
* Task Update Time
* @type {string || null}
*/
this.UpdateTime = null;
/**
* Task status, 1: running 2: stopped 3: error - source log topic not found 4: error - destination topic not found
5: Access permission issue 6: Internal failure 7: Other faults
* @type {number || null}
*/
this.Status = null;
/**
* Task status: 1 Enabled, 2 Disabled
* @type {number || null}
*/
this.EnableFlag = null;
/**
* Schedule Start Time
* @type {number || null}
*/
this.ProcessStartTime = null;
/**
* Scheduling Interval (Minutes)
* @type {number || null}
*/
this.ProcessPeriod = null;
/**
* Execution Delay (Seconds)
* @type {number || null}
*/
this.ProcessDelay = null;
/**
* Whether to enable service log shipping. Valid values: 1: disable; 2: enable.
* @type {number || null}
*/
this.HasServicesLog = null;
/**
* YAML configuration file name.
* @type {string || null}
*/
this.YamlConfigName = null;
/**
* YAML configuration file content.
* @type {string || null}
*/
this.YamlContent = null;
/**
* Number of subtasks of the YAML file.
* @type {number || null}
*/
this.SubTaskCount = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.YamlId = 'YamlId' in params ? params.YamlId : null;
this.TopicId = 'TopicId' in params ? params.TopicId : null;
this.DstTopicId = 'DstTopicId' in params ? params.DstTopicId : null;
this.CreateTime = 'CreateTime' in params ? params.CreateTime : null;
this.UpdateTime = 'UpdateTime' in params ? params.UpdateTime : null;
this.Status = 'Status' in params ? params.Status : null;
this.EnableFlag = 'EnableFlag' in params ? params.EnableFlag : null;
this.ProcessStartTime = 'ProcessStartTime' in params ? params.ProcessStartTime : null;
this.ProcessPeriod = 'ProcessPeriod' in params ? params.ProcessPeriod : null;
this.ProcessDelay = 'ProcessDelay' in params ? params.ProcessDelay : null;
this.HasServicesLog = 'HasServicesLog' in params ? params.HasServicesLog : null;
this.YamlConfigName = 'YamlConfigName' in params ? params.YamlConfigName : null;
this.YamlContent = 'YamlContent' in params ? params.YamlContent : null;
this.SubTaskCount = 'SubTaskCount' in params ? params.SubTaskCount : null;
}
}
/**
* SearchLog response structure.
* @class
*/
class SearchLogResponse extends AbstractModel {
constructor(){
super();
/**
* <p>Pass through the Context value returned by this API to obtain more logs later. The expiration time is 1 hour.<br>Note:</p><ul><li>Applicable only for single log topic retrieval. To retrieve multiple log topics, use the Context in Topics.</li></ul>
* @type {string || null}
*/
this.Context = null;
/**
* <p>Whether all logs meeting the retrieval criteria have been returned. If not, use Context parameter to retrieve more logs.<br>Note: This is only valid when the search and analysis statement (Query) does not contain SQL.</p>
* @type {boolean || null}
*/
this.ListOver = null;
/**
* <p>Whether the returned data is the SQL analysis result</p>
* @type {boolean || null}
*/
this.Analysis = null;
/**
* <p>Raw logs matching the retrieval criteria</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<LogInfo> || null}
*/
this.Results = null;
/**
* <p>Column names of log statistics analysis results<br>This parameter is valid only when UseNewAnalysis is false</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.ColNames = null;
/**
* <p>Statistical analysis results of logs<br>This parameter is valid only when UseNewAnalysis is false</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<LogItems> || null}
*/
this.AnalysisResults = null;
/**
* <p>Log statistics and analysis results<br>This parameter is valid only when UseNewAnalysis is true</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<string> || null}
*/
this.AnalysisRecords = null;
/**
* <p>Column attribute of log statistics and analysis results<br>This parameter is valid only when UseNewAnalysis is true</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {Array.<Column> || null}
*/
this.Columns = null;
/**
* <p>Sampling rate used in this analysis</p>
* @type {number || null}
*/
this.SamplingRate = null;
/**
* <p>When multiple log topics are used for retrieval, basic information of each log topic, such as error message.</p>
Note: This field may return null, indicating that no valid values can be obtained.
* @type {SearchLogTopics || null}
*/
this.Topics = null;
/**
* 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 {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Context = 'Context' in params ? params.Context : null;
this.ListOver = 'ListOver' in params ? params.ListOver : null;
this.Analysis = 'Analysis' in params ? params.Analysis : null;
if (params.Results) {
this.Results = new Array();
for (let z in params.Results) {
let obj = new LogInfo();
obj.deserialize(params.Results[z]);
this.Results.push(obj);
}
}
this.ColNames = 'ColNames' in params ? params.ColNames : null;
if (params.AnalysisResults) {
this.AnalysisResults = new Array();
for (let z in params.AnalysisResults) {
let obj = new LogItems();
obj.deserialize(params.AnalysisResults[z]);
this.AnalysisResults.push(obj);
}
}
this.AnalysisRecords = 'AnalysisRecords' in params ? params.AnalysisRecords : null;
if (params.Columns) {
this.Columns = new Array();
for (let z in params.Columns) {
let obj = new Column();
obj.deserialize(params.Columns[z]);
this.Columns.push(obj);
}
}
this.SamplingRate = 'SamplingRate' in params ? params.SamplingRate : null;
if (params.Topics) {
let obj = new SearchLogTopics();
obj.deserialize(params.Topics)
this.Topics = obj;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DeleteMetricSubscribe response structure.
* @class
*/
class DeleteMetricSubscribeResponse extends AbstractModel {
constructor(){
super();
/**
* 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 {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* DescribePartitions request structure.
* @class
*/
class DescribePartitionsRequest extends AbstractModel {
constructor(){
super();
/**
* Log topic ID
-Obtain the log topic Id through [Get Log Topic List](https://www.tencentcloud.com/document/product/614/56454?from_cn_redirect=1).
* @type {string || null}
*/
this.TopicId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TopicId = 'TopicId' in params ? params.TopicId : null;
}
}
/**
* CheckFunction response structure.
* @class
*/
class CheckFunctionResponse extends AbstractModel {
constructor(){
super();
/**
* Failure error code
* @type {number || null}
*/
this.ErrorCode = null;
/**
* Failure error message
* @type {string || null}
*/
this.ErrorMsg = null;
/**
* 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 {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.ErrorCode = 'ErrorCode' in params ? params.ErrorCode : null;
this.ErrorMsg = 'ErrorMsg' in params ? params.ErrorMsg : null;
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* ModifyAlarm response structure.
* @class
*/
class ModifyAlarmResponse extends AbstractModel {
constructor(){
super();
/**
* 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 {string || null}
*/
this.RequestId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.RequestId = 'RequestId' in params ? params.RequestId : null;
}
}
/**
* PreviewKafkaRecharge request structure.
* @class
*/
class PreviewKafkaRechargeRequest extends AbstractModel {
constructor(){
super();
/**
* Preview type. 1: preview of source data; 2: preview of exported results.
* @type {number || null}
*/
this.PreviewType = null;
/**
* Import Kafka type. 0: Tencent Cloud CKafka; 1: user-built kafka.
* @type {number || null}
*/
this.KafkaType = null;
/**
* List of Kafka-related topics to be imported by the user, topics separated by commas.
Supports up to 100.
* @type {string || null}
*/
this.UserKafkaTopics = null;
/**
* Import data location. -2: earliest; -1: latest.
* @type {number || null}
*/
this.Offset = null;
/**
* Tencent Cloud CKafka instance ID. The parameter KafkaInstance is valid and required when KafkaType is 0.
-Get the instance id through [Get Instance List](https://www.tencentcloud.com/document/product/597/40835?from_cn_redirect=1).
* @type {string || null}
*/
this.KafkaInstance = null;
/**
* Service address.
When KafkaType is 1, ServerAddr is required.
* @type {string || null}
*/
this.ServerAddr = null;
/**
* Whether ServerAddr is a secure connection.
Valid when KafkaType is 1.
* @type {boolean || null}
*/
this.IsEncryptionAddr = null;
/**
* Encrypted Access Protocol.
When KafkaType is 1 and IsEncryptionAddr is true, Protocol is required.
* @type {KafkaProtocolInfo || null}
*/
this.Protocol = null;
/**
* User Kafka consumer group.
-A consumption group is a scalable and fault-tolerant consumer mechanism provided by Kafka. Multiple consumers exist in a consumption group, and all consumers in the group consume subscribed data of messages in the Topic. A consumer can consume multiple partitions simultaneously, but one Partition can only be consumed by a single consumer in the group.
* @type {string || null}
*/
this.ConsumerGroupName = null;
/**
* Log import rule
* @type {LogRechargeRuleInfo || null}
*/
this.LogRechargeRule = null;
/**
* User kafka extended information
* @type {UserKafkaMeta || null}
*/
this.UserKafkaMeta = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PreviewType = 'PreviewType' in params ? params.PreviewType : null;
this.KafkaType = 'KafkaType' in params ? params.KafkaType : null;
this.UserKafkaTopics = 'UserKafkaTopics' in params ? params.UserKafkaTopics : null;
this.Offset = 'Offset' in params ? params.Offset : null;
this.KafkaInstance = 'KafkaInstance' in params ? params.KafkaInstance : null;
this.ServerAddr = 'ServerAddr' in params ? params.ServerAddr : null;
this.IsEncryptionAddr = 'IsEncryptionAddr' in params ? params.IsEncryptionAddr : null;
if (params.Protocol) {
let obj = new KafkaProtocolInfo();
obj.deserialize(params.Protocol)
this.Protocol = obj;
}
this.ConsumerGroupName = 'ConsumerGroupName' in params ? params.ConsumerGroupName : null;
if (params.LogRechargeRule) {
let obj = new LogRechargeRuleInfo();
obj.deserialize(params.LogRechargeRule)
this.LogRechargeRule = obj;
}
if (params.UserKafkaMeta) {
let obj = new UserKafkaMeta();
obj.deserialize(params.UserKafkaMeta)
this.UserKafkaMeta = obj;
}
}
}
/**
* Shipping configuration input parameter.
* @class
*/
class DeliverConfig extends AbstractModel {
constructor(){
super();
/**
* Region information.
Example
ap-guangzhou: Guangzhou region.
ap-nanjing Nanjing region.
For detailed information, see [regions and access endpoints](https://www.tencentcloud.com/document/product/614/18940?from_cn_redirect=1) on the official website.
* @type {string || null}
*/
this.Region = null;
/**
* Log topic ID. Obtain the log topic ID through [Get Log Topic List](https://www.tencentcloud.com/document/product/614/56454?from_cn_redirect=1).
* @type {string || null}
*/
this.TopicId = null;
/**
* Data delivery scope.
All logs, including daily logs generated by periodic execution of alarm policies and logs generated by policy changes. Default value.
1: Alarm triggering only and restore log
* @type {number || null}
*/
this.Scope = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Region = 'Region' in params ? params.Region : null;
this.TopicId = 'TopicId' in params ? params.TopicId : null;
this.Scope = 'Scope' in params ? params.Scope : null;
}
}
/**
* DescribeClusterBaseMetricConfigs request structure.
* @class
*/
class DescribeClusterBaseMetricConfigsRequest extends AbstractModel {
constructor(){
super();
/**
* Machine group ID.
* @type {string || null}
*/
this.GroupId = null;
/**
* <li> Filter the topicId by [metric topic id]. Type: String. Required: No</li>
<li>Each request can have up to 10 Filters. The total upper limit of ALL Filter.Values is 100.</li>
* @type {Array.<Filter> || null}
*/
this.Filters = null;
/**
* Page offset. Default value: 0
* @type {number || null}
*/
this.Offset = null;
/**
* Maximum number of entries per page. Default value: 20. Maximum value: 100.
* @type {number || null}
*/
this.Limit = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.GroupId = 'GroupId' in params ? params.GroupId : null;
if (params.Filters) {
this.Filters = new Array();
for (let z in params.Filters) {
let obj = new Filter();
obj.deserialize(params.Filters[z]);
this.Filters.push(obj);
}
}
this.Offset = 'Offset' in params ? params.Offset : null;
this.Limit = 'Limit' in params ? params.Limit : null;
}
}
/**
* DeleteMetricSubscribe request structure.
* @class
*/
class DeleteMetricSubscribeRequest extends AbstractModel {
constructor(){
super();
/**
* Metric collection task ID.
* @type {string || null}
*/
this.TaskId = null;
/**
* Log topic ID of a metric collection task configuration.
* @type {string || null}
*/
this.TopicId = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TaskId = 'TaskId' in params ? params.TaskId : null;
this.TopicId = 'TopicId' in params ? params.TopicId : null;
}
}
/**
* Advanced configuration for CKafka shipping.
* @class
*/
class AdvancedConsumerConfiguration extends AbstractModel {
constructor(){
super();
/**
* Kafka partition hash status. Default false.
-true: Enable sending messages with equal field Hash values to the same Kafka partition.
-false: Disable sending messages with equivalent field Hash values to the same kafka partition.
* @type {boolean || null}
*/
this.PartitionHashStatus = null;
/**
* Field list to calculate hash. Supports a maximum of 5 fields.
* @type {Array.<string> || null}
*/
this.PartitionFields = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.PartitionHashStatus = 'PartitionHashStatus' in params ? params.PartitionHashStatus : null;
this.PartitionFields = 'PartitionFields' in params ? params.PartitionFields : null;
}
}
/**
* Resource information for ScheduledSql
* @class
*/
class ScheduledSqlResouceInfo extends AbstractModel {
constructor(){
super();
/**
* Obtain the log topic Id through [Get Log Topic List](https://www.tencentcloud.com/document/product/614/56454?from_cn_redirect=1).
* @type {string || null}
*/
this.TopicId = null;
/**
* Regional information of the topic. Cross-region selection is not supported currently. For supported regions, see the region list (https://www.tencentcloud.com/document/api/614/56474?from_cn_redirect=1#.E5.9C.B0.E5.9F.9F.E5.88.97.E8.A1.A8) document.
* @type {string || null}
*/
this.Region = null;
/**
* Topic type: 0 for log topic, and 1 for metric topic
* @type {number || null}
*/
this.BizType = null;
/**
* Metric name. When BizType is 1, MetricName needs to be specified.
* @type {string || null}
*/
this.MetricName = null;
/**
* Metric NameWhen BizType is 1, prioritize using the MetricNames field. Multiple metrics can only be filled in the MetricNames field, while it's recommended to fill a single metric in the MetricName field.
* @type {Array.<string> || null}
*/
this.MetricNames = null;
/**
* Metric dimension. Not accept time type.
* @type {Array.<string> || null}
*/
this.MetricLabels = null;
/**
* Metric timestamp. The default value is the left time point of the SQL query time range, but you can also specify other fields (The type is uinx time, TimeStamp, and precision millisecond) as the metric timestamp.
* @type {string || null}
*/
this.CustomTime = null;
/**
* In addition to MetricLabels, this parameter can be used to supplement static dimensions for the metric.
Dimension names must start with a letter or underscore, followed by letters, digits, or underscores, with a length less than or equal to 1024 bytes.
* @type {Array.<MetricLabel> || null}
*/
this.CustomMetricLabels = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.TopicId = 'TopicId' in params ? params.TopicId : null;
this.Region = 'Region' in params ? params.Region : null;
this.BizType = 'BizType' in params ? params.BizType : null;
this.MetricName = 'MetricName' in params ? params.MetricName : null;
this.MetricNames = 'MetricNames' in params ? params.MetricNames : null;
this.MetricLabels = 'MetricLabels' in params ? params.MetricLabels : null;
this.CustomTime = 'CustomTime' in params ? params.CustomTime : null;
if (params.CustomMetricLabels) {
this.CustomMetricLabels = new Array();
for (let z in params.CustomMetricLabels) {
let obj = new MetricLabel();
obj.deserialize(params.CustomMetricLabels[z]);
this.CustomMetricLabels.push(obj);
}
}
}
}
/**
* Authentication-free conditional information.
* @class
*/
class ConditionInfo extends AbstractModel {
constructor(){
super();
/**
* Condition attribute. Currently, only VpcID is supported.
* @type {string || null}
*/
this.Attributes = null;
/**
* Conditional rule. 1: equal to; 2: not equal to.
* @type {number || null}
*/
this.Rule = null;
/**
* Value corresponding to the condition attribute.
* @type {string || null}
*/
this.ConditionValue = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.Attributes = 'Attributes' in params ? params.Attributes : null;
this.Rule = 'Rule' in params ? params.Rule : null;
this.ConditionValue = 'ConditionValue' in params ? params.ConditionValue : null;
}
}
/**
* es cluster configuration
* @class
*/
class EsInfo extends AbstractModel {
constructor(){
super();
/**
* ES Types. 1: Cloud ES, 2: Self-build ES.
* @type {number || null}
*/
this.EsType = null;
/**
* Access method 1: private network, 2: public network. Self-built ES required.
* @type {number || null}
*/
this.AccessMode = null;
/**
* Instance id. Required for es instance.
* @type {string || null}
*/
this.InstanceId = null;
/**
* Username.
* @type {string || null}
*/
this.User = null;
/**
* Access address. Self-built ES required.
* @type {string || null}
*/
this.Address = null;
/**
* Access port. Self-built ES required.
* @type {number || null}
*/
this.Port = null;
/**
* Network. Required when accessing self-built ES via private network.
* @type {string || null}
*/
this.VpcId = null;
/**
* Network service type. Required when accessing a self-built ES via private network.
CLB:1025 Cloud Virtual Machine (CVM):0
* @type {number || null}
*/
this.VirtualGatewayType = null;
/**
* Password.
* @type {string || null}
*/
this.Password = null;
}
/**
* @private
*/
deserialize(params) {
if (!params) {
return;
}
this.EsType = 'EsType' in params ? params.EsType : null;
this.AccessMode = 'AccessMode' in params ? params.AccessMode : null;
this.InstanceId = 'InstanceId' in params ? params.InstanceId : null;
this.User = 'User' in params ? params.User : null;
this.Address = 'Address' in params ? params.Address : null;
this.Port = 'Port' in params ? params.Port : null;
this.VpcId = 'VpcId' in params ? params.VpcId : null;
this.VirtualGatewayType = 'VirtualGatewayType' in params ? params.VirtualGatewayType : null;
this.Password = 'Password' in params ? params.Password : null;
}
}
/**
* DeleteMachineGroup response structure.
* @class
*/
class