com.aliyun.openservices.log.request

Class GetLogsRequest

java.lang.Object

com.aliyun.openservices.log.request.Request

com.aliyun.openservices.log.request.GetLogsRequest

All Implemented Interfaces:

Serializable

public class GetLogsRequest
extends Request

The Request used to get data of a query from sls server

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GetLogsRequest(String project, String logStore, int from, int to, String topic, String query) Construct a the request
GetLogsRequest(String project, String logStore, int from, int to, String topic, String query, long offset, long line, boolean reverse) Construct a the request
GetLogsRequest(String project, String logStore, int from, int to, String topic, String query, long offset, long line, boolean reverse, boolean powerSql) Construct a the request
GetLogsRequest(String project, String logStore, int from, int to, String topic, String query, long offset, long line, boolean reverse, boolean powerSql, boolean forward) Construct a the request
GetLogsRequest(String project, String logStore, int from, int to, String topic, String query, long offset, long line, boolean reverse, boolean forward, String session) Construct a the request
GetLogsRequest(String project, String logStore, int from, int to, String topic, String query, long offset, long line, boolean reverse, int shard) Construct a the request

Method Summary

Modifier and Type	Method and Description
boolean	GetAccurate() Get request accurate flag
Consts.CompressType	getCompressType()
boolean	GetForward() Get request forward flag
int	GetFromNsPart()
int	GetFromTime() Get begin time,
long	GetLine() Get request line number
String	GetLogStore() Get log store name
boolean	GetNeedHighlight()
long	GetOffset() Get request offset
boolean	GetPowerSql() Get request powerSql flag
String	GetQuery() Get Query
String	getRequestBody()
boolean	GetReverse() Get request reverse flag
int	GetToNsPart()
String	GetTopic() Get Topic
int	GetToTime() Get end time
void	SetAccurate(boolean accurate) Set request accurate flag
void	setCompressType(Consts.CompressType compressType)
void	SetForward(boolean forward) Set request forward flag
void	SetFromNsPart(int fromNsPart)
void	SetFromTime(int from) Set begin time
void	SetLine(long line) Get request line number
void	SetLogStore(String logStore) Set log store
void	SetNeedHighlight(boolean needHighlight)
void	SetOffset(long offset) Set request offset
void	SetPowerSql(boolean powerSql) Set request powerSql flag
void	SetQuery(String query) Set query
void	SetReverse(boolean reverse) Set request reverse flag
void	SetSession(String session)
void	SetShard(int shard)
void	SetToNsPart(int toNsPart)
void	SetTopic(String topic) Set topic of the log store
void	SetToTime(int to)

Methods inherited from class com.aliyun.openservices.log.request.Request

GetAllParams, GetParam, GetProject, SetParam

Methods inherited from class java.lang.Object

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

Constructor Detail

GetLogsRequest

public GetLogsRequest(String project,
                      String logStore,
                      int from,
                      int to,
                      String topic,
                      String query)

Construct a the request

Parameters:

project - project name

logStore - log store name of a project

from - begin time

to - end time

topic - topic name of a log store

query - user query

GetLogsRequest

public GetLogsRequest(String project,
                      String logStore,
                      int from,
                      int to,
                      String topic,
                      String query,
                      long offset,
                      long line,
                      boolean reverse)

Construct a the request

Parameters:

project - project name

logStore - log store name of a project

from - begin time

to - end time

topic - topic name of a log store

query - user query

offset - the log offset to return

line - how many lines to get, the max lines is decided by the sls backend server

reverse - if reverse is set to true, the query will return the latest logs first

GetLogsRequest

public GetLogsRequest(String project,
                      String logStore,
                      int from,
                      int to,
                      String topic,
                      String query,
                      long offset,
                      long line,
                      boolean reverse,
                      boolean powerSql)

Construct a the request

Parameters:

project - project name

logStore - log store name of a project

from - begin time

to - end time

topic - topic name of a log store

query - user query

offset - the log offset to return

line - how many lines to get, the max lines is decided by the sls backend server

reverse - if reverse is set to true, the query will return the latest logs first

GetLogsRequest

public GetLogsRequest(String project,
                      String logStore,
                      int from,
                      int to,
                      String topic,
                      String query,
                      long offset,
                      long line,
                      boolean reverse,
                      boolean powerSql,
                      boolean forward)

Construct a the request

Parameters:

project - project name

logStore - log store name of a project

from - begin time

to - end time

topic - topic name of a log store

query - user query

offset - the log offset to return

line - how many lines to get, the max lines is decided by the sls backend server

reverse - if reverse is set to true, the query will return the latest logs first

forward - only usable when phrase query, forward is ture means next page, otherwise means previous page

GetLogsRequest

public GetLogsRequest(String project,
                      String logStore,
                      int from,
                      int to,
                      String topic,
                      String query,
                      long offset,
                      long line,
                      boolean reverse,
                      int shard)

Construct a the request

Parameters:

project - project name

logStore - log store name of a project

from - begin time

to - end time

topic - topic name of a log store

query - user query

offset - the log offset to return

line - how many lines to get, the max lines is decided by the sls backend server

reverse - if reverse is set to true, the query will return the latest logs first

shard - specific shard

GetLogsRequest

public GetLogsRequest(String project,
                      String logStore,
                      int from,
                      int to,
                      String topic,
                      String query,
                      long offset,
                      long line,
                      boolean reverse,
                      boolean forward,
                      String session)

Construct a the request

Parameters:

project - project name

logStore - log store name of a project

from - begin time

to - end time

topic - topic name of a log store

query - user query

offset - the log offset to return

line - how many lines to get, the max lines is decided by the sls backend server

reverse - if reverse is set to true, the query will return the latest logs first

session - query session param

Method Detail

SetLogStore

public void SetLogStore(String logStore)

Set log store

Parameters:

logStore - log store name

GetLogStore

public String GetLogStore()

Get log store name

Returns:

log store name

SetTopic

public void SetTopic(String topic)

Set topic of the log store

Parameters:

topic - topic name

GetTopic

public String GetTopic()

Get Topic

Returns:

topic name

SetQuery

public void SetQuery(String query)

Set query

Parameters:

query - user define query

GetQuery

public String GetQuery()

Get Query

Returns:

query

SetFromTime

public void SetFromTime(int from)

Set begin time

Parameters:

from - begin time

GetFromTime

public int GetFromTime()

Get begin time,

Returns:

begin time

SetToTime

public void SetToTime(int to)

GetToTime

public int GetToTime()

Get end time

Returns:

end time

SetOffset

public void SetOffset(long offset)

Set request offset

Parameters:

offset - log offset

GetOffset

public long GetOffset()

Get request offset

Returns:

offset value

SetLine

public void SetLine(long line)

Get request line number

Parameters:

line - line number

GetLine

public long GetLine()

Get request line number

Returns:

line number

SetReverse

public void SetReverse(boolean reverse)

Set request reverse flag

Parameters:

reverse - reverse flag

GetReverse

public boolean GetReverse()

Get request reverse flag

Returns:

reverse flag

SetPowerSql

public void SetPowerSql(boolean powerSql)

Set request powerSql flag

Parameters:

powerSql - powerSql flag

SetShard

public void SetShard(int shard)

SetSession

public void SetSession(String session)

GetPowerSql

public boolean GetPowerSql()

Get request powerSql flag

Returns:

powerSql flag

SetForward

public void SetForward(boolean forward)

Set request forward flag

Parameters:

forward - forward flag

GetForward

public boolean GetForward()

Get request forward flag

Returns:

forward flag

SetAccurate

public void SetAccurate(boolean accurate)

Set request accurate flag

Parameters:

accurate - accurate flag

GetAccurate

public boolean GetAccurate()

Get request accurate flag

Returns:

accurate flag

getCompressType

public Consts.CompressType getCompressType()

setCompressType

public void setCompressType(Consts.CompressType compressType)

SetNeedHighlight

public void SetNeedHighlight(boolean needHighlight)

GetNeedHighlight

public boolean GetNeedHighlight()

SetFromNsPart

public void SetFromNsPart(int fromNsPart)

GetFromNsPart

public int GetFromNsPart()

SetToNsPart

public void SetToNsPart(int toNsPart)

GetToNsPart

public int GetToNsPart()

getRequestBody

public String getRequestBody()