com.aliyun.openservices.log.LogService Maven / Gradle / Ivy
/*
* Copyright (C) Alibaba Cloud Computing All rights reserved.
*/
package com.aliyun.openservices.log;
import com.aliyun.openservices.log.common.*;
import com.aliyun.openservices.log.common.Consts.CursorMode;
import com.aliyun.openservices.log.exception.LogException;
import com.aliyun.openservices.log.request.*;
import com.aliyun.openservices.log.response.*;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.Map;
public interface LogService {
/**
* Get The log status(histogram info) from log service server which match
* input parameters. All the logs with logstore and topic in [from, to)
* which contain the keys in query are the matched data.
*
* @param project
* the project name
* @param logstore
* the result data logstore
* @param from
* the begin time of the result data to get
* @param to
* the end time of the result data to get
* @param topic
* the result data topic
*
* @param query
* If the query is not empty, it will return the logs contain the
* keys in query, if "all_hit" is contained in the query, only
* the logs contains all the keys in query are matched logs,
* other wise logs contain any key in query are matched logs.
* @return the histogram response of the matched logs
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetHistogramsResponse GetHistograms(String project, String logstore,
int from, int to, String topic, String query) throws LogException;
/**
* Get The log status(histogram info) from log service server which match
* input parameters. All the logs with logstore and topic in [from, to)
* which contain the keys in query are the matched data.
*
* @param request
* the get histogram request
* @return the histogram response of the matched logs
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if required parameter is null
*/
GetHistogramsResponse GetHistograms(GetHistogramsRequest request)
throws LogException;
/**
* Get The sub set of logs data from log service server which match input
* parameters. By default, it will return at most 20 lines
*
* @param project
* the project name
* @param logStore
* the result data logstore
* @param from
* the begin time of the result data to get
* @param to
* the end time of the result data to get
* @param topic
* the result data topic
* @param query
* If the query is not empty, it will return the logs contain the
* keys in query, if "all_hit" is contained in the query, only
* the logs contains all the keys in query are matched logs,
* other wise logs contain any key in query are matched logs
* @return a response contains a sub set of the logs matched the input
* parameters
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetLogsResponse GetLogs(String project, String logStore, int from,
int to, String topic, String query) throws LogException;
/**
* Get The sub set of logs data from log service server which match input
* parameters. All the data with logstore and topic in [from, to) which
* contain the keys in query are the matched data.
*
* @param project
* the project name
* @param logStore
* the result data logstore
* @param from
* the begin time of the result data to get
* @param to
* the end time of the result data to get
* @param topic
* the result data topic
* @param reverse
* a flag to determine the return data order, if reverse is set
* to false, the return logs is ascending order by time, other
* wise, it's descending order
* @param line
* how many lines to get, the max lines is decided by the sls
* backend server
* @param offset
* the start log index in all the matched logs.
* @param query
* If the query is not empty, it will return the logs contain the
* keys in query, if "all_hit" is contained in the query, only
* the logs contains all the keys in query are matched logs,
* other wise logs contain any key in query are matched logs.
* @param powerSql
* if the query runs using a power instance
* @return a response contains a sub set of the logs matched the input
* parameters
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetLogsResponse GetLogs(String project, String logStore, int from,
int to, String topic, String query, long line, long offset,
boolean reverse,
boolean powerSql) throws LogException;
/**
* Get The sub set of logs data from log service server which match input
* parameters. All the data with logstore and topic in [from, to) which
* contain the keys in query are the matched data.
*
* @param project
* the project name
* @param logStore
* the result data logstore
* @param from
* the begin time of the result data to get
* @param to
* the end time of the result data to get
* @param topic
* the result data topic
* @param reverse
* a flag to determine the return data order, if reverse is set
* to false, the return logs is ascending order by time, other
* wise, it's descending order
* @param line
* how many lines to get, the max lines is decided by the sls
* backend server
* @param offset
* the start log index in all the matched logs.
* @param query
* If the query is not empty, it will return the logs contain the
* keys in query, if "all_hit" is contained in the query, only
* the logs contains all the keys in query are matched logs,
* other wise logs contain any key in query are matched logs.
* @param powerSql
* if the query runs using a power instance
* @return a response contains a sub set of the logs matched the input
* parameters
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetLogsResponse GetLogs(String project, String logStore, int from,
int to, String topic, String query, long line, long offset,
boolean reverse,
boolean powerSql,
boolean forward) throws LogException;
/**
* Get The sub set of logs data from log service server which match input
* parameters. All the data with logstore and topic in [from, to) which
* contain the keys in query are the matched data.
*
* @param project
* the project name
* @param logStore
* the result data logstore
* @param from
* the begin time of the result data to get
* @param to
* the end time of the result data to get
* @param topic
* the result data topic
* @param reverse
* a flag to determine the return data order, if reverse is set
* to false, the return logs is ascending order by time, other
* wise, it's descending order
* @param line
* how many lines to get, the max lines is decided by the sls
* backend server
* @param offset
* the start log index in all the matched logs.
* @param query
* If the query is not empty, it will return the logs contain the
* keys in query, if "all_hit" is contained in the query, only
* the logs contains all the keys in query are matched logs,
* otherwise logs contain any key in query are matched logs.
* @param shard
* specific shard
* @return a response contains a sub set of the logs matched the input
* parameters
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetLogsResponse GetLogs(String project, String logStore, int from,
int to, String topic, String query, long line, long offset,
boolean reverse, int shard) throws LogException;
/**
* Get The sub set of logs data from log service server which match input
* parameters. All the data with logstore and topic in [from, to) which
* contain the keys in query are the matched data.
*
* @param project
* the project name
* @param logStore
* the result data logstore
* @param from
* the begin time of the result data to get
* @param to
* the end time of the result data to get
* @param topic
* the result data topic
* @param reverse
* a flag to determine the return data order, if reverse is set
* to false, the return logs is ascending order by time, other
* wise, it's descending order
* @param line
* how many lines to get, the max lines is decided by the sls
* backend server
* @param offset
* the start log index in all the matched logs.
* @param query
* If the query is not empty, it will return the logs contain the
* keys in query, if "all_hit" is contained in the query, only
* the logs contains all the keys in query are matched logs,
* otherwise logs contain any key in query are matched logs.
* @param session
* query session param, should be like powerSql=true;schema_free=true;....
* @return a response contains a sub set of the logs matched the input
* parameters
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetLogsResponse GetLogs(String project, String logStore, int from,
int to, String topic, String query, long line, long offset,
boolean reverse, boolean forward, String session) throws LogException;
/**
* Get The sub set of logs data from log service server which match input
* parameters.
*
* @param request
* the get logs request
* @return a response contains a sub set of the logs matched the input
* parameters
* @throws NullPointerException
* if required parameter is null
* @throws LogException
* if any error happen when get the data from log service server
*/
GetLogsResponse GetLogs(GetLogsRequest request) throws LogException;
/**
* Execute the SQL in the Project and Logstore with input parameters.
*
* @param project
* the project name
* @param logStore
* the logstore name
* @param from
* the begin time of the data to get
* @param to
* the end time of the data to get
* @param sql
* the sql string which must follow Search|Analysis syntax in SLS
* @param powerSql
* execute in enhanced sql mode if true, or normal mode if false
* @return a response contains a result set of the sql
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetLogsResponse executeLogstoreSql(String project, String logStore, int from,
int to, String sql, boolean powerSql) throws LogException;
/**
* compute logs with a sql query from the whole project
*
* @param project
* the project name
* @param query
* stardard sql query, compute from the whole project
* @return a response contains a sub set of the logs matched the input
* parameters
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetLogsResponse GetProjectLogs(String project, String query) throws LogException;
/**
* compute logs with a sql query from the whole project
*
* @param request
* the get project logs request
* @return a response contains a sub set of the logs matched the input
* parameters
* @throws NullPointerException
* if required parameter is null
* @throws LogException
* if any error happen when get the data from log service server
*/
GetLogsResponse GetProjectLogs(GetProjectLogsRequest request) throws LogException;
/**
* Execute the SQL in the Project with input parameters.
*
* @param project
* the project name
* @param sql
* the sql string which must follow SQL syntax
* @param powerSql
* execute in enhanced sql mode if true, or normal mode if false
* @return a response contains a result set of the sql
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
GetLogsResponse executeProjectSql(String project, String sql, boolean powerSql) throws LogException;
/**
* get all the logstore between offset to (offset + size - 1) under given project
*
* @param project
* the project name
*
* @param offset
* the begin offset
*
* @param size
* the query logstore name count
*
* @return the user's logstore response
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project is empty
*/
ListLogStoresResponse ListLogStores(String project, int offset, int size) throws LogException;
/**
* Get all the logstore for the user
*
* @param project
* the project name
*
* @param offset
* the begin offset
*
* @param size
* the query logstore name count
*
* @param logstoreName
* part name of the logstore, only return the logstores which
* contains the input name
*
* @return the user's logstore response
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
ListLogStoresResponse ListLogStores(String project, int offset,
int size, String logstoreName) throws LogException;
/**
* Get all the logstore of a project
*
* @param request
* the list log store request
* @return the user's logstore response
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if required parameter is null
*/
ListLogStoresResponse ListLogStores(ListLogStoresRequest request)
throws LogException;
/**
* Send Data to log service server
*
* @param project
* the project name
* @param logStore
* the log store where the source data should be put
* @param topic
* source data topic
* @param logItems
* the log data to send
*
* @param source
* the source of the data, if the source is empty, it will be
* reset to the host ip
*
* @return The put logs response
*
* @throws LogException
* if any error happen when send data to the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty, or the logGroup log count
* exceed 4096, or the total data size exceed 5MB
*/
PutLogsResponse PutLogs(String project, String logStore,
String topic, List logItems, String source)
throws LogException;
/**
* Send Data to log service server
*
* @param project
* the project name
* @param logStore
* the log store where the source data should be put
* @param topic
* source data topic
* @param logItems
* the log data to send
* @param source
* the source of the data, if the source is empty, it will be
* reset to the host ip
* @param shardHash
* the hash key md5value (00000000000000000000000000000000 ~
* ffffffffffffffffffffffffffffffff)
* @return The put logs response
* @throws LogException
* if any error happen when send data to the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty, or the logGroup log count
* exceed 4096, or the total data size exceed 5MB
*/
PutLogsResponse PutLogs(String project, String logStore,
String topic, List logItems, String source,
String shardHash) throws LogException;
/**
* Send Data to log service server
*
* @param request
* the put log request
*
* @return The put logs response
*
* @throws LogException
* if any error happen when send data to the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty, or the logGroup log count
* exceed 4096, or the total data size exceed 5MB
*/
PutLogsResponse PutLogs(PutLogsRequest request) throws LogException;
/**
* Send Data to log service server in batches
*
* @param request
* the batch put log request
*
* @return The batch put logs response
*
* @throws LogException
* if any error happen when send data to the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty, or the total logGroup log count
* exceed 4096, or the total data size exceed 5MB
*/
BatchPutLogsResponse batchPutLogs(BatchPutLogsRequest request) throws LogException;
/**
* Get cursor from log service server
*
* @param project
* the project name
* @param logStore
* the log store name
* @param shardId
* the shard where the cursor should be get
* @param fromTime
* the from time of log data in unix time stamp sec
*
* @return The get cursor response
*
* @throws LogException
* if any error happen when get cursor from the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logStore is empty
*/
GetCursorResponse GetCursor(String project, String logStore,
int shardId, long fromTime) throws LogException;
/**
* Get cursor from log service server
*
* @param project
* the project name
* @param logStore
* the log store name
* @param shardId
* the shard where the cursor should be get
* @param fromTime
* the from time of log data in java Date
*
* @return The get cursor response
*
* @throws LogException
* if any error happen when get cursor from the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any string argument in request is empty
*/
GetCursorResponse GetCursor(String project, String logStore,
int shardId, Date fromTime) throws LogException;
/**
* Get cursor from log service server
*
* @param project
* the project name
* @param logStore
* the log store name
* @param shardId
* the shard where the cursor should be get
* @param mode
* the mode to get cursor, include BEGIN and END
*
* @return The get cursor response
*
* @throws LogException
* if any error happen when get cursor from the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any string argument in request is empty
*/
GetCursorResponse GetCursor(String project, String logStore,
int shardId, CursorMode mode) throws LogException;
/**
* Get cursor from log service server
*
* @param request
* the get cursor request
*
* @return The get cursor response
*
* @throws LogException
* if any error happen when get cursor from the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any string argument in request is empty
*/
GetCursorResponse GetCursor(GetCursorRequest request) throws LogException;
/**
* Get the receive time of the package according to the cursor
*
* @param project
* the project name
* @param logStore
* the logstore name
* @param shardId
* shard id
* @param cursor
* cursor of a shard
* @return the cursor time response
* @throws LogException
* if any error happen when get cursor from the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any string argument in request is empty
*/
GetCursorTimeResponse GetCursorTime(String project, String logStore,
int shardId, String cursor) throws LogException;
/**
* Get the receive time of the package according to the cursor
*
* @param request
* the request
* @return cursor time response * @throws LogException if any error happen
* when get cursor from the server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any string argument in request is empty
*/
GetCursorTimeResponse GetCursorTime(GetCursorTimeRequest request)
throws LogException;
/**
* Get the shards in the logtstore
*
* @param project
* the project name
* @param logStore
* where the shard belongs to
*
* @return the log store's shards response
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore is empty
*/
ListShardResponse ListShard(String project, String logStore) throws LogException;
/**
* Get the shards in the logtstore
*
* @param request
* the get cursor request
*
* @return the log store's shards response
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore in request is empty
*/
ListShardResponse ListShard(ListShardRequest request) throws LogException;
/**
* split a readwrite shard in the logtstore
*
* @param project
* the project name
* @param logStore
* where the shard belongs to
* @param shardId
* the shard id to split
* @param midHash
* the middle md5 hash string to split the shard
*
* @return the splited shard and two new generated readwrite shard
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore in request is empty
*/
ListShardResponse SplitShard(String project, String logStore,
int shardId, String midHash) throws LogException;
/**
* split a readwrite shard in the logtstore
*
* @param request
* split shard request
*
* @return the splited shard and two new generated readwrite shard
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore in request is empty
*/
ListShardResponse SplitShard(SplitShardRequest request) throws LogException;
/**
* merge two readwrite shards in the logtstore
*
* @param project
* the project name
* @param logStore
* where the shard belongs to
* @param shardId
* the shard id to merge with right adjacent shard
*
* @return the merges shards and new generated readwrite shard
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore in request is empty
*/
ListShardResponse MergeShards(String project, String logStore,
int shardId) throws LogException;
/**
* merge two readwrite shards in the logtstore
*
* @param request
* the project name
*
* @return the merges shards and new generated readwrite shard
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore in request is empty
*/
ListShardResponse MergeShards(MergeShardsRequest request) throws LogException;
/**
* Batch get log
*
* @param project
* the project name
* @param logStore
* where the shard belongs to
* @param shardId
* the shard to batch get log
* @param count
* the logrgroup num
* @param cursor
* the cursor to batch get log
*
* @return batch get log response
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore or cursor is empty
* @deprecated Please use {@code pullLogs} instead.
*/
@Deprecated
BatchGetLogResponse BatchGetLog(String project, String logStore,
int shardId, int count, String cursor) throws LogException;
/**
* Batch get log
*
* @param project
* the project name
* @param logStore
* where the shard belongs to
* @param shardId
* the shard to batch get log
* @param count
* the logrgroup num
* @param cursor
* the cursor to batch get log
*
* @param end_cursor
* the end cursor to batch get log
*
* @return batch get log response
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore or cursor is empty
* @deprecated Please use {@code pullLogs} instead.
*/
@Deprecated
BatchGetLogResponse BatchGetLog(String project, String logStore,
int shardId, int count, String cursor, String end_cursor) throws LogException;
/**
* Batch get log
*
* @param request
* the batch get log request
*
* @return batch get log response
*
* @throws LogException
* if any error happen when get the data from log service server
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project or logstore or cursor in request is empty
* @deprecated Please use {@code pullLogs} instead.
*/
@Deprecated
BatchGetLogResponse BatchGetLog(BatchGetLogRequest request) throws LogException;
/**
* Pull logs from given shard id with cursor.
*
* @param request The pull logs request.
* @return The logs responded.
* @throws LogException
*/
PullLogsResponse pullLogs(PullLogsRequest request) throws LogException;
/**
* Create logtail config
*
* @param project
* the project name
* @param config
* the full config resource
*
* @return the create config response
*
* @throws LogException
* if any error happen when creating logtail config
* @throws NullPointerException
* if config resource parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateConfigResponse CreateConfig(String project, Config config) throws LogException;
/**
* Create logtail config
*
* @param request
* the create config request
*
* @return the create config response
*
* @throws LogException
* if any error happen when creating logtail config
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateConfigResponse CreateConfig(CreateConfigRequest request) throws LogException;
/**
* Update logtail config
*
* @param project
* the project name
* @param config
* the full config resource
*
* @return the update config response
*
* @throws LogException
* if any error happen when updating logtail config
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateConfigResponse UpdateConfig(String project, Config config) throws LogException;
/**
* Update logtail config
*
* @param request
* the update config request
*
* @return the update config response
*
* @throws LogException
* if any error happen when updating logtail config
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateConfigResponse UpdateConfig(UpdateConfigRequest request) throws LogException;
/**
* Get logtail config
*
* @param project
* the project name
* @param configName
* the config name
*
* @return the get config response
*
* @throws LogException
* if any error happen when getting logtail config
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if configName is empty
*
*/
GetConfigResponse GetConfig(String project, String configName) throws LogException;
/**
* Get logtail config
*
* @param request
* the get config request
*
* @return the get config response
*
* @throws LogException
* if any error happen when getting logtail config
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetConfigResponse GetConfig(GetConfigRequest request) throws LogException;
/**
* Delete logtail config
*
* @param project
* the project name
*
* @param configName
* the config name
*
* @return the delete config response
*
* @throws LogException
* if any error happen when deleting logtail config
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteConfigResponse DeleteConfig(String project, String configName) throws LogException;
/**
* Delete logtail config
*
* @param request
* the delete config request
*
* @return the delete config response
*
* @throws LogException
* if any error happen when deleting logtail config
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteConfigResponse DeleteConfig(DeleteConfigRequest request) throws LogException;
/**
* List logtail configs
*
* @param project
* the project name
* @return the list configs response
*
* @throws LogException
* if any error happen when listing logtail configs
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListConfigResponse ListConfig(String project) throws LogException;
/**
* List logtail configs
*
* @param project
* the project name
* @param offSet
* the list offset
* @param size
* the query size
*
* @return the list configs response
*
* @throws LogException
* if any error happen when listing logtail configs
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListConfigResponse ListConfig(String project, int offSet, int size) throws LogException;
/**
* List logtail configs
*
* @param project
* the project name
* @param configName
* the config name
* @param offSet
* the list offset
* @param size
* the query size
*
* @return the list configs response
*
* @throws LogException
* if any error happen when listing logtail configs
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListConfigResponse ListConfig(String project, String configName,
int offSet, int size) throws LogException;
/**
* List logtail configs
*
* @param request
* the list configs request
*
* @return the list configs response
*
* @throws LogException
* if any error happen when listing logtail configs
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListConfigResponse ListConfig(ListConfigRequest request) throws LogException;
/**
* get applied config on a certain machine group
*
* @param project
* the project name
*
* @param groupName
* the machine group name
*
* @return get applied config response
*
* @throws LogException
* if any error happen when get applied config configs
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetAppliedConfigResponse GetAppliedConfig(String project,
String groupName) throws LogException;
/**
* get applied config on a certain machine group
*
* @param request
* get applied config request
*
* @return get applied config response
*
* @throws LogException
* if any error happen when get applied config configs
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetAppliedConfigResponse GetAppliedConfig(GetAppliedConfigsRequest request) throws LogException;
/**
* get applied machine group for a certain logtail config
*
* @param project
* the project name
*
* @param configName
* the config name
*
* @return get applied machine group response
*
* @throws LogException
* if any error happen when get applied config configs
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetAppliedMachineGroupsResponse GetAppliedMachineGroups(
String project, String configName) throws LogException;
/**
* get applied machine group for a certain logtail config
*
* @param request
* get applied machine group request
*
* @return get applied machine group response
*
* @throws LogException
* if any error happen when get applied config configs
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetAppliedMachineGroupsResponse GetAppliedMachineGroups(
GetAppliedMachineGroupRequest request) throws LogException;
/**
* Create machine group
*
* @param project
* the project name
* @param group
* the full machine group resource
*
* @return the create machine group response
*
* @throws LogException
* if any error happen when creating machine group
* @throws NullPointerException
* if machine group resource parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateMachineGroupResponse CreateMachineGroup(String project,
MachineGroup group) throws LogException;
/**
* Create machine group
*
* @param request
* the create machine group request
*
* @return the create machine group response
*
* @throws LogException
* if any error happen when creating machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateMachineGroupResponse CreateMachineGroup(
CreateMachineGroupRequest request) throws LogException;
/**
* Update machine group
*
* @param project
* the project name
* @param group
* the full machine group resource
*
* @return the update machine group response
*
* @throws LogException
* if any error happen when updating machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateMachineGroupResponse UpdateMachineGroup(String project,
MachineGroup group) throws LogException;
/**
* Update machine group
*
* @param request
* the update machine group request
*
* @return the update machine group response
*
* @throws LogException
* if any error happen when updating machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateMachineGroupResponse UpdateMachineGroup(
UpdateMachineGroupRequest request) throws LogException;
/**
* add machine into machine group
*
* @param project
* the project name
* @param groupName
* the machine group name
* @param machineList
* machine id list
*
* @return add machine into machine group response
*
* @throws LogException
* if any error happen when adding machine into machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateMachineGroupMachineResponse AddMachineIntoMahineGroup(String project,
String groupName,
MachineList machineList) throws LogException;
/**
* add machine into machine group
*
* @param request
* update machine group resource
*
* @return add machine into machine group response
*
* @throws LogException
* if any error happen when adding machine into machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateMachineGroupMachineResponse AddMachineIntoMachineGroup(
UpdateMachineGroupMachineRequest request) throws LogException;
/**
* delete machine into machine group
*
* @param project
* the project name
* @param groupName
* the machine group name
* @param machineList
* machine id list
*
* @return delete machine from machine group response
*
* @throws LogException
* if any error happen when adding machine into machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateMachineGroupMachineResponse DeleteMachineFromMachineGroup(String project,
String groupName,
MachineList machineList) throws LogException;
/**
* delete machine into machine group
*
* @param request
* update machine group machine resource
*
* @return delete machine from machine group response
*
* @throws LogException
* if any error happen when adding machine into machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateMachineGroupMachineResponse DeleteMachineFromMachineGroup(
UpdateMachineGroupMachineRequest request) throws LogException;
/**
* Get machine group
*
* @param project
* the project name
* @param groupName
* the machine group name
*
* @return the get machine group response
*
* @throws LogException
* if any error happen when getting machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetMachineGroupResponse GetMachineGroup(String project,
String groupName) throws LogException;
/**
* Get machine group
*
* @param request
* the get machine group request
*
* @return the get machine group response
*
* @throws LogException
* if any error happen when getting machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetMachineGroupResponse GetMachineGroup(GetMachineGroupRequest request) throws LogException;
/**
* approve machine group
*
* @param project
* the project name
* @param groupName
* the machine group name
*
* @return approve machine group response
*
* @throws LogException
* if any error happen when deleting machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ApproveMachineGroupResponse ApproveMachineGroup(String project,
String groupName) throws LogException;
/**
* approve machine group
*
* @param request
* the approve machine group request
*
* @return the approve machine group response
*
* @throws LogException
* if any error happen when deleting machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ApproveMachineGroupResponse ApproveMachineGroup(
ApproveMachineGroupRequest request) throws LogException;
/**
* Delete machine group
*
* @param project
* the project name
* @param groupName
* the machine group name
*
* @return the delete machine group response
*
* @throws LogException
* if any error happen when deleting machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteMachineGroupResponse DeleteMachineGroup(String project,
String groupName) throws LogException;
/**
* Delete machine group
*
* @param request
* the delete machine group request
*
* @return the delete machine group response
*
* @throws LogException
* if any error happen when deleting machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteMachineGroupResponse DeleteMachineGroup(
DeleteMachineGroupRequest request) throws LogException;
/**
* List machine groups
*
* @param project
* the project name
* @return the list machine groups response
*
* @throws LogException
* if any error happen when listing machine groups
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListMachineGroupResponse ListMachineGroup(String project) throws LogException;
/**
* List the real machines in the machine group
*
* @param project
* the project name
* @param machineGroup
* the machine group name
*
* @param offset
* the offset in the machine group
* @param size
* the size to get
* @return the machines in the machine group
* @throws LogException
* if any error happen when listing machines
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListMachinesResponse ListMachines(String project,
String machineGroup, int offset, int size) throws LogException;
/**
* List machine groups
*
* @param project
* the project name
* @param offSet
* the list offset
* @param size
* the query size
*
* @return the list machine groups response
*
* @throws LogException
* if any error happen when listing machine groups
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListMachineGroupResponse ListMachineGroup(String project,
int offSet, int size) throws LogException;
/**
* List machine groups
*
* @param project
* the project name
* @param groupName
* the machine group name
* @param offSet
* the list offset
* @param size
* the query size
*
* @return the list machine groups response
*
* @throws LogException
* if any error happen when listing machine groups
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListMachineGroupResponse ListMachineGroup(String project,
String groupName, int offSet, int size) throws LogException;
/**
* List machine groups
*
* @param request
* the list machine groups request
*
* @return the list machine groups response
*
* @throws LogException
* if any error happen when listing machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListMachineGroupResponse ListMachineGroup(ListMachineGroupRequest request) throws LogException;
/**
* Apply config to machine group
*
* @param project
* the project name
* @param groupName
* the machine group name
* @param configName
* the logtail config name
*
* @return the apply config to machine group response
*
* @throws LogException
* if any error happen when applying config to machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ApplyConfigToMachineGroupResponse ApplyConfigToMachineGroup(
String project, String groupName, String configName)
throws LogException;
/**
* Apply config to machine group
*
* @param request
* apply config to machine group request
*
* @return the apply config to machine group response
*
* @throws LogException
* if any error happen when applying config to machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ApplyConfigToMachineGroupResponse ApplyConfigToMachineGroup(
ApplyConfigToMachineGroupRequest request) throws LogException;
/**
* Remove config from machine group
*
* @param project
* the project name
* @param groupName
* the machine group name
* @param configName
* the logtail config name
*
* @return the remove config from machine group response
*
* @throws LogException
* if any error happen when removing config from machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
RemoveConfigFromMachineGroupResponse RemoveConfigFromMachineGroup(
String project, String groupName, String configName)
throws LogException;
/**
* Remove config from machine group
*
* @param request
* remove config from machine group request
*
* @return the remove config from machine group response
*
* @throws LogException
* if any error happen when removing config from machine group
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
RemoveConfigFromMachineGroupResponse RemoveConfigFromMachineGroup(
RemoveConfigFromMachineGroupRequest request) throws LogException;
/**
* create a logstore in a project
*
* @param project
* the project name
* @param logStore
* the config
* @return the create log store response
* @throws LogException
* if any error happen when creasting logstore
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project is empty
*/
CreateLogStoreResponse CreateLogStore(String project,
LogStore logStore) throws LogException;
/**
* create logstore
*
* @param request
* logstore create request
* @return the create log store response
* @throws LogException
* if any error happen when creasting logstore
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateLogStoreResponse CreateLogStore(CreateLogStoreRequest request)
throws LogException;
/**
* create link store
*
* @param project the project name
* @param linkStore the config
* @return the create link store response
* @throws LogException if any error happen when creating link store
* @throws NullPointerException if any parameter is null
* @throws IllegalArgumentException if project is empty
*/
CreateLinkStoreResponse CreateLinkStore(String project,
LinkStore linkStore) throws LogException;
/**
* create link store
*
* @param request link store create request
* @return the create link store response
* @throws LogException if any error happen when creating link store
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
CreateLinkStoreResponse CreateLinkStore(CreateLinkStoreRequest request)
throws LogException;
/**
* Update log store config
*
* @param project
* the project name
* @param logStore
* the logsotre config
* @return update logstore response
* @throws LogException
* if any error happen when updating logstore
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project is empty
*/
UpdateLogStoreResponse UpdateLogStore(String project,
LogStore logStore) throws LogException;
/**
* Update logstore config
*
* @param request
* update logstore requst
* @return Update logstore response
*
* @throws LogException
* if any error happen when updating logstore
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateLogStoreResponse UpdateLogStore(UpdateLogStoreRequest request)
throws LogException;
/**
* Delete the logstore
*
* @param project
* the project name
* @param logStoreName
* the lostore to delete
* @return delete logstore response
* @throws LogException
* if any error happen when deleting logstore
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if an param is empty
*/
DeleteLogStoreResponse DeleteLogStore(String project,
String logStoreName) throws LogException;
/**
* Delete logstore
*
* @param request
* delete logstore request
* @return the delete logstore response
* @throws LogException
* if any error happen when deleting logstore
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteLogStoreResponse DeleteLogStore(DeleteLogStoreRequest request)
throws LogException;
/**
* Delete link store
*
* @param project the project name
* @param linkStoreName the link store to delete
* @return delete link store response
* @throws LogException if any error happen when deleting link store
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
DeleteLinkStoreResponse DeleteLinkStore(String project,
String linkStoreName) throws LogException;
/**
* Delete link store
*
* @param request delete link store request
* @return delete link store response
* @throws LogException if any error happen when deleting link store
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
DeleteLinkStoreResponse DeleteLinkStore(DeleteLinkStoreRequest request) throws LogException;
/**
* Get the logstore config
*
* @param project
* the project name
* @param logStoreName
* the logstore name
* @return the get logstore response
* @throws LogException
* if any error happen when getting logstore config
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any parameter is empty
*/
GetLogStoreResponse GetLogStore(String project, String logStoreName)
throws LogException;
/**
* get the logstore config
*
* @param request
* the get logstore config request
* @return the get logstore response
* @throws LogException
* if any error happen when getting logstore config
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetLogStoreResponse GetLogStore(GetLogStoreRequest request) throws LogException;
/**
* create a metric store in a project
*
* @param project
* the project name
* @param metricStore
* the config
* @return the create log store response
* @throws LogException
* if any error happen when creasting logstore
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project is empty
*/
CreateLogStoreResponse createMetricStore(String project,
LogStore metricStore) throws LogException;
/**
* create a metric store in a project
*
* @param request
* logstore create request
* @return the create log store response
* @throws LogException
* if any error happen when creasting logstore
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateLogStoreResponse createMetricStore(CreateLogStoreRequest request)
throws LogException;
/**
* Update metric store config
*
* @param project
* the project name
* @param metricStore
* the logsotre config
* @return update logstore response
* @throws LogException
* if any error happen when updating logstore
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if project is empty
*/
UpdateLogStoreResponse updateMetricStore(String project,
LogStore metricStore) throws LogException;
/**
* Update metric store config
*
* @param request
* update logstore requst
* @return Update logstore response
*
* @throws LogException
* if any error happen when updating logstore
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateLogStoreResponse updateMetricStore(UpdateLogStoreRequest request)
throws LogException;
/**
* Delete the metric store
*
* @param project
* the project name
* @param metricStoreName
* the lostore to delete
* @return delete logstore response
* @throws LogException
* if any error happen when deleting logstore
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if an param is empty
*/
DeleteLogStoreResponse deleteMetricStore(String project,
String metricStoreName) throws LogException;
/**
* Delete the metric store
*
* @param request
* delete logstore request
* @return the delete logstore response
* @throws LogException
* if any error happen when deleting logstore
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteLogStoreResponse deleteMetricStore(DeleteLogStoreRequest request)
throws LogException;
/**
* get the metric store config
*
* @param project
* the project name
* @param metricStoreName
* the logstore name
* @return the get logstore response
* @throws LogException
* if any error happen when getting logstore config
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any parameter is empty
*/
GetLogStoreResponse getMetricStore(String project, String metricStoreName)
throws LogException;
/**
* get the metric store config
*
* @param request
* the get logstore config request
* @return the get logstore response
* @throws LogException
* if any error happen when getting logstore config
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetLogStoreResponse getMetricStore(GetLogStoreRequest request) throws LogException;
/**
* create logstore index
*
* @param project
* the project name
* @param logStore
* the logstore name
* @param indexJsonString
* logstore indexJsonString
* @return create index response
* @throws LogException
* if any error happen when creating index
*
* @throws NullPointerException
* if the request is null
*
* @throws IllegalArgumentException
* if any string paramter is empty
*/
CreateIndexResponse CreateIndex(String project, String logStore,
String indexJsonString) throws LogException;
/**
* create logstore index
*
* @param project
* the project name
* @param logStore
* the logstore name
* @param index
* logstore index config
* @return create index response
* @throws LogException
* if any error happen when creating index
*
* @throws NullPointerException
* if the request is null
*
* @throws IllegalArgumentException
* if any string paramter is empty
*/
CreateIndexResponse CreateIndex(String project, String logStore,
Index index) throws LogException;
/**
* create logstore index
*
* @param request
* the create logstore index request
* @return create index response
* @throws LogException
* if any error happen when creating index
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateIndexResponse CreateIndex(CreateIndexRequest request) throws LogException;
/**
* Update logstore index config
*
* @param project
* project name
* @param logStore
* logstore name
* @param indexJsonString
* logstore indexJsonString
* @return update logstore index response
* @throws LogException
* if any error happen when updating logstore index config
*
* @throws NullPointerException
* if any parameter is null
*
* @throws IllegalArgumentException
* if any string parameter is empty
*/
UpdateIndexResponse UpdateIndex(String project, String logStore,
String indexJsonString) throws LogException;
/**
* Update logstore index config
*
* @param project
* project name
* @param logStore
* logstore name
* @param index
* logstore index config
* @return update logstore index response
* @throws LogException
* if any error happen when updating logstore index config
*
* @throws NullPointerException
* if any parameter is null
*
* @throws IllegalArgumentException
* if any string parameter is empty
*/
UpdateIndexResponse UpdateIndex(String project, String logStore,
Index index) throws LogException;
/**
* update logstore index config
*
* @param request
* update logstore index request
* @return update logstore index response
* @throws LogException
* if any error happen when update logstore index config
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateIndexResponse UpdateIndex(UpdateIndexRequest request) throws LogException;
/**
* delete logstore index
*
* @param project
* project name
* @param logStore
* store name
* @return delete logstore index response
* @throws LogException
* if any error happen when deleting logstore index config
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any string parameter is empty
*/
DeleteIndexResponse DeleteIndex(String project, String logStore) throws LogException;
/**
* delete logstore index
*
* @param request
* delete logstore index config
* @return deleing index response
* @throws LogException
* if any error happen when deleting logstore index config
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteIndexResponse DeleteIndex(DeleteIndexRequest request) throws LogException;
/**
* Get logstore index config
*
* @param project
* project name
* @param logStore
* logstore name
* @return get index config response
* @throws LogException
* if any error happen when get index config
*
* @throws NullPointerException
* if any parameter is null
* @throws IllegalArgumentException
* if any string parameter is empty
*/
GetIndexResponse GetIndex(String project, String logStore) throws LogException;
GetIndexStringResponse GetIndexString(String project, String logStore)
throws LogException;
/**
* Get logstore index config
*
*
* @param request
* get logstore index request
* @return get index config response
* @throws LogException
* if any error happen when getting index config
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetIndexResponse GetIndex(GetIndexRequest request) throws LogException;
GetIndexStringResponse GetIndexString(GetIndexRequest request)
throws LogException;
/**
* create logstore consumer group
*
*
* @param request
* contains all of the parameters needed
* @return create logstore consumer group response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateConsumerGroupResponse CreateConsumerGroup(
CreateConsumerGroupRequest request) throws LogException;
/**
* create logstore consumer group
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* contains all of the parameters needed by consumer group
* @return create logstore consumer group response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateConsumerGroupResponse CreateConsumerGroup(String project,
String logStore, ConsumerGroup consumerGroup) throws LogException;
/**
* delete logstore consumer group
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @return delete logstore consumer group response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteConsumerGroupResponse DeleteConsumerGroup(String project,
String logStore, String consumerGroup) throws LogException;
/**
* list logstore consumer groups
*
*
* @param project
* project name
* @param logStore
* logstore name
* @return list logstore consumer groups response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListConsumerGroupResponse ListConsumerGroup(String project,
String logStore) throws LogException;
/**
* update consumer group
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @param inOrder
* consume data in oder or not
* @param timeoutInSec
* if the time interval of a consumer's heartbeat exceed this
* value in second, the consumer will be deleted.
* @return update consumer group response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
String logStore, String consumerGroup, boolean inOrder,
int timeoutInSec) throws LogException;
/**
* update consumer group
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @param inOrder
* consume data in oder or not
* @return update consumer group response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateConsumerGroupResponse UpdateConsumerGroup(String project, String logStore, String consumerGroup,
boolean inOrder) throws LogException;
/**
* update consumer group
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @param timeoutInSec
* if the time interval of a consumer's heartbeat exceed this
* value in second, the consumer will be deleted.
* @return update consumer group response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
String logStore, String consumerGroup, int timeoutInSec)
throws LogException;
/**
* update consume checkpoint
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @param consumer
* consumer name
* @param shard
* shard id
* @param checkpoint
* shard cursor
* @return update consume checkpoint response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ConsumerGroupUpdateCheckPointResponse UpdateCheckPoint(
String project, String logStore, String consumerGroup,
String consumer, int shard, String checkpoint) throws LogException;
/**
* update consume checkpoint
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @param shard
* shard id
* @param checkpoint
* shard cursor
* @return update consume checkpoint response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ConsumerGroupUpdateCheckPointResponse UpdateCheckPoint(
String project, String logStore, String consumerGroup, int shard,
String checkpoint) throws LogException;
/**
* notify the server periodically to show that the consumer is still alive.
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @param consumer
* consumer name
* @param shards
* shards hold by the consumer
* @return heartbeat response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ConsumerGroupHeartBeatResponse HeartBeat(String project,
String logStore, String consumerGroup, String consumer,
List shards) throws LogException;
/**
* get shard checkpoint in the consumer group
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @param shard
* shard id
* @return get shard checkpoint response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ConsumerGroupCheckPointResponse GetCheckPoint(String project,
String logStore, String consumerGroup, int shard)
throws LogException;
GetCheckPointResponse getCheckpoint(String project,
String logstore,
String consumerGroup,
int shard) throws LogException;
/**
* get all of the shard checkpoints in the consumer group
*
*
* @param project
* project name
* @param logStore
* logstore name
* @param consumerGroup
* consumer group name
* @return get shard checkpoint response
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ConsumerGroupCheckPointResponse GetCheckPoint(String project,
String logStore, String consumerGroup) throws LogException;
/**
* create a shipper
*
* @param project
* project name
* @param logStore
* logstore name
* @param shipperName
* shipper name
* @param shipConfig
* the OssShipperConfig
* @return CreateShipperResponse
* @throws LogException
* if any error happened
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateShipperResponse CreateShipper(String project, String logStore,
String shipperName, ShipperConfig shipConfig) throws LogException;
/**
* update a shipper
*
* @param project
* project name
* @param logStore
* logstore name
* @param shipperName
* shipper name
* @param shipConfig
* the OssShipperConfig or OdpsShipperConfig
* @return UpdateShipperResponse
*
* @throws LogException
* if any error happened
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateShipperResponse UpdateShipper(String project, String logStore,
String shipperName, ShipperConfig shipConfig) throws LogException;
/**
* Delete a shipper
*
* @param project
* project name
* @param logStore
* logstore name
* @param ShipperName
* shipper name
* @return DeleteShipperResponse
*
* @throws LogException
* if any error happened
*
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteShipperResponse DeleteShipper(String project, String logStore,
String ShipperName) throws LogException;
/**
* Get a shipper config
*
* @param project
* project name
* @param logStore
* logstore name
* @param shipperName
* shipper name
* @return GetShipperResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetShipperResponse GetShipperConfig(String project, String logStore,
String shipperName) throws LogException;
/**
* List shipper of a logstore
*
* @param project
* project name
* @param logStore
* logstore name
* @return ListShipperResponse if any error happened
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListShipperResponse ListShipper(String project, String logStore)
throws LogException;
/**
* Get the tasks of a logstore shipper
*
* @param project
* project name
* @param logStore
* logstore name
* @param shipperName
* shipper name
* @param startTime
* the start time in timestamp (from 1970.1.1)
* @param endTime
* the end time
* @param statusType
* one of ['', 'success', 'running', 'fail'], if statusType is
* '', return all tasks
* @param offset
* the offset
* @param size
* the task count
* @return GetShipperTasksResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetShipperTasksResponse GetShipperTasks(String project,
String logStore, String shipperName, int startTime, int endTime,
String statusType, int offset, int size) throws LogException;
/**
* retry the failed tasks, for every time it can only retry 10 task
*
* @param project
* project name
* @param logStore
* logstore name
* @param shipperName
* shipper name
* @param taskList
* failed task id list
* @return RetryShipperTasksResponse
*
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
RetryShipperTasksResponse RetryShipperTasks(String project,
String logStore, String shipperName, List taskList)
throws LogException;
/**
* create a project
*
* @param project
* project name
* @param projectDescription
* project description
* @return CreateProjectResponse
*
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateProjectResponse CreateProject(String project,
String projectDescription) throws LogException;
CreateProjectResponse createProject(String project, String projectDescription, String resourceGroupId) throws LogException;
CreateProjectResponse createProject(CreateProjectRequest request) throws LogException;
/**
* get a project
*
* @param project
* project name
* @return GetProjectResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetProjectResponse GetProject(String project) throws LogException;
/**
* list project
*
* @param ProjectName
* project name
* @param offset
* offset
* @param size
* size
* @return ListProjectResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListProjectResponse ListProject(String ProjectName, int offset, int size) throws LogException;
/**
* list all project
*
* @param request
* request class
* @return ListProjectResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListProjectResponse ListProject(ListProjectRequest request) throws LogException;
/**
* delete a project
*
* @param project
* project name
* @return DeleteProjectResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteProjectResponse DeleteProject(String project) throws LogException;
/**
* Updates project.
*
* @param request The parameters used to update project.
* @return A instance of {@link UpdateProjectResponse}
*/
UpdateProjectResponse updateProject(UpdateProjectRequest request) throws LogException;
ChangeResourceGroupResponse changeResourceGroup(String resourceType, String resourceId, String resourceGroupId) throws LogException;
/**
* list project
*
* @return ListProjectResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListProjectResponse ListProject() throws LogException;
/**
* create saved search
*
* @param request
* request class
* @return createSavedSearchResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateSavedSearchResponse createSavedSearch(CreateSavedSearchRequest request) throws LogException;
/**
* update saved search
*
* @param request
* request class
* @return updateSavedSearchResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateSavedSearchResponse updateSavedSearch(UpdateSavedSearchRequest request) throws LogException;
/**
* delete saved search
*
* @param request
* request class
* @return deleteSavedSearchResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteSavedSearchResponse deleteSavedSearch(DeleteSavedSearchRequest request) throws LogException;
/**
* get saved search
*
* @param request
* request class
* @return GetSavedSearchResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetSavedSearchResponse getSavedSearch(GetSavedSearchRequest request) throws LogException;
/**
* list saved search
*
* @param request
* request class
* @return ListSavedSearchResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListSavedSearchResponse listSavedSearch(ListSavedSearchRequest request) throws LogException;
/**
* Create an alert rule.
* @param request An instance of {@link CreateAlertRequest}
* @return CreateAlertResponse
* @throws LogException
*/
CreateAlertResponse createAlert(CreateAlertRequest request) throws LogException;
CreateETLV2Response createETLV2(CreateETLV2Request request) throws LogException;
UpdateETLV2Response updateETLV2(UpdateETLV2Request request) throws LogException;
DeleteETLV2Response deleteETLV2(DeleteETLV2Request request) throws LogException;
GetETLV2Response getETLV2(GetETLV2Request request) throws LogException;
ListETLV2Response listETLV2(ListETLV2Request request) throws LogException;
StopETLV2Response stopETLV2(StopETLV2Request request) throws LogException;
StartETLV2Response startETLV2(StartETLV2Request request) throws LogException;
ReStartETLV2Response reStartETLV2(ReStartETLV2Request request) throws LogException;
CreateExportResponse createExport(CreateExportRequest request) throws LogException;
UpdateExportResponse updateExport(UpdateExportRequest request) throws LogException;
DeleteExportResponse deleteExport(DeleteExportRequest request) throws LogException;
GetExportResponse getExport(GetExportRequest request) throws LogException;
ListExportResponse listExport(ListExportRequest request) throws LogException;
StopExportResponse stopExport(StopExportRequest request) throws LogException;
StartExportResponse startExport(StartExportRequest request) throws LogException;
RestartExportResponse restartExport(RestartExportRequest request) throws LogException;
CreateScheduledSQLResponse createScheduledSQL(CreateScheduledSQLRequest request) throws LogException;
DeleteScheduledSQLResponse deleteScheduledSQL(DeleteScheduledSQLRequest request) throws LogException;
GetScheduledSQLResponse getScheduledSQL(GetScheduledSQLRequest request) throws LogException;
ListScheduledSQLResponse listScheduledSQL(ListScheduledSQLRequest request) throws LogException;
UpdateScheduledSQLResponse updateScheduledSQL(UpdateScheduledSQLRequest request) throws LogException;
GetJobInstanceResponse getJobInstance(GetJobInstanceRequest request) throws LogException;
ModifyJobInstanceStateResponse modifyJobInstanceState(ModifyJobInstanceStateRequest request) throws LogException;
ListJobInstancesResponse listJobInstances(ListJobInstancesRequest request) throws LogException;
/**
* update alert
*
* @param request
* request class
* @return UpdateAlertResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateAlertResponse updateAlert(UpdateAlertRequest request) throws LogException;
/**
* delete alert
*
* @param request
* request class
* @return DeleteAlertResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteAlertResponse deleteAlert(DeleteAlertRequest request) throws LogException;
/**
* get alert
*
* @param request
* request class
* @return GetAlertResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
GetAlertResponse getAlert(GetAlertRequest request) throws LogException;
/**
* list alert
*
* @param request
* request class
* @return GetAlertResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListAlertResponse listAlert(ListAlertRequest request) throws LogException;
CreateReportResponse createReport(CreateReportRequest request) throws LogException;
GetReportResponse getReport(GetReportRequest request) throws LogException;
UpdateReportResponse updateReport(UpdateReportRequest request) throws LogException;
DeleteReportResponse deleteReport(DeleteReportRequest request) throws LogException;
ListReportResponse listReport(ListReportRequest request) throws LogException;
EnableReportResponse enableReport(EnableReportRequest request) throws LogException;
DisableReportResponse disableReport(DisableReportRequest request) throws LogException;
SetLogstoreReplicationResponse setLogstoreReplication(String project, String logStore, boolean enable)
throws LogException;
SetLogstoreReplicationResponse setLogstoreReplication(SetLogstoreReplicationRequest request)
throws LogException;
GetLogstoreReplicationResponse getLogstoreReplication(String project, String logStore)
throws LogException;
GetLogstoreReplicationResponse getLogstoreReplication(GetLogstoreReplicationRequest request)
throws LogException;
CreateDashboardResponse createDashboard(CreateDashboardRequest request) throws LogException;
UpdateDashboardResponse updateDashboard(UpdateDashboardRequest request) throws LogException;
DeleteDashboardResponse deleteDashboard(DeleteDashboardRequest request) throws LogException;
GetDashboardResponse getDashboard(GetDashboardRequest request) throws LogException;
ListDashboardResponse listDashboard(ListDashboardRequest request) throws LogException;
CreateChartResponse createChart(CreateChartRequest request) throws LogException;
UpdateChartResponse updateChart(UpdateChartRequest request) throws LogException;
DeleteChartResponse deleteChart(DeleteChartRequest request) throws LogException;
GetChartResponse getChart(GetChartRequest request) throws LogException;
/**
* @param request
* CreateEtlJobRequest
* @return
* CreateEtlJobResponse
* @throws LogException
*/
CreateEtlJobResponse createEtlJob(CreateEtlJobRequest request) throws LogException;
/**
* @param request
* DeleteEtlJobRequest
* @return
* DeleteEtlJobResponse
* @throws LogException
*/
DeleteEtlJobResponse deleteEtlJob(DeleteEtlJobRequest request) throws LogException;
/**
* @param request
* UpdateEtlJobRequest
* @return
* UpdateEtlJobResponse
* @throws LogException
*/
UpdateEtlJobResponse updateEtlJob(UpdateEtlJobRequest request) throws LogException;
/**
* @param request
* GetEtlJobRequest
* @return
* GetEtlJobResponse
* @throws LogException
*/
GetEtlJobResponse getEtlJob(GetEtlJobRequest request) throws LogException;
/**
* @param request
* ListEtlJobRequest
* @return
* ListEtlJobResponse
* @throws LogException
*/
ListEtlJobResponse listEtlJob(ListEtlJobRequest request) throws LogException;
/**
* @param project
* project name
* @param etlMeta
* etlMeta which contains the metaName/metaKey/metaTag/metaValue
* @return
* CreateEtlMetaResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateEtlMetaResponse createEtlMeta(String project, EtlMeta etlMeta) throws LogException;
/**
* @param project
* project name
* @param etlMetaList
* List of etlMeta which contains the metaName/metaKey/metaTag/metaValue, List size shoud be [1, 50]
* @return
* CreateEtlMetaResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
CreateEtlMetaResponse batchCreateEtlMeta(String project, ArrayList etlMetaList) throws LogException;
/**
* delete etlMeta with etlMetaName + etlMetaKey
*
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param etlMetaKey
* etl meta key
* @return
* DeleteEtlMetaResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteEtlMetaResponse deleteEtlMeta(String project, String etlMetaName, String etlMetaKey) throws LogException;
/**
* delete etlMeta with etlMetaName + etlMetaKey, and delete operation need double checked with etlMetaTag value
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param etlMetaKey
* etl meta key
* @param etlMetaTag
* etl meta tag
* @return
* DeleteEtlMetaResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
DeleteEtlMetaResponse deleteEtlMeta(String project, String etlMetaName, String etlMetaKey, String etlMetaTag) throws LogException;
/**
* modify all etlMeta status with specified etlMetaTag, and value of etlMetaTag must not be reserved string `__all_etl_meta_tag_match__`
*
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param etlMetaTag
* etl meta tag
* @param type
* delete/enable/disable
* @return
* BatchModifyEtlMetaStatusResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
BatchModifyEtlMetaStatusResponse batchModifyEtlMetaStatus(String project, String etlMetaName, String etlMetaTag, Consts.BatchModifyEtlMetaType type) throws LogException;
/**
* modify all etlMeta status with specified etlMetaKey(List), and etlMetaTag will not be checked, List size should be [1, 200]
*
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param etlMetaKeyList
* List of etl meta key
* @param type
* delete/enable/disable
* @return
* BatchModifyEtlMetaStatusResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
BatchModifyEtlMetaStatusResponse batchModifyEtlMetaStatus(String project, String etlMetaName, ArrayList etlMetaKeyList, Consts.BatchModifyEtlMetaType type) throws LogException;
/**
* modify all etlMeta status with specified etlMetaKey(List), modify operation double checked with etlMetaTag, List size should be [1, 200]
*
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param etlMetaKeyList
* List of etl meta key
* @param etlMetaTag
* etl meta tag
* @param type
* delete/enable/disable
* @return
* BatchModifyEtlMetaStatusResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
BatchModifyEtlMetaStatusResponse batchModifyEtlMetaStatus(String project, String etlMetaName, ArrayList etlMetaKeyList, String etlMetaTag, Consts.BatchModifyEtlMetaType type) throws LogException;
/**
* @param project
* project name
* @param etlMeta
* etlMeta which contains the metaName/metaKey/metaTag/metaValue
* @return
* UpdateEtlMetaResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateEtlMetaResponse updateEtlMeta(String project, EtlMeta etlMeta) throws LogException;
/**
* @param project
* project name
* @param etlMetaList
* List of etlMeta which contains the metaName/metaKey/metaTag/metaValue, List size should be [1, 50]
* @return
* UpdateEtlMetaResponse
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
UpdateEtlMetaResponse batchUpdateEtlMeta(String project, ArrayList etlMetaList) throws LogException;
/**
* @param project
* project name
* @param offset
* should greater than 0
* @param size
* [1, 200]
* @return
* every request will return the subset [offset, offset + size) of complete etl meta name list
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListEtlMetaNameResponse listEtlMetaName(String project, int offset, int size) throws LogException;
/**
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param offset
* should greater than 0
* @param size
* [1, 200]
* @return
* every request will return the subset [offset, offset + size) of complete etl meta list
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListEtlMetaResponse listEtlMeta(String project, String etlMetaName, int offset, int size) throws LogException;
/**
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param etlMetaTag
* etl meta tag, useful to filter lots of meta keys
* @param offset
* should greater than 0
* @param size
* [1, 200]
* @return
* every request will return the subset [offset, offset + size) of complete etl meta list
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListEtlMetaResponse listEtlMeta(String project, String etlMetaName, String etlMetaTag, int offset, int size) throws LogException;
/**
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param dispatchProject
* project name in meta value, only used by sls.console.aliyun.com
* @param dispatchLogstore
* logstore name in meta value, only used by sls.console.aliyun.com
* @param offset
* should greater than 0
* @param size
* [1, 200]
* @return
* every request will return the subset [offset, offset + size) of complete etl meta list
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListEtlMetaResponse listEtlMeta(String project, String etlMetaName, String dispatchProject, String dispatchLogstore, int offset, int size) throws LogException;
/**
* @param project
* project name
* @param etlMetaName
* etl meta name
* @param etlMetaKey
* etl meta key
* @return
* every request will return the only one EtlMeta
* use ListEtlMetaResponse.GetHeadEtlMeta to get the value, null if no etl meta matched
* @throws LogException
* if any error happened
* @throws NullPointerException
* if required parameter is null
* @throws IllegalArgumentException
* if any required string parameter is empty
*/
ListEtlMetaResponse getEtlMeta(String project, String etlMetaName, String etlMetaKey) throws LogException;
/**
* Create logging for project.
*
* @param request An instance of {@link CreateLoggingRequest}
* @return An instance of {@link CreateLoggingResponse}
* @throws LogException if any error occurs
*/
CreateLoggingResponse createLogging(CreateLoggingRequest request) throws LogException;
/**
* Update an existing logging for project.
*
* @param request An instance of {@link UpdateLoggingRequest}
* @return An instance of {@link UpdateLoggingResponse}
* @throws LogException if any error occurs
*/
UpdateLoggingResponse updateLogging(UpdateLoggingRequest request) throws LogException;
/**
* Get an existing logging for project.
*
* @param request An instance of {@link GetLoggingRequest}
* @return An instance of {@link GetLoggingResponse}
* @throws LogException if any error occurs
*/
GetLoggingResponse getLogging(GetLoggingRequest request) throws LogException;
/**
* Delete an existing logging for project.
*
* @param request An instance of {@link DeleteLoggingRequest}
* @return An instance of {@link DeleteLoggingResponse}
* @throws LogException if any error occurs
*/
DeleteLoggingResponse deleteLogging(DeleteLoggingRequest request) throws LogException;
/**
* Create a job.
*
* @param request An instance of {@link CreateJobRequest}
* @return An instance of {@link CreateJobResponse} if success
* @throws LogException if any error occurs
*/
@Deprecated
CreateJobResponse createJob(CreateJobRequest request) throws LogException;
/**
* Get a job.
*
* @param request An instance of {@link GetJobRequest}
* @return An instance of {@link GetJobResponse}
* @throws LogException if any error occurs
*/
@Deprecated
GetJobResponse getJob(GetJobRequest request) throws LogException;
/**
* Updates a existing job.
*
* @param request An instance of {@link UpdateJobRequest}
* @return An instance of {@link UpdateJobResponse}
* @throws LogException if any error occurs
*/
@Deprecated
UpdateJobResponse updateJob(UpdateJobRequest request) throws LogException;
/**
* Delete a job.
*
* @param request An instance of {@link DeleteJobRequest}
* @return An instance of {@link DeleteJobResponse}
* @throws LogException if any error occurs
*/
@Deprecated
DeleteJobResponse deleteJob(DeleteJobRequest request) throws LogException;
/**
* Enable a job.
*
* @param request An instance of {@link EnableJobRequest}
* @return An instance of {@link EnableJobResponse}
* @throws LogException if any error occurs
*/
@Deprecated
EnableJobResponse enableJob(EnableJobRequest request) throws LogException;
/**
* Enables alert.
*
* @param request
* @return The response of enable alert.
* @throws LogException
*/
EnableAlertResponse enableAlert(EnableAlertRequest request) throws LogException;
/**
* Disable a job.
*
* @param request An instance of {@link DisableJobRequest}
* @return An instance of {@link DisableJobResponse}
* @throws LogException if any error occurs
*/
@Deprecated
DisableJobResponse disableJob(DisableJobRequest request) throws LogException;
DisableAlertResponse disableAlert(DisableAlertRequest request) throws LogException;
/**
* Get job list in project.
*
* @param request An instance of {@link ListJobsRequest}
* @return An instance of {@link ListJobsResponse}
* @throws LogException if any error occurs
*/
@Deprecated
ListJobsResponse listJobs(ListJobsRequest request) throws LogException;
/**
* clear an existing logstore storage.
*
* @param request An instance of {@link ClearLogStoreStorageRequest}
* @return An instance of {@link ClearLogStoreStorageResponse}
* @throws LogException if any error occurs
*/
ClearLogStoreStorageResponse ClearLogStoreStorage(ClearLogStoreStorageRequest request) throws LogException;
/**
* clear an existing logstore storage.
*
* @param project name
* @param logStoreName name
* @return An instance of {@link ClearLogStoreStorageResponse}
* @throws LogException if any error occurs
*/
ClearLogStoreStorageResponse ClearLogStoreStorage(String project, String logStoreName) throws LogException;
/**
* create project consumer group
*
* @param request contains all of parameters needed
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
CreateProjectConsumerGroupResponse CreateProjectConsumerGroup(
CreateProjectConsumerGroupRequest request) throws LogException;
/**
* create project consumer group
*
* @param project project name
* @param consumerGroup contains all of parameters needed by consumer group
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
CreateProjectConsumerGroupResponse CreateProjectConsumerGroup(
String project, ProjectConsumerGroup consumerGroup) throws LogException;
/**
* delete project consumer group
*
* @param project project name
* @param consumerGroup consumer group name
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
DeleteProjectConsumerGroupResponse DeleteProjectConsumerGroup(
String project, String consumerGroup) throws LogException;
/**
* list project consumer group
*
* @param project project name
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
ListProjectConsumerGroupResponse ListProjectConsumerGroup(
String project) throws LogException;
/**
* update project consumer group
*
* @param project project name
* @param consumerGroup consumer group name
* @param inOrder consume data in order or not
* @param timeoutInSec if the time interval of a consumer's heartbeat exceed this
* value in second, the consumer will be deleted
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
UpdateProjectConsumerGroupResponse UpdateProjectConsumerGroup(
String project, String consumerGroup, boolean inOrder, int timeoutInSec) throws LogException;
/**
* update consume checkpoint in project consumer group
*
* @param project project name
* @param consumerGroup project consumer group name
* @param consumer consumer name
* @param logStore log store name
* @param shard shard id
* @param checkpoint shard cursor
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
ProjectConsumerGroupUpdateCheckPointResponse UpdateProjectConsumerGroupCheckPoint(
String project, String consumerGroup, String consumer, String logStore, int shard, String checkpoint) throws LogException;
/**
* update checkpoint in project consumer group
*
* @param project project name
* @param consumerGroup project consumer group name
* @param logStore log store name
* @param shard shard id
* @param checkpoint shard cursor
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
ProjectConsumerGroupUpdateCheckPointResponse UpdateProjectConsumerGroupCheckPoint(
String project, String consumerGroup, String logStore, int shard, String checkpoint) throws LogException;
/**
* get shard checkpoint in project consumer group
*
* @param project project name
* @param consumerGroup consumer group name
* @param logStore log store or link store name
* @param shard shard id
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
ProjectConsumerGroupCheckPointResponse GetProjectConsumerGroupCheckPoint(
String project, String consumerGroup, String logStore, int shard) throws LogException;
/**
* get all of shard checkpoints in specific log store in project consumer group
*
* @param project project name
* @param consumerGroup consumer group name
* @param logStore log store or link store name
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
ProjectConsumerGroupCheckPointResponse GetProjectConsumerGroupCheckPoint(
String project, String consumerGroup, String logStore) throws LogException;
/**
* get all of shard checkpoints in project consumer group
*
* @param project project name
* @param consumerGroup consumer group name
* @return response
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
ProjectConsumerGroupCheckPointResponse GetProjectConsumerGroupCheckPoint(
String project, String consumerGroup) throws LogException;
/**
* notify the server periodically to show that the consumer is still alive
*
* @param project project name
* @param consumerGroup consumer group name
* @param consumer consumer name
* @param logStoreShards log store and shards hold by the consumer
* @return response that indicates which log store and shards the consumer should hold
* @throws LogException if any error happened
* @throws NullPointerException if required parameter is null
* @throws IllegalArgumentException if any required string parameter is empty
*/
ProjectConsumerGroupHeartBeatResponse ProjectConsumerGroupHeartBeat(
String project, String consumerGroup, String consumer, Map> logStoreShards) throws LogException;
/**
* @param project name
* @param logstore name
* @return An instance of {@link ListSubStoreResponse}
* @throws LogException if any error occurs
*/
ListSubStoreResponse listSubStore(String project, String logstore) throws LogException;
/**
* @param request An instance of {@link ListSubStoreRequest}
* @return An instance of {@link ListSubStoreResponse}
* @throws LogException if any error occurs
*/
ListSubStoreResponse listSubStore(ListSubStoreRequest request) throws LogException;
/**
* @param project name
* @param logstore name
* @param name substore name
* @return An instance of {@link GetSubStoreResponse}
* @throws LogException if any error occurs
*/
GetSubStoreResponse getSubStore(String project, String logstore, String name) throws LogException;
/**
* @param request An instance of {@link GetSubStoreRequest}
* @return An instance of {@link GetSubStoreResponse}
* @throws LogException if any error occurs
*/
GetSubStoreResponse getSubStore(GetSubStoreRequest request) throws LogException;
/**
* @param project name
* @param logstore name
* @param subStore An instance of {@link SubStore}
* @return An instance of {@link CreateSubStoreResponse}
* @throws LogException if any error occurs
*/
CreateSubStoreResponse createSubStore(String project, String logstore, SubStore subStore) throws LogException;
/**
* @param request An instance of {@link CreateSubStoreRequest}
* @return An instance of {@link CreateSubStoreResponse}
* @throws LogException if any error occurs
*/
CreateSubStoreResponse createSubStore(CreateSubStoreRequest request) throws LogException;
/**
* @param project name
* @param logstore name
* @param subStore An instance of {@link SubStore}
* @return An instance of {@link UpdateSubStoreResponse}
* @throws LogException if any error occurs
*/
UpdateSubStoreResponse updateSubStore(String project, String logstore, SubStore subStore) throws LogException;
/**
* @param request An instance of {@link UpdateSubStoreRequest}
* @return An instance of {@link UpdateSubStoreResponse}
* @throws LogException if any error occurs
*/
UpdateSubStoreResponse updateSubStore(UpdateSubStoreRequest request) throws LogException;
/**
* @param project name
* @param logstore name
* @param subStoreName subStore name
* @return An instance of {@link DeleteSubStoreResponse}
* @throws LogException if any error occurs
*/
DeleteSubStoreResponse deleteSubStore(String project, String logstore, String subStoreName) throws LogException;
/**
* @param request An instance of {@link DeleteSubStoreRequest}
* @return An instance of {@link DeleteSubStoreResponse}
* @throws LogException if any error occurs
*/
DeleteSubStoreResponse deleteSubStore(DeleteSubStoreRequest request) throws LogException;
/**
* @param project name
* @param logstore name
* @return An instance of {@link GetSubStoreTTLResponse}
* @throws LogException if any error occurs
*/
GetSubStoreTTLResponse getSubStoreTTL(String project, String logstore) throws LogException;
/**
* @param request An instance of {@link GetSubStoreTTLResquest}
* @return An instance of {@link GetSubStoreTTLResponse}
* @throws LogException if any error occurs
*/
GetSubStoreTTLResponse getSubStoreTTL(GetSubStoreTTLResquest request) throws LogException;
/**
* @param project name
* @param logstore name
* @param ttl ttl
* @return An instance of {@link UpdateSubStoreTTLResponse}
* @throws LogException if any error occurs
*/
UpdateSubStoreTTLResponse updateSubStoreTTL(String project, String logstore, int ttl) throws LogException;
/**
* @param request An instance of {@link UpdateSubStoreTTLRequest}
* @return An instance of {@link UpdateSubStoreTTLResponse}
* @throws LogException if any error occurs
*/
UpdateSubStoreTTLResponse updateSubStoreTTL(UpdateSubStoreTTLRequest request) throws LogException;
/**
* @param project name
* @param offset offset
* @param size size
* @param logstoreName logstore name
* @param telemetryType telemetry type
* @return An instance of {@link ListLogStoresResponse}
* @throws LogException if any error occurs
*/
ListLogStoresResponse listLogStores(String project, int offset, int size,String logstoreName, String telemetryType) throws LogException;
CreateDomainResponse createDomain(String project, Domain domain) throws LogException;
CreateDomainResponse createDomain(CreateDomainRequest requset) throws LogException;
DeleteDomainResponse deleteDomain(String project, String domainName) throws LogException;
DeleteDomainResponse deleteDomain(DeleteDomainRequest request) throws LogException;
ListDomainsResponse listDomains(String project, String domainName, int offset, int size) throws LogException;
ListDomainsResponse listDomains(ListDomainsRequest request) throws LogException;
CreateIngestionResponse createIngestion(CreateIngestionRequest request) throws LogException;
UpdateIngestionResponse updateIngestion(UpdateIngestionRequest request) throws LogException;
DeleteIngestionResponse deleteIngestion(DeleteIngestionRequest request) throws LogException;
GetIngestionResponse getIngestion(GetIngestionRequest request) throws LogException;
ListIngestionResponse listIngestion(ListIngestionRequest request) throws LogException;
StopIngestionResponse stopIngestion(StopIngestionRequest request) throws LogException;
StartIngestionResponse startIngestion(StartIngestionRequest request) throws LogException;
StartIngestionResponse restartIngestion(RestartIngestionRequest request) throws LogException;
CreateRebuildIndexResponse createRebuildIndex(CreateRebuildIndexRequest request) throws LogException;
DeleteRebuildIndexResponse deleteRebuildIndex(DeleteRebuildIndexRequest request) throws LogException;
GetRebuildIndexResponse getRebuildIndex(GetRebuildIndexRequest request) throws LogException;
ListRebuildIndexResponse listRebuildIndex(ListRebuildIndexRequest request) throws LogException;
StopRebuildIndexResponse stopRebuildIndex(StopRebuildIndexRequest request) throws LogException;
CreateAuditJobResponse createAuditJob(CreateAuditJobRequest request) throws LogException;
UpdateAuditJobResponse updateAuditJob(UpdateAuditJobRequest request) throws LogException;
GetAuditJobResponse getAuditJob(GetAuditJobRequest request) throws LogException;
DeleteAuditJobResponse deleteAuditJob(DeleteAuditJobRequest request) throws LogException;
ListAuditJobResponse listAuditJob(ListAuditJobRequest request) throws LogException;
StartAuditJobResponse startAuditJob(StartAuditJobRequest request) throws LogException;
StopAuditJobResponse stopAuditJob(StopAuditJobRequest request) throws LogException;
CreateTopostoreResponse createTopostore(CreateTopostoreRequest request) throws LogException;
UpdateTopostoreResponse updateTopostore(UpdateTopostoreRequest request) throws LogException;
GetTopostoreResponse getTopostore(GetTopostoreRequest request) throws LogException;
DeleteTopostoreResponse deleteTopostore(DeleteTopostoreRequest request) throws LogException ;
ListTopostoreResponse listTopostore(ListTopostoreRequest request) throws LogException ;
CreateTopostoreNodeResponse createTopostoreNode(CreateTopostoreNodeRequest request) throws LogException;
UpsertTopostoreNodeResponse upsertTopostoreNode(UpsertTopostoreNodeRequest request) throws LogException;
UpdateTopostoreNodeResponse updateTopostoreNode(UpdateTopostoreNodeRequest request) throws LogException;
DeleteTopostoreNodeResponse deleteTopostoreNode(DeleteTopostoreNodeRequest request) throws LogException;
ListTopostoreNodeResponse listTopostoreNode(ListTopostoreNodeRequest request) throws LogException;
CreateTopostoreRelationResponse createTopostoreRelation(CreateTopostoreRelationRequest request) throws LogException;
UpsertTopostoreRelationResponse upsertTopostoreRelation(UpsertTopostoreRelationRequest request) throws LogException;
UpdateTopostoreRelationResponse updateTopostoreRelation(UpdateTopostoreRelationRequest request) throws LogException;
DeleteTopostoreRelationResponse deleteTopostoreRelation(DeleteTopostoreRelationRequest request) throws LogException;
ListTopostoreRelationResponse listTopostoreRelation(ListTopostoreRelationRequest request) throws LogException;
CreateResourceResponse createResource(CreateResourceRequest request) throws LogException;
UpdateResourceResponse updateResource(UpdateResourceRequest request) throws LogException;
GetResourceResponse getResource(GetResourceRequest request) throws LogException;
DeleteResourceResponse deleteResource(DeleteResourceRequest request) throws LogException;
ListResourceResponse listResource(ListResourceRequest request) throws LogException;
CreateResourceRecordResponse createResourceRecord(CreateResourceRecordRequest request) throws LogException;
UpsertResourceRecordResponse upsertResourceRecord(UpsertResourceRecordRequest request) throws LogException;
UpdateResourceRecordResponse updateResourceRecord(UpdateResourceRecordRequest request) throws LogException;
GetResourceRecordResponse getResourceRecord(GetResourceRecordRequest request) throws LogException;
DeleteResourceRecordResponse deleteResourceRecord(DeleteResourceRecordRequest request) throws LogException;
ListResourceRecordResponse listResourceRecord(ListResourceRecordRequest request) throws LogException;
ListNextResourceRecordResponse listNextResourceRecord(ListNextResourceRecordRequest request) throws LogException;
CreateOrUpdateSqlInstanceResponse createSqlInstance(CreateOrUpdateSqlInstanceRequest request) throws LogException;
CreateOrUpdateSqlInstanceResponse updateSqlInstance(CreateOrUpdateSqlInstanceRequest request) throws LogException;
ListSqlInstanceResponse listSqlInstance(ListSqlInstanceRequest request) throws LogException;
SetProjectPolicyResponse setProjectPolicy(String projectName, String policyText) throws LogException;
GetProjectPolicyReponse getProjectPolicy(String projectName) throws LogException;
DeleteProjectPolicyReponse deleteProjectPolicy(String projectName) throws LogException;
SetProjectCnameResponse setProjectCname(SetProjectCnameRequest request) throws LogException;
ListProjectCnameResponse listProjectCname(String project) throws LogException;
VoidResponse deleteProjectCname(String project, String domain) throws LogException;
CreateLogStoreResponse createEventStore(CreateLogStoreRequest request) throws LogException;
CreateLogStoreResponse createEventStore(String project, LogStore logStore, Index index) throws LogException;
UpdateLogStoreResponse updateEventStore(UpdateLogStoreRequest request) throws LogException;
DeleteLogStoreResponse deleteEventStore(DeleteLogStoreRequest request) throws LogException;
GetLogStoreResponse getEventStore(GetLogStoreRequest request) throws LogException;
ListLogStoresResponse listEventStores(ListLogStoresRequest request) throws LogException;
VoidResponse updateLogStoreMeteringMode(UpdateLogStoreMeteringModeRequest request) throws LogException;
GetLogStoreMeteringModeResponse getLogStoreMeteringMode(GetLogStoreMeteringModeRequest request) throws LogException;
CreateMetricsConfigResponse createMetricsConfig(CreateMetricsConfigRequest request) throws LogException;
UpdateMetricsConfigResponse updateMetricsConfig(UpdateMetricsConfigRequest request) throws LogException;
DeleteMetricsConfigResponse deleteMetricsConfig(DeleteMetricsConfigRequest request) throws LogException;
GetMetricsConfigResponse getMetricsConfig(GetMetricsConfigRequest request) throws LogException;
ListMetricsConfigResponse listMetricsConfig(ListMetricsConfigRequest request) throws LogException;
CreateShipperMigrationResponse createShipperMigration(CreateShipperMigrationRequest request) throws LogException;
GetShipperMigrationResponse getShipperMigration(GetShipperMigrationRequest request) throws LogException;
ListShipperMigrationResponse listShipperMigration(ListShipperMigrationRequest request) throws LogException;
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy