LogService (Sls SDK for Java API Version 0.6.0 0.6.1 API)

所有已知实现类:

Client
```
public interface LogService
```

方法概要

All Methods Instance Methods Abstract Methods
限定符和类型	方法和说明
`ApplyConfigToMachineGroupResponse`	`ApplyConfigToMachineGroup(ApplyConfigToMachineGroupRequest request)` Apply config to machine group
`ApplyConfigToMachineGroupResponse`	`ApplyConfigToMachineGroup(String project, String groupName, String configName)` Apply config to machine group
`BatchGetLogResponse`	`BatchGetLog(BatchGetLogRequest request)` Batch get log
`BatchGetLogResponse`	`BatchGetLog(String project, String logStore, int shardId, int count, String cursor)` Batch get log
`CreateConfigResponse`	`CreateConfig(CreateConfigRequest request)` Create logtail config
`CreateConfigResponse`	`CreateConfig(String project, Config config)` Create logtail config
`CreateConsumerGroupResponse`	`CreateConsumerGroup(CreateConsumerGroupRequest request)` create logstore consumer group
`CreateConsumerGroupResponse`	`CreateConsumerGroup(String project, String logStore, ConsumerGroup consumerGroup)` create logstore consumer group
`CreateIndexResponse`	`CreateIndex(CreateIndexRequest request)` create logstore index
`CreateIndexResponse`	`CreateIndex(String project, String logStore, Index index)` create logstore index
`CreateLogStoreResponse`	`CreateLogStore(CreateLogStoreRequest request)` create logstore
`CreateLogStoreResponse`	`CreateLogStore(String project, LogStore logStore)` create a logstore in a project
`CreateMachineGroupResponse`	`CreateMachineGroup(CreateMachineGroupRequest request)` Create machine group
`CreateMachineGroupResponse`	`CreateMachineGroup(String project, MachineGroup group)` Create machine group
`DeleteConfigResponse`	`DeleteConfig(DeleteConfigRequest request)` Delete logtail config
`DeleteConfigResponse`	`DeleteConfig(String project, String configName)` Delete logtail config
`DeleteConsumerGroupResponse`	`DeleteConsumerGroup(String project, String logStore, String consumerGroup)` delete logstore consumer group
`DeleteIndexResponse`	`DeleteIndex(DeleteIndexRequest request)` delete logstore index
`DeleteIndexResponse`	`DeleteIndex(String project, String logStore)` delete logstore index
`DeleteLogStoreResponse`	`DeleteLogStore(DeleteLogStoreRequest request)` Delete logstore
`DeleteLogStoreResponse`	`DeleteLogStore(String project, String logStoreName)` Delete the logstore
`DeleteMachineGroupResponse`	`DeleteMachineGroup(DeleteMachineGroupRequest request)` Delete machine group
`DeleteMachineGroupResponse`	`DeleteMachineGroup(String project, String groupName)` Delete machine group
`DeleteShardResponse`	`DeleteShard(DeleteShardRequest request)` delete a readonly shard in the logtstore
`DeleteShardResponse`	`DeleteShard(String project, String logStore, int shardId)` delete a readonly shard in the logtstore
`GetAppliedConfigResponse`	`GetAppliedConfig(GetAppliedConfigsRequest request)` get applied config on a certain machine group
`GetAppliedConfigResponse`	`GetAppliedConfig(String project, String groupName)` get applied config on a certain machine group
`GetAppliedMachineGroupsResponse`	`GetAppliedMachineGroups(GetAppliedMachineGroupRequest request)` get applied machine group for a certain logtail config
`GetAppliedMachineGroupsResponse`	`GetAppliedMachineGroups(String project, String configName)` get applied machine group for a certain logtail config
`ConsumerGroupCheckPointResponse`	`GetCheckPoint(String project, String logStore, String consumerGroup)` get all of the shard checkpoints in the consumer group
`ConsumerGroupCheckPointResponse`	`GetCheckPoint(String project, String logStore, String consumerGroup, int shard)` get shard checkpoint in the consumer group
`GetConfigResponse`	`GetConfig(GetConfigRequest request)` Get logtail config
`GetConfigResponse`	`GetConfig(String project, String configName)` Get logtail config
`GetCursorResponse`	`GetCursor(GetCursorRequest request)` Get cursor from log service server
`GetCursorResponse`	`GetCursor(String project, String logStore, int shardId, Consts.CursorMode mode)` Get cursor from log service server
`GetCursorResponse`	`GetCursor(String project, String logStore, int shardId, Date fromTime)` Get cursor from log service server
`GetCursorResponse`	`GetCursor(String project, String logStore, int shardId, long fromTime)` Get cursor from log service server
`GetHistogramsResponse`	`GetHistograms(GetHistogramsRequest request)` Get The log status(histogram info) from log service server which match input parameters.
`GetHistogramsResponse`	`GetHistograms(String project, String logstore, int from, int to, String topic, String query)` Get The log status(histogram info) from log service server which match input parameters.
`GetIndexResponse`	`GetIndex(GetIndexRequest request)` Get logstore index config
`GetIndexResponse`	`GetIndex(String project, String logStore)` Get logstore index config
`GetLogsResponse`	`GetLogs(GetLogsRequest request)` Get The sub set of logs data from log service server which match input parameters.
`GetLogsResponse`	`GetLogs(String project, String logStore, int from, int to, String topic, String query)` Get The sub set of logs data from log service server which match input parameters.
`GetLogsResponse`	`GetLogs(String project, String logStore, int from, int to, String topic, String query, int line, int offset, boolean reverse)` Get The sub set of logs data from log service server which match input parameters.
`GetLogStoreResponse`	`GetLogStore(GetLogStoreRequest request)` get the logstore config
`GetLogStoreResponse`	`GetLogStore(String project, String logStoreName)` Get the logstore config
`GetMachineGroupResponse`	`GetMachineGroup(GetMachineGroupRequest request)` Get machine group
`GetMachineGroupResponse`	`GetMachineGroup(String project, String groupName)` Get machine group
`GetShipperTasksResponse`	`GetShipperTasks(String project, String logStore, String shipperName, int startTime, int endTime, String statusType, int offset, int size)` Get the tasks of a logstore shipper
`ConsumerGroupHeartBeatResponse`	`HeartBeat(String project, String logStore, String consumerGroup, String consumer, ArrayList<Integer> shards)` notify the server periodically to show that the consumer is still alive.
`ListConfigResponse`	`ListConfig(ListConfigRequest request)` List logtail configs
`ListConfigResponse`	`ListConfig(String project)` List logtail configs
`ListConfigResponse`	`ListConfig(String project, int offSet, int size)` List logtail configs
`ListConfigResponse`	`ListConfig(String project, String configName, int offSet, int size)` List logtail configs
`ListConsumerGroupResponse`	`ListConsumerGroup(String project, String logStore)` list logstore consumer groups
`ListLogStoresResponse`	`ListLogStores(ListLogStoresRequest request)` Get all the logstore of a project
`ListLogStoresResponse`	`ListLogStores(String project, int offset, int size, String logstoreName)` Get all the logstore for the user
`ListMachineGroupResponse`	`ListMachineGroup(ListMachineGroupRequest request)` List machine groups
`ListMachineGroupResponse`	`ListMachineGroup(String project)` List machine groups
`ListMachineGroupResponse`	`ListMachineGroup(String project, int offSet, int size)` List machine groups
`ListMachineGroupResponse`	`ListMachineGroup(String project, String groupName, int offSet, int size)` List machine groups
`ListMachinesResponse`	`ListMachines(String project, String machineGroup, int offset, int size)` List the real machines in the machine group
`ListShardResponse`	`ListShard(ListShardRequest request)` Get the shards in the logtstore
`ListShardResponse`	`ListShard(String project, String logStore)` Get the shards in the logtstore
`ListShipperResponse`	`ListShipper(String project, String logStore)` List shipper of a logstore
`ListTopicsResponse`	`ListTopics(ListTopicsRequest request)` Get the topics in the logtstore
`ListTopicsResponse`	`ListTopics(String project, String logStore, String token, int line)` Get the topics in the logtstore
`ListShardResponse`	`MergeShards(MergeShardsRequest request)` merge two readwrite shards in the logtstore
`ListShardResponse`	`MergeShards(String project, String logStore, int shardId)` merge two readwrite shards in the logtstore
`PutLogsResponse`	`PutLogs(PutLogsRequest request)` Send Data to log service server
`PutLogsResponse`	`PutLogs(String project, String logStore, String topic, List<LogItem> logItems, String source)` Send Data to log service server
`RemoveConfigFromMachineGroupResponse`	`RemoveConfigFromMachineGroup(RemoveConfigFromMachineGroupRequest request)` Remove config from machine group
`RemoveConfigFromMachineGroupResponse`	`RemoveConfigFromMachineGroup(String project, String groupName, String configName)` Remove config from machine group
`RetryShipperTasksResponse`	`RetryShipperTasks(String project, String logStore, String shipperName, List<String> taskList)` retry the failed tasks, for every time it can only retry 10 task
`ListShardResponse`	`SplitShard(SplitShardRequest request)` split a readwrite shard in the logtstore
`ListShardResponse`	`SplitShard(String project, String logStore, int shardId, String midHash)` split a readwrite shard in the logtstore
`ConsumerGroupUpdateCheckPointResponse`	`UpdateCheckPoint(String project, String logStore, String consumerGroup, int shard, String checkpoint)` update consume checkpoint
`ConsumerGroupUpdateCheckPointResponse`	`UpdateCheckPoint(String project, String logStore, String consumerGroup, String consumer, int shard, String checkpoint)` update consume checkpoint
`UpdateConfigResponse`	`UpdateConfig(String project, Config config)` Update logtail config
`UpdateConfigResponse`	`UpdateConfig(UpdateConfigRequest request)` Update logtail config
`UpdateConsumerGroupResponse`	`UpdateConsumerGroup(String project, String logStore, String consumerGroup, boolean inOrder)`
`UpdateConsumerGroupResponse`	`UpdateConsumerGroup(String project, String logStore, String consumerGroup, boolean inOrder, int timeoutInSec)` update consumer group
`UpdateConsumerGroupResponse`	`UpdateConsumerGroup(String project, String logStore, String consumerGroup, int timeoutInSec)` update consumer group
`UpdateIndexResponse`	`UpdateIndex(String project, String logStore, Index index)` Update logstore index config
`UpdateIndexResponse`	`UpdateIndex(UpdateIndexRequest request)` update logstore index config
`UpdateLogStoreResponse`	`UpdateLogStore(String project, LogStore logStore)` Update log store config
`UpdateLogStoreResponse`	`UpdateLogStore(UpdateLogStoreRequest request)` Update logstore config
`UpdateMachineGroupResponse`	`UpdateMachineGroup(String project, MachineGroup group)` Update machine group
`UpdateMachineGroupResponse`	`UpdateMachineGroup(UpdateMachineGroupRequest request)` Update machine group

- 方法详细资料
  - GetHistograms
```
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.
    
    参数:
    
    project - the project name
    
    logstore - the result data logstore
    
    from - the begin time of the result data to get
    
    to - the end time of the result data to get
    
    topic - the result data topic
    
    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.
    
    返回:
    
    the histogram response of the matched logs
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore is empty
  - GetHistograms
```
GetHistogramsResponse GetHistograms(GetHistogramsRequest request)
                             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.
    
    参数:
    
    request - the get histogram request
    
    返回:
    
    the histogram response of the matched logs
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if required paremter is null
  - GetLogs
```
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. By default, it will return at most 20 lines
    
    参数:
    
    project - the project name
    
    logStore - the result data logstore
    
    from - the begin time of the result data to get
    
    to - the end time of the result data to get
    
    topic - the result data topic
    
    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
    
    返回:
    
    a response contains a sub set of the logs matched the input parameters
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore is empty
  - GetLogs
```
GetLogsResponse GetLogs(String project,
                        String logStore,
                        int from,
                        int to,
                        String topic,
                        String query,
                        int line,
                        int offset,
                        boolean reverse)
                 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.
    
    参数:
    
    project - the project name
    
    logStore - the result data logstore
    
    from - the begin time of the result data to get
    
    to - the end time of the result data to get
    
    topic - the result data topic
    
    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
    
    line - how many lines to get, the max lines is decided by the sls backend server
    
    offset - the start log index in all the matched logs.
    
    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.
    
    返回:
    
    a response contains a sub set of the logs matched the input parameters
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore is empty
  - GetLogs
```
GetLogsResponse GetLogs(GetLogsRequest request)
                 throws LogException
```
    Get The sub set of logs data from log service server which match input parameters.
    
    参数:
    
    request - the get logs request
    
    返回:
    
    a response contains a sub set of the logs matched the input parameters
    
    抛出:
    
    NullPointerException - if required paremter is null
    
    LogException - if any error happen when get the data from log service server
  - ListLogStores
```
ListLogStoresResponse ListLogStores(String project,
                                    int offset,
                                    int size,
                                    String logstoreName)
                             throws LogException
```
    Get all the logstore for the user
    
    参数:
    
    project - the project name
    
    offset - the begin offset
    
    size - the query logstore name count
    
    logstoreName - part name of the logstore, only return the logstores which contains the input name
    
    返回:
    
    the user's logstore response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore is empty
  - ListLogStores
```
ListLogStoresResponse ListLogStores(ListLogStoresRequest request)
                             throws LogException
```
    Get all the logstore of a project
    
    参数:
    
    request - the list log store request
    
    返回:
    
    the user's logstore response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if required paremter is null
  - ListTopics
```
ListTopicsResponse ListTopics(String project,
                              String logStore,
                              String token,
                              int line)
                       throws LogException
```
    Get the topics in the logtstore
    
    参数:
    
    project - the project name
    
    logStore - where the topic belongs to
    
    token - all the returned topics are equal or larger than the given token according to topics' lexicographical order
    
    line - the topic number from log service server
    
    返回:
    
    the log store's topics response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore is empty
  - ListTopics
```
ListTopicsResponse ListTopics(ListTopicsRequest request)
                       throws LogException
```
    Get the topics in the logtstore
    
    参数:
    
    request - the list topics request
    
    返回:
    
    the log store's topics response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if required paremter is null
  - PutLogs
```
PutLogsResponse PutLogs(String project,
                        String logStore,
                        String topic,
                        List<LogItem> logItems,
                        String source)
                 throws LogException
```
    Send Data to log service server
    
    参数:
    
    project - the project name
    
    logStore - the log store where the source data should be put
    
    topic - source data topic
    
    logItems - the log data to send
    
    source - the source of the data, if the source is empty, it will be reset to the host ip
    
    返回:
    
    The put logs response
    
    抛出:
    
    LogException - if any error happen when send data to the server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore is empty, or the logGroup log count exceed 4096, or the total data size exceed 5MB
  - PutLogs
```
PutLogsResponse PutLogs(PutLogsRequest request)
                 throws LogException
```
    Send Data to log service server
    
    参数:
    
    request - the put log request
    
    返回:
    
    The put logs response
    
    抛出:
    
    LogException - if any error happen when send data to the server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore is empty, or the logGroup log count exceed 4096, or the total data size exceed 5MB
  - GetCursor
```
GetCursorResponse GetCursor(String project,
                            String logStore,
                            int shardId,
                            long fromTime)
                     throws LogException
```
    Get cursor from log service server
    
    参数:
    
    project - the project name
    
    logStore - the log store name
    
    shardId - the shard where the cursor should be get
    
    fromTime - the from time of log data in unix time stamp sec
    
    返回:
    
    The get cursor response
    
    抛出:
    
    LogException - if any error happen when get cursor from the server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logStore is empty
  - GetCursor
```
GetCursorResponse GetCursor(String project,
                            String logStore,
                            int shardId,
                            Date fromTime)
                     throws LogException
```
    Get cursor from log service server
    
    参数:
    
    project - the project name
    
    logStore - the log store name
    
    shardId - the shard where the cursor should be get
    
    fromTime - the from time of log data in java Date
    
    返回:
    
    The get cursor response
    
    抛出:
    
    LogException - if any error happen when get cursor from the server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any string argument in request is empty
  - GetCursor
```
GetCursorResponse GetCursor(String project,
                            String logStore,
                            int shardId,
                            Consts.CursorMode mode)
                     throws LogException
```
    Get cursor from log service server
    
    参数:
    
    project - the project name
    
    logStore - the log store name
    
    shardId - the shard where the cursor should be get
    
    mode - the mode to get cursor, include BEGIN and END
    
    返回:
    
    The get cursor response
    
    抛出:
    
    LogException - if any error happen when get cursor from the server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any string argument in request is empty
  - GetCursor
```
GetCursorResponse GetCursor(GetCursorRequest request)
                     throws LogException
```
    Get cursor from log service server
    
    参数:
    
    request - the get cursor request
    
    返回:
    
    The get cursor response
    
    抛出:
    
    LogException - if any error happen when get cursor from the server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any string argument in request is empty
  - ListShard
```
ListShardResponse ListShard(String project,
                            String logStore)
                     throws LogException
```
    Get the shards in the logtstore
    
    参数:
    
    project - the project name
    
    logStore - where the shard belongs to
    
    返回:
    
    the log store's shards response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore is empty
  - ListShard
```
ListShardResponse ListShard(ListShardRequest request)
                     throws LogException
```
    Get the shards in the logtstore
    
    参数:
    
    request - the get cursor request
    
    返回:
    
    the log store's shards response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore in request is empty
  - SplitShard
```
ListShardResponse SplitShard(String project,
                             String logStore,
                             int shardId,
                             String midHash)
                      throws LogException
```
    split a readwrite shard in the logtstore
    
    参数:
    
    project - the project name
    
    logStore - where the shard belongs to
    
    shardId - the shard id to split
    
    midHash - the middle md5 hash string to split the shard
    
    返回:
    
    the splited shard and two new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore in request is empty
  - SplitShard
```
ListShardResponse SplitShard(SplitShardRequest request)
                      throws LogException
```
    split a readwrite shard in the logtstore
    
    参数:
    
    request - split shard request
    
    返回:
    
    the splited shard and two new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore in request is empty
  - MergeShards
```
ListShardResponse MergeShards(String project,
                              String logStore,
                              int shardId)
                       throws LogException
```
    merge two readwrite shards in the logtstore
    
    参数:
    
    project - the project name
    
    logStore - where the shard belongs to
    
    shardId - the shard id to merge with right adjacent shard
    
    返回:
    
    the merges shards and new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore in request is empty
  - MergeShards
```
ListShardResponse MergeShards(MergeShardsRequest request)
                       throws LogException
```
    merge two readwrite shards in the logtstore
    
    参数:
    
    request - the project name
    
    返回:
    
    the merges shards and new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore in request is empty
  - DeleteShard
```
DeleteShardResponse DeleteShard(String project,
                                String logStore,
                                int shardId)
                         throws LogException
```
    delete a readonly shard in the logtstore
    
    参数:
    
    project - the project name
    
    logStore - where the shard belongs to
    
    shardId - the shard id to delete
    
    返回:
    
    the merges shards and new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore in request is empty
  - DeleteShard
```
DeleteShardResponse DeleteShard(DeleteShardRequest request)
                         throws LogException
```
    delete a readonly shard in the logtstore
    
    参数:
    
    request - delete shard request
    
    返回:
    
    the merges shards and new generated readwrite shard
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore in request is empty
  - BatchGetLog
```
BatchGetLogResponse BatchGetLog(String project,
                                String logStore,
                                int shardId,
                                int count,
                                String cursor)
                         throws LogException
```
    Batch get log
    
    参数:
    
    project - the project name
    
    logStore - where the shard belongs to
    
    shardId - the shard to batch get log
    
    count - the logrgroup num
    
    cursor - the cursor to batch get log
    
    返回:
    
    batch get log response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore or cursor is empty
  - BatchGetLog
```
BatchGetLogResponse BatchGetLog(BatchGetLogRequest request)
                         throws LogException
```
    Batch get log
    
    参数:
    
    request - the batch get log request
    
    返回:
    
    batch get log response
    
    抛出:
    
    LogException - if any error happen when get the data from log service server
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project or logstore or cursor in request is empty
  - CreateConfig
```
CreateConfigResponse CreateConfig(String project,
                                  Config config)
                           throws LogException
```
    Create logtail config
    
    参数:
    
    project - the project name
    
    config - the full config resource
    
    返回:
    
    the create config response
    
    抛出:
    
    LogException - if any error happen when creating logtail config
    
    NullPointerException - if config resource parameter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - CreateConfig
```
CreateConfigResponse CreateConfig(CreateConfigRequest request)
                           throws LogException
```
    Create logtail config
    
    参数:
    
    request - the create config request
    
    返回:
    
    the create config response
    
    抛出:
    
    LogException - if any error happen when creating logtail config
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateConfig
```
UpdateConfigResponse UpdateConfig(String project,
                                  Config config)
                           throws LogException
```
    Update logtail config
    
    参数:
    
    project - the project name
    
    config - the full config resource
    
    返回:
    
    the update config response
    
    抛出:
    
    LogException - if any error happen when updating logtail config
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateConfig
```
UpdateConfigResponse UpdateConfig(UpdateConfigRequest request)
                           throws LogException
```
    Update logtail config
    
    参数:
    
    request - the update config request
    
    返回:
    
    the update config response
    
    抛出:
    
    LogException - if any error happen when updating logtail config
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetConfig
```
GetConfigResponse GetConfig(String project,
                            String configName)
                     throws LogException
```
    Get logtail config
    
    参数:
    
    project - the project name
    
    configName - the config name
    
    返回:
    
    the get config response
    
    抛出:
    
    LogException - if any error happen when getting logtail config
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if configName is empty
  - GetConfig
```
GetConfigResponse GetConfig(GetConfigRequest request)
                     throws LogException
```
    Get logtail config
    
    参数:
    
    request - the get config request
    
    返回:
    
    the get config response
    
    抛出:
    
    LogException - if any error happen when getting logtail config
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - DeleteConfig
```
DeleteConfigResponse DeleteConfig(String project,
                                  String configName)
                           throws LogException
```
    Delete logtail config
    
    参数:
    
    project - the project name
    
    configName - the config name
    
    返回:
    
    the delete config response
    
    抛出:
    
    LogException - if any error happen when deleting logtail config
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - DeleteConfig
```
DeleteConfigResponse DeleteConfig(DeleteConfigRequest request)
                           throws LogException
```
    Delete logtail config
    
    参数:
    
    request - the delete config request
    
    返回:
    
    the delete config response
    
    抛出:
    
    LogException - if any error happen when deleting logtail config
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListConfig
```
ListConfigResponse ListConfig(String project)
                       throws LogException
```
    List logtail configs
    
    参数:
    
    project - the project name
    
    返回:
    
    the list configs response
    
    抛出:
    
    LogException - if any error happen when listing logtail configs
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListConfig
```
ListConfigResponse ListConfig(String project,
                              int offSet,
                              int size)
                       throws LogException
```
    List logtail configs
    
    参数:
    
    project - the project name
    
    offSet - the list offset
    
    size - the query size
    
    返回:
    
    the list configs response
    
    抛出:
    
    LogException - if any error happen when listing logtail configs
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListConfig
```
ListConfigResponse ListConfig(String project,
                              String configName,
                              int offSet,
                              int size)
                       throws LogException
```
    List logtail configs
    
    参数:
    
    project - the project name
    
    configName - the config name
    
    offSet - the list offset
    
    size - the query size
    
    返回:
    
    the list configs response
    
    抛出:
    
    LogException - if any error happen when listing logtail configs
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListConfig
```
ListConfigResponse ListConfig(ListConfigRequest request)
                       throws LogException
```
    List logtail configs
    
    参数:
    
    request - the list configs request
    
    返回:
    
    the list configs response
    
    抛出:
    
    LogException - if any error happen when listing logtail configs
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetAppliedConfig
```
GetAppliedConfigResponse GetAppliedConfig(String project,
                                          String groupName)
                                   throws LogException
```
    get applied config on a certain machine group
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    返回:
    
    get applied config response
    
    抛出:
    
    LogException - if any error happen when get applied config configs
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetAppliedConfig
```
GetAppliedConfigResponse GetAppliedConfig(GetAppliedConfigsRequest request)
                                   throws LogException
```
    get applied config on a certain machine group
    
    参数:
    
    request - get applied config request
    
    返回:
    
    get applied config response
    
    抛出:
    
    LogException - if any error happen when get applied config configs
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetAppliedMachineGroups
```
GetAppliedMachineGroupsResponse GetAppliedMachineGroups(String project,
                                                        String configName)
                                                 throws LogException
```
    get applied machine group for a certain logtail config
    
    参数:
    
    project - the project name
    
    configName - the config name
    
    返回:
    
    get applied machine group response
    
    抛出:
    
    LogException - if any error happen when get applied config configs
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetAppliedMachineGroups
```
GetAppliedMachineGroupsResponse GetAppliedMachineGroups(GetAppliedMachineGroupRequest request)
                                                 throws LogException
```
    get applied machine group for a certain logtail config
    
    参数:
    
    request - get applied machine group request
    
    返回:
    
    get applied machine group response
    
    抛出:
    
    LogException - if any error happen when get applied config configs
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - CreateMachineGroup
```
CreateMachineGroupResponse CreateMachineGroup(String project,
                                              MachineGroup group)
                                       throws LogException
```
    Create machine group
    
    参数:
    
    project - the project name
    
    group - the full machine group resource
    
    返回:
    
    the create machine group response
    
    抛出:
    
    LogException - if any error happen when creating machine group
    
    NullPointerException - if machine group resource parameter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - CreateMachineGroup
```
CreateMachineGroupResponse CreateMachineGroup(CreateMachineGroupRequest request)
                                       throws LogException
```
    Create machine group
    
    参数:
    
    request - the create machine group request
    
    返回:
    
    the create machine group response
    
    抛出:
    
    LogException - if any error happen when creating machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateMachineGroup
```
UpdateMachineGroupResponse UpdateMachineGroup(String project,
                                              MachineGroup group)
                                       throws LogException
```
    Update machine group
    
    参数:
    
    project - the project name
    
    group - the full machine group resource
    
    返回:
    
    the update machine group response
    
    抛出:
    
    LogException - if any error happen when updating machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateMachineGroup
```
UpdateMachineGroupResponse UpdateMachineGroup(UpdateMachineGroupRequest request)
                                       throws LogException
```
    Update machine group
    
    参数:
    
    request - the update machine group request
    
    返回:
    
    the update machine group response
    
    抛出:
    
    LogException - if any error happen when updating machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetMachineGroup
```
GetMachineGroupResponse GetMachineGroup(String project,
                                        String groupName)
                                 throws LogException
```
    Get machine group
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    返回:
    
    the get machine group response
    
    抛出:
    
    LogException - if any error happen when getting machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetMachineGroup
```
GetMachineGroupResponse GetMachineGroup(GetMachineGroupRequest request)
                                 throws LogException
```
    Get machine group
    
    参数:
    
    request - the get machine group request
    
    返回:
    
    the get machine group response
    
    抛出:
    
    LogException - if any error happen when getting machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - DeleteMachineGroup
```
DeleteMachineGroupResponse DeleteMachineGroup(String project,
                                              String groupName)
                                       throws LogException
```
    Delete machine group
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    返回:
    
    the delete machine group response
    
    抛出:
    
    LogException - if any error happen when deleting machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - DeleteMachineGroup
```
DeleteMachineGroupResponse DeleteMachineGroup(DeleteMachineGroupRequest request)
                                       throws LogException
```
    Delete machine group
    
    参数:
    
    request - the delete machine group request
    
    返回:
    
    the delete machine group response
    
    抛出:
    
    LogException - if any error happen when deleting machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListMachineGroup
```
ListMachineGroupResponse ListMachineGroup(String project)
                                   throws LogException
```
    List machine groups
    
    参数:
    
    project - the project name
    
    返回:
    
    the list machine groups response
    
    抛出:
    
    LogException - if any error happen when listing machine groups
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListMachines
```
ListMachinesResponse ListMachines(String project,
                                  String machineGroup,
                                  int offset,
                                  int size)
                           throws LogException
```
    List the real machines in the machine group
    
    参数:
    
    project - the project name
    
    machineGroup - the machine group name
    
    offset - the offset in the machine group
    
    size - the size to get
    
    返回:
    
    the machines in the machine group
    
    抛出:
    
    LogException - if any error happen when listing machines
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListMachineGroup
```
ListMachineGroupResponse ListMachineGroup(String project,
                                          int offSet,
                                          int size)
                                   throws LogException
```
    List machine groups
    
    参数:
    
    project - the project name
    
    offSet - the list offset
    
    size - the query size
    
    返回:
    
    the list machine groups response
    
    抛出:
    
    LogException - if any error happen when listing machine groups
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListMachineGroup
```
ListMachineGroupResponse ListMachineGroup(String project,
                                          String groupName,
                                          int offSet,
                                          int size)
                                   throws LogException
```
    List machine groups
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    offSet - the list offset
    
    size - the query size
    
    返回:
    
    the list machine groups response
    
    抛出:
    
    LogException - if any error happen when listing machine groups
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListMachineGroup
```
ListMachineGroupResponse ListMachineGroup(ListMachineGroupRequest request)
                                   throws LogException
```
    List machine groups
    
    参数:
    
    request - the list machine groups request
    
    返回:
    
    the list machine groups response
    
    抛出:
    
    LogException - if any error happen when listing machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ApplyConfigToMachineGroup
```
ApplyConfigToMachineGroupResponse ApplyConfigToMachineGroup(String project,
                                                            String groupName,
                                                            String configName)
                                                     throws LogException
```
    Apply config to machine group
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    configName - the logtail config name
    
    返回:
    
    the apply config to machine group response
    
    抛出:
    
    LogException - if any error happen when applying config to machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ApplyConfigToMachineGroup
```
ApplyConfigToMachineGroupResponse ApplyConfigToMachineGroup(ApplyConfigToMachineGroupRequest request)
                                                     throws LogException
```
    Apply config to machine group
    
    参数:
    
    request - apply config to machine group request
    
    返回:
    
    the apply config to machine group response
    
    抛出:
    
    LogException - if any error happen when applying config to machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - RemoveConfigFromMachineGroup
```
RemoveConfigFromMachineGroupResponse RemoveConfigFromMachineGroup(String project,
                                                                  String groupName,
                                                                  String configName)
                                                           throws LogException
```
    Remove config from machine group
    
    参数:
    
    project - the project name
    
    groupName - the machine group name
    
    configName - the logtail config name
    
    返回:
    
    the remove config from machine group response
    
    抛出:
    
    LogException - if any error happen when removing config from machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - RemoveConfigFromMachineGroup
```
RemoveConfigFromMachineGroupResponse RemoveConfigFromMachineGroup(RemoveConfigFromMachineGroupRequest request)
                                                           throws LogException
```
    Remove config from machine group
    
    参数:
    
    request - remove config from machine group request
    
    返回:
    
    the remove config from machine group response
    
    抛出:
    
    LogException - if any error happen when removing config from machine group
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - CreateLogStore
```
CreateLogStoreResponse CreateLogStore(String project,
                                      LogStore logStore)
                               throws LogException
```
    create a logstore in a project
    
    参数:
    
    project - the project name
    
    logStore - the config
    
    返回:
    
    the create log store response
    
    抛出:
    
    LogException - if any error happen when creasting logstore
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project is empty
  - CreateLogStore
```
CreateLogStoreResponse CreateLogStore(CreateLogStoreRequest request)
                               throws LogException
```
    create logstore
    
    参数:
    
    request - logstore create request
    
    返回:
    
    the create log store response
    
    抛出:
    
    LogException - if any error happen when creasting logstore
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateLogStore
```
UpdateLogStoreResponse UpdateLogStore(String project,
                                      LogStore logStore)
                               throws LogException
```
    Update log store config
    
    参数:
    
    project - the project name
    
    logStore - the logsotre config
    
    返回:
    
    update logstore response
    
    抛出:
    
    LogException - if any error happen when updating logstore
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if project is empty
  - UpdateLogStore
```
UpdateLogStoreResponse UpdateLogStore(UpdateLogStoreRequest request)
                               throws LogException
```
    Update logstore config
    
    参数:
    
    request - update logstore requst
    
    返回:
    
    Update logstore response
    
    抛出:
    
    LogException - if any error happen when updating logstore
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - DeleteLogStore
```
DeleteLogStoreResponse DeleteLogStore(String project,
                                      String logStoreName)
                               throws LogException
```
    Delete the logstore
    
    参数:
    
    project - the project name
    
    logStoreName - the lostore to delete
    
    返回:
    
    delete logstore response
    
    抛出:
    
    LogException - if any error happen when deleting logstore
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if an param is empty
  - DeleteLogStore
```
DeleteLogStoreResponse DeleteLogStore(DeleteLogStoreRequest request)
                               throws LogException
```
    Delete logstore
    
    参数:
    
    request - delete logstore request
    
    返回:
    
    the delete logstore response
    
    抛出:
    
    LogException - if any error happen when deleting logstore
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetLogStore
```
GetLogStoreResponse GetLogStore(String project,
                                String logStoreName)
                         throws LogException
```
    Get the logstore config
    
    参数:
    
    project - the project name
    
    logStoreName - the logstore name
    
    返回:
    
    the get logstore response
    
    抛出:
    
    LogException - if any error happen when getting logstore config
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any parameter is empty
  - GetLogStore
```
GetLogStoreResponse GetLogStore(GetLogStoreRequest request)
                         throws LogException
```
    get the logstore config
    
    参数:
    
    request - the get logstore config request
    
    返回:
    
    the get logstore response
    
    抛出:
    
    LogException - if any error happen when getting logstore config
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - CreateIndex
```
CreateIndexResponse CreateIndex(String project,
                                String logStore,
                                Index index)
                         throws LogException
```
    create logstore index
    
    参数:
    
    project - the project name
    
    logStore - the logstore name
    
    index - logstore index config
    
    返回:
    
    create index response
    
    抛出:
    
    LogException - if any error happen when creating index
    
    NullPointerException - if the request is null
    
    IllegalArgumentException - if any string paramter is empty
  - CreateIndex
```
CreateIndexResponse CreateIndex(CreateIndexRequest request)
                         throws LogException
```
    create logstore index
    
    参数:
    
    request - the create logstore index request
    
    返回:
    
    create index response
    
    抛出:
    
    LogException - if any error happen when creating index
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateIndex
```
UpdateIndexResponse UpdateIndex(String project,
                                String logStore,
                                Index index)
                         throws LogException
```
    Update logstore index config
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    index - logstore index config
    
    返回:
    
    update logstore index response
    
    抛出:
    
    LogException - if any error happen when updating logstore index config
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any string parameter is empty
  - UpdateIndex
```
UpdateIndexResponse UpdateIndex(UpdateIndexRequest request)
                         throws LogException
```
    update logstore index config
    
    参数:
    
    request - update logstore index request
    
    返回:
    
    update logstore index response
    
    抛出:
    
    LogException - if any error happen when update logstore index config
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - DeleteIndex
```
DeleteIndexResponse DeleteIndex(String project,
                                String logStore)
                         throws LogException
```
    delete logstore index
    
    参数:
    
    project - project name
    
    logStore - store name
    
    返回:
    
    delete logstore index response
    
    抛出:
    
    LogException - if any error happen when deleting logstore index config
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any string parameter is empty
  - DeleteIndex
```
DeleteIndexResponse DeleteIndex(DeleteIndexRequest request)
                         throws LogException
```
    delete logstore index
    
    参数:
    
    request - delete logstore index config
    
    返回:
    
    deleing index response
    
    抛出:
    
    LogException - if any error happen when deleting logstore index config
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetIndex
```
GetIndexResponse GetIndex(String project,
                          String logStore)
                   throws LogException
```
    Get logstore index config
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    返回:
    
    get index config response
    
    抛出:
    
    LogException - if any error happen when get index config
    
    NullPointerException - if any parameter is null
    
    IllegalArgumentException - if any string parameter is empty
  - GetIndex
```
GetIndexResponse GetIndex(GetIndexRequest request)
                   throws LogException
```
    Get logstore index config
    
    参数:
    
    request - get logstore index request
    
    返回:
    
    get index config response
    
    抛出:
    
    LogException - if any error happen when getting index config
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - CreateConsumerGroup
```
CreateConsumerGroupResponse CreateConsumerGroup(CreateConsumerGroupRequest request)
                                         throws LogException
```
    create logstore consumer group
    
    参数:
    
    request - contains all of the parameters needed
    
    返回:
    
    create logstore consumer group response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - CreateConsumerGroup
```
CreateConsumerGroupResponse CreateConsumerGroup(String project,
                                                String logStore,
                                                ConsumerGroup consumerGroup)
                                         throws LogException
```
    create logstore consumer group
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - contains all of the parameters needed by consumer group
    
    返回:
    
    create logstore consumer group response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - DeleteConsumerGroup
```
DeleteConsumerGroupResponse DeleteConsumerGroup(String project,
                                                String logStore,
                                                String consumerGroup)
                                         throws LogException
```
    delete logstore consumer group
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    返回:
    
    delete logstore consumer group response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListConsumerGroup
```
ListConsumerGroupResponse ListConsumerGroup(String project,
                                            String logStore)
                                     throws LogException
```
    list logstore consumer groups
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    返回:
    
    list logstore consumer groups response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateConsumerGroup
```
UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
                                                String logStore,
                                                String consumerGroup,
                                                boolean inOrder,
                                                int timeoutInSec)
                                         throws LogException
```
    update consumer group
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    inOrder - consume data in oder or not
    
    timeoutInSec - if the time interval of a consumer's heartbeat exceed this value in second, the consumer will be deleted.
    
    返回:
    
    update consumer group response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateConsumerGroup
```
UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
                                                String logStore,
                                                String consumerGroup,
                                                boolean inOrder)
                                         throws LogException
```
    抛出:
    
    LogException
  - UpdateConsumerGroup
```
UpdateConsumerGroupResponse UpdateConsumerGroup(String project,
                                                String logStore,
                                                String consumerGroup,
                                                int timeoutInSec)
                                         throws LogException
```
    update consumer group
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    timeoutInSec - if the time interval of a consumer's heartbeat exceed this value in second, the consumer will be deleted.
    
    返回:
    
    update consumer group response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateCheckPoint
```
ConsumerGroupUpdateCheckPointResponse UpdateCheckPoint(String project,
                                                       String logStore,
                                                       String consumerGroup,
                                                       String consumer,
                                                       int shard,
                                                       String checkpoint)
                                                throws LogException
```
    update consume checkpoint
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    consumer - consumer name
    
    shard - shard id
    
    checkpoint - shard cursor
    
    返回:
    
    update consume checkpoint response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - UpdateCheckPoint
```
ConsumerGroupUpdateCheckPointResponse UpdateCheckPoint(String project,
                                                       String logStore,
                                                       String consumerGroup,
                                                       int shard,
                                                       String checkpoint)
                                                throws LogException
```
    update consume checkpoint
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    shard - shard id
    
    checkpoint - shard cursor
    
    返回:
    
    update consume checkpoint response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - HeartBeat
```
ConsumerGroupHeartBeatResponse HeartBeat(String project,
                                         String logStore,
                                         String consumerGroup,
                                         String consumer,
                                         ArrayList<Integer> shards)
                                  throws LogException
```
    notify the server periodically to show that the consumer is still alive.
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    consumer - consumer name
    
    shards - shards hold by the consumer
    
    返回:
    
    heartbeat response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetCheckPoint
```
ConsumerGroupCheckPointResponse GetCheckPoint(String project,
                                              String logStore,
                                              String consumerGroup,
                                              int shard)
                                       throws LogException
```
    get shard checkpoint in the consumer group
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    shard - shard id
    
    返回:
    
    get shard checkpoint response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetCheckPoint
```
ConsumerGroupCheckPointResponse GetCheckPoint(String project,
                                              String logStore,
                                              String consumerGroup)
                                       throws LogException
```
    get all of the shard checkpoints in the consumer group
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    consumerGroup - consumer group name
    
    返回:
    
    get shard checkpoint response
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - ListShipper
```
ListShipperResponse ListShipper(String project,
                                String logStore)
                         throws LogException
```
    List shipper of a logstore
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    返回:
    
    ListShipperResponse if any error happened
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - GetShipperTasks
```
GetShipperTasksResponse GetShipperTasks(String project,
                                        String logStore,
                                        String shipperName,
                                        int startTime,
                                        int endTime,
                                        String statusType,
                                        int offset,
                                        int size)
                                 throws LogException
```
    Get the tasks of a logstore shipper
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    shipperName - shipper name
    
    startTime - the start time in timestamp (from 1970.1.1)
    
    endTime - the end time
    
    statusType - one of ['', 'success', 'running', 'fail'], if statusType is '', return all tasks
    
    offset - the offset
    
    size - the task count
    
    返回:
    
    GetShipperTasksResponse
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty
  - RetryShipperTasks
```
RetryShipperTasksResponse RetryShipperTasks(String project,
                                            String logStore,
                                            String shipperName,
                                            List<String> taskList)
                                     throws LogException
```
    retry the failed tasks, for every time it can only retry 10 task
    
    参数:
    
    project - project name
    
    logStore - logstore name
    
    shipperName - shipper name
    
    taskList - failed task id list
    
    返回:
    
    RetryShipperTasksResponse
    
    抛出:
    
    LogException - if any error happened
    
    NullPointerException - if required paremter is null
    
    IllegalArgumentException - if any required string parameter is empty

接口 LogService

方法概要

方法详细资料

GetHistograms

GetHistograms

GetLogs

GetLogs

GetLogs

ListLogStores

ListLogStores

ListTopics

ListTopics

PutLogs

PutLogs

GetCursor

GetCursor

GetCursor

GetCursor

ListShard

ListShard

SplitShard

SplitShard

MergeShards

MergeShards

DeleteShard

DeleteShard

BatchGetLog

BatchGetLog

CreateConfig

CreateConfig

UpdateConfig

UpdateConfig

GetConfig

GetConfig

DeleteConfig

DeleteConfig

ListConfig

ListConfig

ListConfig

ListConfig

GetAppliedConfig

GetAppliedConfig

GetAppliedMachineGroups

GetAppliedMachineGroups

CreateMachineGroup

CreateMachineGroup

UpdateMachineGroup

UpdateMachineGroup

GetMachineGroup

GetMachineGroup

DeleteMachineGroup

DeleteMachineGroup

ListMachineGroup

ListMachines

ListMachineGroup

ListMachineGroup

ListMachineGroup

ApplyConfigToMachineGroup

ApplyConfigToMachineGroup

RemoveConfigFromMachineGroup

RemoveConfigFromMachineGroup

CreateLogStore

CreateLogStore

UpdateLogStore

UpdateLogStore

DeleteLogStore

DeleteLogStore

GetLogStore

GetLogStore

CreateIndex

CreateIndex

UpdateIndex

UpdateIndex

DeleteIndex

DeleteIndex

GetIndex

GetIndex

CreateConsumerGroup

CreateConsumerGroup

DeleteConsumerGroup