com.tencentcloudapi.teo.v20220901.models

Class CreateRealtimeLogDeliveryTaskRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.teo.v20220901.models.CreateRealtimeLogDeliveryTaskRequest

public class CreateRealtimeLogDeliveryTaskRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
CreateRealtimeLogDeliveryTaskRequest()
CreateRealtimeLogDeliveryTaskRequest(CreateRealtimeLogDeliveryTaskRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
String	getArea() Get 数据投递区域，取值有： mainland：中国大陆境内； overseas：全球（不含中国大陆）。
CLSTopic	getCLS() Get CLS 的配置信息。当 TaskType 取值为 cls 时，该参数必填。
CustomEndpoint	getCustomEndpoint() Get 自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时，该参数必填。
CustomField[]	getCustomFields() Get 投递的自定义字段列表，支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复，且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志（LogType=domain）支持添加自定义字段。
DeliveryCondition[]	getDeliveryConditions() Get 日志投递的过滤条件，不填表示投递全量日志。
String[]	getEntityList() Get 实时日志投递任务对应的实体列表。取值示例如下： 七层域名：domain.example.com 四层代理实例：sid-2s69eb5wcms7 边缘函数实例：test-zone-2mxigizoh9l9-1257626257
String[]	getFields() Get 投递的预设字段列表。取值参考： [站点加速日志（七层访问日志）](https://cloud.tencent.com/document/product/1552/105791) [四层代理日志](https://cloud.tencent.com/document/product/1552/105792) [边缘函数运行日志](https://cloud.tencent.com/document/product/1552/115585)
LogFormat	getLogFormat() Get 日志投递的输出格式。不填表示为默认格式，默认格式逻辑如下： 当 TaskType 取值为 custom_endpoint 时，默认格式为多个 JSON 对象组成的数组，每个 JSON 对象为一条日志； 当 TaskType 取值为 s3 时，默认格式为 JSON Lines；特别地，当 TaskType 取值为 cls 时，LogFormat.FormatType 的值只能为 json，且 LogFormat 中其他参数将被忽略，建议不传 LogFormat。
String	getLogType() Get 数据投递类型，取值有： domain：站点加速日志； application：四层代理日志； function：边缘函数运行日志； web-rateLiming：速率限制和 CC 攻击防护日志； web-attack：托管规则日志； web-rule：自定义规则日志； web-bot：Bot管理日志。
S3	getS3() Get AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时，该参数必填。
Long	getSample() Get 采样比例，采用千分制，取值范围为1-1000，例如：填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。
String	getTaskName() Get 实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。
String	getTaskType() Get 实时日志投递任务类型，取值有： cls: 推送到腾讯云 CLS； custom_endpoint：推送到自定义 HTTP(S) 地址； s3：推送到 AWS S3 兼容存储桶地址；
String	getZoneId() Get 站点 ID。
void	setArea(String Area) Set 数据投递区域，取值有： mainland：中国大陆境内； overseas：全球（不含中国大陆）。
void	setCLS(CLSTopic CLS) Set CLS 的配置信息。当 TaskType 取值为 cls 时，该参数必填。
void	setCustomEndpoint(CustomEndpoint CustomEndpoint) Set 自定义 HTTP 服务的配置信息。当 TaskType 取值为 custom_endpoint 时，该参数必填。
void	setCustomFields(CustomField[] CustomFields) Set 投递的自定义字段列表，支持在 HTTP 请求头、响应头、Cookie、请求正文中提取指定内容。自定义字段名称不能重复，且最多不能超过 200 个字段。单个实时日志推送任务最多添加 5 个请求正文类型的自定义字段。目前仅站点加速日志（LogType=domain）支持添加自定义字段。
void	setDeliveryConditions(DeliveryCondition[] DeliveryConditions) Set 日志投递的过滤条件，不填表示投递全量日志。
void	setEntityList(String[] EntityList) Set 实时日志投递任务对应的实体列表。取值示例如下： 七层域名：domain.example.com 四层代理实例：sid-2s69eb5wcms7 边缘函数实例：test-zone-2mxigizoh9l9-1257626257
void	setFields(String[] Fields) Set 投递的预设字段列表。取值参考： [站点加速日志（七层访问日志）](https://cloud.tencent.com/document/product/1552/105791) [四层代理日志](https://cloud.tencent.com/document/product/1552/105792) [边缘函数运行日志](https://cloud.tencent.com/document/product/1552/115585)
void	setLogFormat(LogFormat LogFormat) Set 日志投递的输出格式。不填表示为默认格式，默认格式逻辑如下： 当 TaskType 取值为 custom_endpoint 时，默认格式为多个 JSON 对象组成的数组，每个 JSON 对象为一条日志； 当 TaskType 取值为 s3 时，默认格式为 JSON Lines；特别地，当 TaskType 取值为 cls 时，LogFormat.FormatType 的值只能为 json，且 LogFormat 中其他参数将被忽略，建议不传 LogFormat。
void	setLogType(String LogType) Set 数据投递类型，取值有： domain：站点加速日志； application：四层代理日志； function：边缘函数运行日志； web-rateLiming：速率限制和 CC 攻击防护日志； web-attack：托管规则日志； web-rule：自定义规则日志； web-bot：Bot管理日志。
void	setS3(S3 S3) Set AWS S3 兼容存储桶的配置信息。当 TaskType 取值为 s3 时，该参数必填。
void	setSample(Long Sample) Set 采样比例，采用千分制，取值范围为1-1000，例如：填写 605 表示采样比例为 60.5%。不填表示采样比例为 100%。
void	setTaskName(String TaskName) Set 实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。
void	setTaskType(String TaskType) Set 实时日志投递任务类型，取值有： cls: 推送到腾讯云 CLS； custom_endpoint：推送到自定义 HTTP(S) 地址； s3：推送到 AWS S3 兼容存储桶地址；
void	setZoneId(String ZoneId) Set 站点 ID。
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CreateRealtimeLogDeliveryTaskRequest

public CreateRealtimeLogDeliveryTaskRequest()

CreateRealtimeLogDeliveryTaskRequest

public CreateRealtimeLogDeliveryTaskRequest(CreateRealtimeLogDeliveryTaskRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getZoneId

public String getZoneId()

Get 站点 ID。

Returns:

ZoneId 站点 ID。

setZoneId

public void setZoneId(String ZoneId)

Set 站点 ID。

Parameters:

ZoneId - 站点 ID。

getTaskName

public String getTaskName()

Get 实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。

Returns:

TaskName 实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。

setTaskName

public void setTaskName(String TaskName)

Set 实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。

Parameters:

TaskName - 实时日志投递任务的名称，格式为数字、英文、-和_组合，最多 200 个字符。

getTaskType

public String getTaskType()

Get 实时日志投递任务类型，取值有：

cls: 推送到腾讯云 CLS； custom_endpoint：推送到自定义 HTTP(S) 地址； s3：推送到 AWS S3 兼容存储桶地址；

Returns:

TaskType 实时日志投递任务类型，取值有：

cls: 推送到腾讯云 CLS；

custom_endpoint：推送到自定义 HTTP(S) 地址；

s3：推送到 AWS S3 兼容存储桶地址；

setTaskType

public void setTaskType(String TaskType)

Set 实时日志投递任务类型，取值有：

cls: 推送到腾讯云 CLS； custom_endpoint：推送到自定义 HTTP(S) 地址； s3：推送到 AWS S3 兼容存储桶地址；