GetLogsV2Request.Builder (alibabacloud-sls20201230 4.0.12 API)

java.lang.Object
- com.aliyun.sdk.service.sls20201230.models.GetLogsV2Request.Builder

所有已实现的接口:

darabonba.core.RequestModel.Builder<GetLogsV2Request,GetLogsV2Request.Builder>

封闭类:

GetLogsV2Request
```
public static final class GetLogsV2Request.Builder
extends Object
```

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`GetLogsV2Request.Builder`	`acceptEncoding(String acceptEncoding)` The compression format.
`GetLogsV2Request`	`build()`
`GetLogsV2Request.Builder`	`forward(Boolean forward)` Specifies whether to page forward or backward for the scan-based query or phrase search.
`GetLogsV2Request.Builder`	`from(Integer from)` The beginning of the time range to query.
`GetLogsV2Request.Builder`	`highlight(Boolean highlight)` Specifies whether to highlight the returned result.
`GetLogsV2Request.Builder`	`line(Long line)` The maximum number of logs to return for the request.
`GetLogsV2Request.Builder`	`logstore(String logstore)` The name of the Logstore.
`GetLogsV2Request.Builder`	`offset(Long offset)` The line from which the query starts.
`GetLogsV2Request.Builder`	`powerSql(Boolean powerSql)` Specifies whether to enable the SQL enhancement feature.
`GetLogsV2Request.Builder`	`project(String project)` The name of the project.
`GetLogsV2Request.Builder`	`query(String query)` The search statement or query statement.
`GetLogsV2Request.Builder`	`reverse(Boolean reverse)` Specifies whether to return logs in reverse chronological order of log timestamps.
`GetLogsV2Request.Builder`	`session(String session)` The parameter that is used to query data.
`GetLogsV2Request.Builder`	`to(Integer to)` The end of the time range to query.
`GetLogsV2Request.Builder`	`topic(String topic)` The topic of the logs.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 方法详细资料
  - project
```
public GetLogsV2Request.Builder project(String project)
```
    The name of the project.
    
    This parameter is required.
    example:
    ali-test-project
  - logstore
```
public GetLogsV2Request.Builder logstore(String logstore)
```
    The name of the Logstore.
    
    This parameter is required.
    example:
    test-logstore
  - acceptEncoding
```
public GetLogsV2Request.Builder acceptEncoding(String acceptEncoding)
```
    The compression format.
    - For Java, Python, and Go, only the lz4 and gzip algorithms are supported for decompression.
    - For PHP, JavaScript, and C#, only the gzip algorithm is supported for decompression.
    This parameter is required.
    example:
    lz4
  - forward
```
public GetLogsV2Request.Builder forward(Boolean forward)
```
    Specifies whether to page forward or backward for the scan-based query or phrase search.
    example:
    false
  - from
```
public GetLogsV2Request.Builder from(Integer from)
```
    The beginning of the time range to query. The value is the log time that is specified when log data is written.
    
    The time range that is specified in this operation is a left-closed, right-open interval. The interval includes the start time specified by the from parameter, but does not include the end time specified by the to parameter. If you specify the same value for the from and to parameters, the interval is invalid, and an error message is returned. The value is a timestamp that follows the UNIX time format. It is the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
    
    This parameter is required.
    example:
    1627268185
  - highlight
```
public GetLogsV2Request.Builder highlight(Boolean highlight)
```
    Specifies whether to highlight the returned result.
    example:
    false
  - line
```
public GetLogsV2Request.Builder line(Long line)
```
    The maximum number of logs to return for the request. This parameter takes effect only when the query parameter is set to a search statement. Valid values: 0 to 100. Default value: 100.
    example:
    100
  - offset
```
public GetLogsV2Request.Builder offset(Long offset)
```
    The line from which the query starts. This parameter takes effect only when the query parameter is set to a search statement. Default value: 0.
    example:
    0
  - powerSql
```
public GetLogsV2Request.Builder powerSql(Boolean powerSql)
```
    Specifies whether to enable the SQL enhancement feature. By default, the feature is disabled.
    example:
    false
  - query
```
public GetLogsV2Request.Builder query(String query)
```
    The search statement or query statement. For more information, see the "Log search overview" and "Log analysis overview" topics.
    
    If you add set session parallel_sql=true; to the analytic statement in the query parameter, Dedicated SQL is used. Example: * | set session parallel_sql=true; select count(*) as pv.
    
    Note: If you specify an analytic statement in the query parameter, the line and offset parameters do not take effect in this operation. In this case, we recommend that you set the line and offset parameters to 0 and use the LIMIT clause to specify the number of logs to return on each page. For more information, see the "Perform paged queries" topic.
    example:
    status: 401 | SELECT remote_addr,COUNT(*) as pv GROUP by remote_addr ORDER by pv desc limit 5
  - reverse
```
public GetLogsV2Request.Builder reverse(Boolean reverse)
```
    Specifies whether to return logs in reverse chronological order of log timestamps. The log timestamps are accurate to minutes. Valid values:
    
    true: Logs are returned in reverse chronological order of log timestamps. false (default): Logs are returned in chronological order of log timestamps. Note: The reverse parameter takes effect only when the query parameter is set to a search statement. The reverse parameter specifies the method used to sort returned logs. If the query parameter is set to a query statement, the reverse parameter does not take effect. The method used to sort returned logs is specified by the ORDER BY clause in the analytic statement. If you use the keyword asc in the ORDER BY clause, the logs are sorted in chronological order. If you use the keyword desc in the ORDER BY clause, the logs are sorted in reverse chronological order. By default, asc is used in the ORDER BY clause.
    example:
    false
  - session
```
public GetLogsV2Request.Builder session(String session)
```
    The parameter that is used to query data.
    example:
    mode=scan
  - to
```
public GetLogsV2Request.Builder to(Integer to)
```
    The end of the time range to query. The value is the log time that is specified when log data is written.
    
    The time range that is specified in this operation is a left-closed, right-open interval. The interval includes the start time specified by the from parameter, but does not include the end time specified by the to parameter. If you specify the same value for the from and to parameters, the interval is invalid, and an error message is returned. The value is a timestamp that follows the UNIX time format. It is the number of seconds that have elapsed since January 1, 1970, 00:00:00 UTC.
    
    This parameter is required.
    example:
    1627268185
  - topic
```
public GetLogsV2Request.Builder topic(String topic)
```
    The topic of the logs. Default value: double quotation marks ("").
    example:
    ""
  - build
```
public GetLogsV2Request build()
```

类 GetLogsV2Request.Builder

方法概要

从类继承的方法 java.lang.Object

方法详细资料

project

logstore

acceptEncoding

forward

from

highlight

line

offset

powerSql

query

reverse

session

to

topic

build