Files
Desktop_RCULogAgent/bin/20220619_RCU日志上传工具_1.0.0.6/LOGSDK.xml
2025-12-11 11:39:02 +08:00

1161 lines
49 KiB
XML

<?xml version="1.0"?>
<doc>
<assembly>
<name>LOGSDK</name>
</assembly>
<members>
<member name="T:Aliyun.Api.LOG.Common.Authentication.IRequestSigner">
<summary>
Description of IRequestSigner.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Authentication.IRequestSigner.Sign(Aliyun.Api.LOG.Common.Communication.ServiceRequest,Aliyun.Api.LOG.Common.Authentication.ServiceCredentials)">
<summary>
Signs a request.
</summary>
<param name="request">The request to sign.</param>
<param name="credentials">The credentials used to sign.</param>
</member>
<member name="T:Aliyun.Api.LOG.Common.Authentication.ServiceCredentials">
<summary>
Represents the credentials used to access Aliyun Open Services.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Authentication.ServiceCredentials.AccessId">
<summary>
Gets the access ID.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Authentication.ServiceCredentials.AccessKey">
<summary>
Gets the access key.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Authentication.ServiceCredentials.#ctor(System.String,System.String)">
<summary>
Initialize an new instance of <see cref="T:Aliyun.Api.LOG.Common.Authentication.ServiceCredentials"/>.
</summary>
<param name="accessId">The access ID.</param>
<param name="accessKey">The access key.</param>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.ExecutionContext">
<summary>
Description of ExecutionContext.
</summary>
</member>
<member name="F:Aliyun.Api.LOG.Common.Communication.ExecutionContext.DefaultEncoding">
<summary>
The default encoding (charset name).
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ExecutionContext.Charset">
<summary>
Gets or sets the charset.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ExecutionContext.Signer">
<summary>
Gets or sets the request signer.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ExecutionContext.Credentials">
<summary>
Gets or sets the credentials.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ExecutionContext.ResponseHandlers">
<summary>
Gets the list of <see cref="T:Aliyun.Api.LOG.Common.Handlers.IResponseHandler" />.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Communication.ExecutionContext.#ctor">
<summary>
Constructor.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.HttpMethod">
<summary>
Represents a HTTP method.
</summary>
</member>
<member name="F:Aliyun.Api.LOG.Common.Communication.HttpMethod.Get">
<summary>
Represents HTTP GET. Default value.
</summary>
</member>
<member name="F:Aliyun.Api.LOG.Common.Communication.HttpMethod.Delete">
<summary>
Represents HTTP DELETE.
</summary>
</member>
<member name="F:Aliyun.Api.LOG.Common.Communication.HttpMethod.Head">
<summary>
Represents HTTP HEAD.
</summary>
</member>
<member name="F:Aliyun.Api.LOG.Common.Communication.HttpMethod.Post">
<summary>
Represents HTTP POST.
</summary>
</member>
<member name="F:Aliyun.Api.LOG.Common.Communication.HttpMethod.Put">
<summary>
Represents HTTP PUT.
</summary>
</member>
<member name="F:Aliyun.Api.LOG.Common.Communication.HttpMethod.Options">
<summary>
Represents HTTP OPTIONS.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.IServiceClient">
<summary>
Represent the channel that communicates with an Aliyun Open Service.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Communication.IServiceClient.Send(Aliyun.Api.LOG.Common.Communication.ServiceRequest,Aliyun.Api.LOG.Common.Communication.ExecutionContext)">
<summary>
Sends a request to the service.
</summary>
<param name="request">The request data.</param>
<param name="context">The execution context.</param>
<returns>The response data.</returns>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.ServiceClient">
<summary>
The default implementation of <see cref="T:Aliyun.Api.LOG.Common.Communication.IServiceClient" />.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.ServiceClientImpl">
<summary>
An default <see cref="T:Aliyun.Api.LOG.Common.Communication.ServiceClient"/> implementation that
communicates with Aliyun Services over the HTTP protocol.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.ServiceClientImpl.HttpAsyncResult">
<summary>
Represents the async operation of requests in <see cref="T:Aliyun.Api.LOG.Common.Communication.ServiceClientImpl"/>.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.ServiceClientImpl.ResponseImpl">
<summary>
Represents the response data of <see cref="T:Aliyun.Api.LOG.Common.Communication.ServiceClientImpl"/> requests.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.ServiceMessage">
<summary>
Description of ServiceMessage.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ServiceMessage.Headers">
<summary>
Gets the dictionary of HTTP headers.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ServiceMessage.Content">
<summary>
Gets or sets the content stream.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Communication.ServiceMessage.#ctor">
<summary>
Constructor.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.ServiceRequest">
<summary>
Represents the information for sending requests.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ServiceRequest.Endpoint">
<summary>
Gets or sets the endpoint.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ServiceRequest.ResourcePath">
<summary>
Gets or sets the resource path of the request URI.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ServiceRequest.Method">
<summary>
Gets or sets the HTTP method.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ServiceRequest.Parameters">
<summary>
Gets the dictionary of the request parameters.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.Communication.ServiceRequest.IsRepeatable">
<summary>
Gets whether the request can be repeated.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Communication.ServiceRequest.#ctor">
<summary>
Constuctor.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Communication.ServiceRequest.BuildRequestUri">
<summary>
Build the request URI from the request message.
</summary>
<returns></returns>
</member>
<member name="T:Aliyun.Api.LOG.Common.Communication.ServiceResponse">
<summary>
Represents the data of the responses of requests.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Communication.ServiceResponse.EnsureSuccessful">
<summary>
Throws the exception from communication if the status code is not 2xx.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Communication.ServiceResponse.#ctor">
<summary>
Constructor.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Handlers.IResponseHandler">
<summary>
Handles the response message from the services.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Handlers.ResponseHandler">
<summary>
Description of ResponseHandler.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.AsyncResult">
<summary>
The implementation of <see cref="T:System.IAsyncResult"/>
that represents the status of an async operation.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.AsyncResult.AsyncState">
<summary>
Gets a user-defined object that qualifies or contains information about an asynchronous operation.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.AsyncResult.AsyncWaitHandle">
<summary>
Gets a <see cref="T:System.Threading.WaitHandle"/> that is used to wait for an asynchronous operation to complete.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.AsyncResult.CompletedSynchronously">
<summary>
Gets a value that indicates whether the asynchronous operation completed synchronously.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Common.AsyncResult.IsCompleted">
<summary>
Gets a value that indicates whether the asynchronous operation has completed.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult.#ctor(System.AsyncCallback,System.Object)">
<summary>
Initializes an instance of <see cref="T:Aliyun.Api.LOG.Common.AsyncResult"/>.
</summary>
<param name="callback">The callback method when the async operation completes.</param>
<param name="state">A user-defined object that qualifies or contains information about an asynchronous operation.</param>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult.Complete(System.Exception)">
<summary>
Completes the async operation with an exception.
</summary>
<param name="ex">Exception from the async operation.</param>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult.WaitForCompletion">
<summary>
When called in the dervied classes, wait for completion.
It throws exception if the async operation ends with an exception.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult.NotifyCompletion">
<summary>
When called in the derived classes, notify operation completion
by setting <see cref="P:AsyncWaitHandle"/> and calling the user callback.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult.Dispose">
<summary>
Disposes the object and release resource.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult.Dispose(System.Boolean)">
<summary>
When overrided in the derived classes, release resources.
</summary>
<param name="disposing">Whether the method is called <see cref="M:Dispose"/></param>
</member>
<member name="T:Aliyun.Api.LOG.Common.AsyncResult`1">
<summary>
Represents the status of an async operation.
It also holds the result of the operation.
</summary>
<typeparam name="T">Type of the operation result.</typeparam>
</member>
<member name="F:Aliyun.Api.LOG.Common.AsyncResult`1._result">
<summary>
The result of the async operation.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult`1.#ctor(System.AsyncCallback,System.Object)">
<summary>
Initializes an instance of <see cref="T:Aliyun.Api.LOG.Common.AsyncResult`1"/>.
</summary>
<param name="callback">The callback method when the async operation completes.</param>
<param name="state">A user-defined object that qualifies or contains information about an asynchronous operation.</param>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult`1.GetResult">
<summary>
Gets result and release resources.
</summary>
<returns>The instance of result.</returns>
</member>
<member name="M:Aliyun.Api.LOG.Common.AsyncResult`1.Complete(`0)">
<summary>
Sets result and notify completion.
</summary>
<param name="result">The instance of result.</param>
</member>
<member name="T:Aliyun.Api.LOG.Common.Utilities.DateUtils">
<summary>
Description of DateUtils.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Utilities.DateUtils.FormatRfc822Date(System.DateTime)">
<summary>
Formats an instance of <see cref="T:System.DateTime" /> to a GMT string.
</summary>
<param name="dt">The date time to format.</param>
<returns></returns>
</member>
<member name="M:Aliyun.Api.LOG.Common.Utilities.DateUtils.ParseRfc822Date(System.String)">
<summary>
Formats a GMT date string to an object of <see cref="T:System.DateTime" />.
</summary>
<param name="dt"></param>
<returns></returns>
</member>
<member name="M:Aliyun.Api.LOG.Common.Utilities.DateUtils.FormatIso8601Date(System.DateTime)">
<summary>
Formats a date to a string in the format of ISO 8601 spec.
</summary>
<param name="dt"></param>
<returns></returns>
</member>
<member name="M:Aliyun.Api.LOG.Common.Utilities.DateUtils.GetDateTime(System.UInt32)">
<summary>
convert time stamp to DateTime.
</summary>
<param name="timeStamp">seconds</param>
<returns></returns>
</member>
<member name="T:Aliyun.Api.LOG.Common.Utilities.EnumUtils">
<summary>
Description of EnumUtils.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Utilities.HttpHeaders">
<summary>
Description of HttpHeaders.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Common.Utilities.HttpUtils">
<summary>
Description of HttpUtils.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Utilities.HttpUtils.GetRequestParameterString(System.Collections.Generic.IEnumerable{System.Collections.Generic.KeyValuePair{System.String,System.String}})">
<summary>
Builds the URI parameter string from the request parameters.
</summary>
<param name="parameters"></param>
<returns></returns>
</member>
<member name="M:Aliyun.Api.LOG.Common.Utilities.HttpUtils.UrlEncode(System.String,System.String)">
<summary>
Encodes the URL.
</summary>
<param name="data"></param>
<param name="charset"></param>
<returns></returns>
</member>
<member name="T:Aliyun.Api.LOG.Common.Utilities.IOUtils">
<summary>
Description of IOUtils.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Common.Utilities.IOUtils.WriteTo(System.IO.Stream,System.IO.Stream,System.Int64)">
<summary>
Write a stream to another
</summary>
<param name="orignStream">The stream you want to write from</param>
<param name="destStream">The stream written to</param>
<param name="maxLength">The max length of the stream to write</param>
<returns>The actual length written to destStream</returns>
</member>
<member name="T:Aliyun.Api.LOG.Common.Utilities.StringValueAttribute">
<summary>
The Attribute to mark a field that corresponds a string.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Data.Histogram">
<summary>
The log status(histogram info)
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.Histogram.From">
<summary>
The begin timestamp of time range
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.Histogram.To">
<summary>
The end timestamp of time range
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.Histogram.Count">
<summary>
The log count
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Data.Histogram.IsCompleted">
<summary>
detect whether histogram is complete or not.
</summary>
<returns>true if return histogram is complete. otherwise return false</returns>
</member>
<member name="M:Aliyun.Api.LOG.Data.Histogram.#ctor">
<summary>
default constructor
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Data.LogContent">
<summary>
This class presents one log content in logItem
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Data.LogContent.#ctor">
<summary>
default constructor
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Data.LogContent.#ctor(System.String,System.String)">
<summary>
constructure with specified parameters
</summary>
<param name="key">log content's key </param>
<param name="value">log content's value </param>
</member>
<member name="P:Aliyun.Api.LOG.Data.LogContent.Key">
<summary>
the logcontent's key
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.LogContent.Value">
<summary>
the logcontent's value
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Data.QueriedLog">
<summary>
QuriedLog used to present a log in query result. It contains log time, log source(ip/hostname,e.g),
and multiple of key/value pairs to present the log content
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.QueriedLog.Time">
<summary>
The log timestamp
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.QueriedLog.Source">
<summary>
The log source
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.QueriedLog.Contents">
<summary>
List of key/value pair to present the log content
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Data.QueriedLog.#ctor">
<summary>
default constructor
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Data.LogItem">
<summary>
This class presents one log event item that will put into SLS
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.LogItem.Time">
<summary>
the log's timestamp
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Data.LogItem.Contents">
<summary>
logcontents in logs
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Data.LogItem.#ctor">
<summary>
default constructor
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Data.LogItem.PushBack(System.String,System.String)">
<summary>
method to append log content by key/value pair
</summary>
<param name="key">user define field to name the value</param>
<param name="value">the value of field key</param>
</member>
<member name="M:Aliyun.Api.LOG.Data.LogItem.PushBack(Aliyun.Api.LOG.Data.LogContent)">
<summary>
method to append log content by key/value pair
</summary>
<param name="content">log content</param>
</member>
<member name="T:Aliyun.Api.LOG.Properties.Resources">
<summary>
A strongly-typed resource class, for looking up localized strings, etc.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Properties.Resources.ResourceManager">
<summary>
Returns the cached ResourceManager instance used by this class.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Properties.Resources.Culture">
<summary>
Overrides the current thread's CurrentUICulture property for all
resource lookups using this strongly typed resource class.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Properties.Resources.ExceptionEndOperationHasBeenCalled">
<summary>
Looks up a localized string similar to 以前使用 asyncResult调用过此方法。.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Properties.Resources.ExceptionIfArgumentStringIsNullOrEmpty">
<summary>
Looks up a localized string similar to 参数为空引用或值为长度是零的字符串。.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Properties.Resources.ExceptionInvalidResponse">
<summary>
Looks up a localized string similar to 返回结果无法解析。.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Properties.Resources.ExceptionUnknowError">
<summary>
Looks up a localized string similar to 服务器返回未知错误。.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Request.GetHistogramsRequest">
<summary>
The Request used to get histograms of a query from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.GetHistogramsRequest.#ctor">
<summary>
default constructor.
please set required fileds(project, logstore, from, to) initialized by this default constructor before
using it to send request. Otherwise, request will be failed with exception.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.GetHistogramsRequest.#ctor(System.String,System.String,System.UInt32,System.UInt32)">
<summary>
constructor with all required fileds
</summary>
<param name="project">project name</param>
<param name="logstore">logstore name</param>
<param name="from">begin timestamp of time range to query</param>
<param name="to">end timestamp of time range to query</param>
</member>
<member name="M:Aliyun.Api.LOG.Request.GetHistogramsRequest.#ctor(System.String,System.String,System.UInt32,System.UInt32,System.String,System.String)">
<summary>
constructor with all possible fileds
</summary>
<param name="project">project name</param>
<param name="logstore">logstore name</param>
<param name="from">begin timestamp of time range to query</param>
<param name="to">end timestamp of time range to query</param>
<param name="topic">log topic to query</param>
<param name="query">query string to run</param>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetHistogramsRequest.Logstore">
<summary>
The logstore name
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetHistogramsRequest.Topic">
<summary>
The log topic to query
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetHistogramsRequest.From">
<summary>
The begin timestamp of time range to query
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetHistogramsRequest.To">
<summary>
The end timestamp of time range to query
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetHistogramsRequest.Query">
<summary>
The query string to run
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Request.GetLogsRequest">
<summary>
The Request used to get data of a query from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.GetLogsRequest.#ctor">
<summary>
default constructor.
please set required fileds(project, logstore, from, to) initialized by this default constructor before
using it to send request. Otherwise, request will be failed with exception.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.GetLogsRequest.#ctor(System.String,System.String,System.UInt32,System.UInt32)">
<summary>
constructor with all required fileds
</summary>
<param name="project">project name</param>
<param name="logstore">logstore name</param>
<param name="from">begin timestamp of time range to query</param>
<param name="to">end timestamp of time range to query</param>
</member>
<member name="M:Aliyun.Api.LOG.Request.GetLogsRequest.#ctor(System.String,System.String,System.UInt32,System.UInt32,System.String,System.String,System.Int32,System.Int32,System.Boolean)">
<summary>
constructor with all possible fileds
</summary>
<param name="project">project name</param>
<param name="logstore">logstore name</param>
<param name="from">begin timestamp of time range to query</param>
<param name="to">end timestamp of time range to query</param>
<param name="topic">log topic to query</param>
<param name="query">query string to run</param>
<param name="lines">count of logs to request</param>
<param name="offset">offset of logs to request</param>
<param name="reverse">flag indicates whether logs in response are in reversed order</param>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetLogsRequest.Logstore">
<summary>
The logstore name
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetLogsRequest.Topic">
<summary>
The log topic to query
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetLogsRequest.From">
<summary>
The begin timestamp of time range to query
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetLogsRequest.To">
<summary>
The end timestamp of time range to query
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetLogsRequest.Query">
<summary>
The query string to run
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetLogsRequest.Lines">
<summary>
The count of logs to request
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetLogsRequest.Offset">
<summary>
The offset of logs to request
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.GetLogsRequest.Reverse">
<summary>
flag of logs' order int response.
If reverse is true, the query will return the latest logs.
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Request.ListLogstoresRequest">
<summary>
The request used to list log store from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.ListLogstoresRequest.#ctor">
<summary>
default constructor
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.ListLogstoresRequest.#ctor(System.String)">
<summary>
constructor with project name
</summary>
<param name="project">project name</param>
</member>
<member name="T:Aliyun.Api.LOG.Request.ListTopicsRequest">
<summary>
The request used to list topic from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.ListTopicsRequest.#ctor">
<summary>
default constructor.
please set required fileds(project, logstore) initialized by this default constructor before using it to
send request. Otherwise, request will be failed with exception.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.ListTopicsRequest.#ctor(System.String,System.String)">
<summary>
constructor with all required fileds
</summary>
<param name="project">project name</param>
<param name="logstore">logstore name</param>
</member>
<member name="M:Aliyun.Api.LOG.Request.ListTopicsRequest.#ctor(System.String,System.String,System.String,System.Int32)">
<summary>
constructor with all possible fileds
</summary>
<param name="project">project name</param>
<param name="logstore">logstore name</param>
<param name="token">token to list more topics</param>
<param name="lines">count of topics to request</param>
</member>
<member name="P:Aliyun.Api.LOG.Request.ListTopicsRequest.Logstore">
<summary>
The logstore name
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.ListTopicsRequest.Token">
<summary>
The token to list more topics
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.ListTopicsRequest.Lines">
<summary>
The count of topics to request
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.LogStoreRequest.Logstore">
<summary>
The logstore name
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Request.PutLogsRequest">
<summary>
The request used to send data to sls server
Note: if source is not set explicitly, machine's local private ip is used
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.PutLogsRequest.#ctor">
<summary>
default constructor.
please set required fileds(project, logstore) initialized by this default constructor before
using it to send request. Otherwise, request will be failed with exception.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.PutLogsRequest.#ctor(System.String,System.String)">
<summary>
constructor with all required fileds
</summary>
<param name="project">project name</param>
<param name="logstore">logstore name</param>
</member>
<member name="M:Aliyun.Api.LOG.Request.PutLogsRequest.#ctor(System.String,System.String,System.String,System.String,System.Collections.Generic.List{Aliyun.Api.LOG.Data.LogItem})">
<summary>
constructor with all possilbe fileds
</summary>
<param name="project">project name</param>
<param name="logstore">logstore name</param>
<param name="topic">log topic</param>
<param name="source">log source</param>
<param name="items">log data</param>
</member>
<member name="P:Aliyun.Api.LOG.Request.PutLogsRequest.Logstore">
<summary>
The logstore name
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.PutLogsRequest.Topic">
<summary>
The log topic
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.PutLogsRequest.Source">
<summary>
The log source
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Request.PutLogsRequest.LogItems">
<summary>
List of logs
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Request.LogRequest">
<summary>
Super class of all request
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.LogRequest.#ctor">
<summary>
default constructor of SLS Request.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Request.LogRequest.#ctor(System.String)">
<summary>
LogRequest constructor with project name.
</summary>
<param name="project">project name to do SLS Request</param>
</member>
<member name="P:Aliyun.Api.LOG.Request.LogRequest.Project">
<summary>
project name of the request
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Response.GetHistogramsResponse">
<summary>
The response of the GetHistogram API from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Response.GetHistogramsResponse.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},Newtonsoft.Json.Linq.JArray)">
<summary>
constructor with http header and body from response
</summary>
<param name="headers">http header from respsone</param>
<param name="jsonBody">http body (in json) from response</param>
</member>
<member name="M:Aliyun.Api.LOG.Response.GetHistogramsResponse.IsCompleted">
<summary>
detect whether response are complete or not.
</summary>
<returns>true if response is complete. otherwise return false</returns>
</member>
<member name="P:Aliyun.Api.LOG.Response.GetHistogramsResponse.TotalCount">
<summary>
The count of histograms
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Response.GetHistogramsResponse.Histograms">
<summary>
All of histograms
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Response.GetLogsResponse">
<summary>
The response of the GetLog API from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Response.GetLogsResponse.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},Newtonsoft.Json.Linq.JArray)">
<summary>
constructor with http header and body from response
</summary>
<param name="headers">http header from response</param>
<param name="jsonBody">http body (in json) from response</param>
</member>
<member name="P:Aliyun.Api.LOG.Response.GetLogsResponse.Count">
<summary>
The count of logs
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Response.GetLogsResponse.IsCompleted">
<summary>
detect whether response are complete or not.
</summary>
<returns>true if response is complete. otherwise return false</returns>
</member>
<member name="P:Aliyun.Api.LOG.Response.GetLogsResponse.Logs">
<summary>
List of logs
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Response.ListLogstoresResponse">
<summary>
The response of the ListLogStore API from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Response.ListLogstoresResponse.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},Newtonsoft.Json.Linq.JObject)">
<summary>
constructor with http header and body from response
</summary>
<param name="headers">http header from respsone</param>
<param name="jsonBody">http body (in json) from response</param>
</member>
<member name="P:Aliyun.Api.LOG.Response.ListLogstoresResponse.Count">
<summary>
Count of the logstores
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Response.ListLogstoresResponse.Logstores">
<summary>
All of the logstores
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Response.ListTopicsResponse">
<summary>
The response of the ListTopic API from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Response.ListTopicsResponse.#ctor(System.Collections.Generic.IDictionary{System.String,System.String},Newtonsoft.Json.Linq.JArray)">
<summary>
constructor with http header and body from response
</summary>
<param name="headers">http header from respsone</param>
<param name="jsonBody">http body (in json) from response</param>
</member>
<member name="P:Aliyun.Api.LOG.Response.ListTopicsResponse.Count">
<summary>
The count of log topics in the response
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Response.ListTopicsResponse.NextToken">
<summary>
The next token property in the response. It is used to list more topics in next ListTopics request.
If there is no more topics to list, it will return an empty string.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Response.ListTopicsResponse.Topics">
<summary>
All log topics in the response
</summary>
</member>
<member name="T:Aliyun.Api.LOG.Response.PutLogsResponse">
<summary>
The response of the PutLogs API from sls server
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Response.PutLogsResponse.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
default constructor for PutLogsResponse
</summary>
<param name="header">header information in http response</param>
</member>
<member name="T:Aliyun.Api.LOG.Response.LogResponse">
<summary>
Super class of SLS response
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Response.LogResponse.#ctor(System.Collections.Generic.IDictionary{System.String,System.String})">
<summary>
LogResponse constructor with HTTP response headers
</summary>
<param name="httpHeaders">HTTP response header from SLS server</param>
</member>
<member name="M:Aliyun.Api.LOG.Response.LogResponse.GetHeader(System.String)">
<summary>
Get the value from the head of response using key
</summary>
<returns>Value of specified http header</returns>
</member>
<member name="M:Aliyun.Api.LOG.Response.LogResponse.GetRequestId">
<summary>
Get request Id for current response generated on server-side. it is useful to track any potential issues
for this request.
</summary>
<returns>request Id generated on server-side</returns>
</member>
<member name="M:Aliyun.Api.LOG.Response.LogResponse.GetAllHeaders">
<summary>
Get all the http response headers
</summary>
<returns>Key-pair map for http headers</returns>
</member>
<member name="T:Aliyun.Api.LOG.Utilities.ClientConfiguration">
<summary>
表示访问阿里云服务的配置信息。
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Utilities.ClientConfiguration.UserAgent">
<summary>
获取设置访问请求的User-Agent。
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Utilities.ClientConfiguration.ProxyHost">
<summary>
获取或设置代理服务器的地址。
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Utilities.ClientConfiguration.ProxyPort">
<summary>
获取或设置代理服务器的端口。
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Utilities.ClientConfiguration.ProxyUserName">
<summary>
获取或设置用户名。
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Utilities.ClientConfiguration.ProxyPassword">
<summary>
获取或设置密码。
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Utilities.ClientConfiguration.ProxyDomain">
<summary>
获取或设置代理服务器授权用户所在的域。
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Utilities.ClientConfiguration.ConnectionTimeout">
<summary>
获取或设置连接的超时时间,单位为毫秒。
</summary>
</member>
<member name="P:Aliyun.Api.LOG.Utilities.ClientConfiguration.MaxErrorRetry">
<summary>
获取或设置请求发生错误时最大的重试次数。
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Utilities.ClientConfiguration.#ctor">
<summary>
初始化新的<see cref="T:Aliyun.Api.LOG.Utilities.ClientConfiguration"/>的实例。
</summary>
</member>
<member name="M:Aliyun.Api.LOG.Utilities.ClientConfiguration.Clone">
<summary>
获取该实例的拷贝。
</summary>
<returns>该实例的拷贝。</returns>
</member>
<member name="T:Aliyun.Api.LOG.LogClient">
<summary>
This is the main class in the sdk. It can be used to communicate with sls server to put/get/query data.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.LogClient.AccessKeyId">
<summary>
readonly property, AccessKeyId of LogClient
</summary>
</member>
<member name="P:Aliyun.Api.LOG.LogClient.AccessKey">
<summary>
readonly property, AccessKey of LogClient
</summary>
</member>
<member name="P:Aliyun.Api.LOG.LogClient.Endpoint">
<summary>
readonly property, Endpoint of LogClient
</summary>
</member>
<member name="P:Aliyun.Api.LOG.LogClient.ReadWriteTimeout">
<summary>
Read/Write Timeouf for underlying HTTPWebRequest.ReadWriteTimeout
</summary>
</member>
<member name="P:Aliyun.Api.LOG.LogClient.ConnectionTimeout">
<summary>
Connection Timeout for underlying HttpWebRequest.Timeout
</summary>
</member>
<member name="M:Aliyun.Api.LOG.LogClient.#ctor(System.String,System.String,System.String)">
<summary>
Construct the sls client with accessId, accessKey and server address,
all other parameters will be set to default value
</summary>
<param name="endpoint">the sls server address(e.g.,http://cn-hangzhou.sls.aliyuncs.com)</param>
<param name="accessKeyId">aliyun accessId</param>
<param name="accessKey">aliyun accessKey</param>
</member>
<member name="M:Aliyun.Api.LOG.LogClient.#ctor(System.String,System.String,System.String,System.String)">
<summary>
Construct the sls client with accessId, accessKey and server address,
all other parameters will be set to default value
</summary>
<param name="endpoint">the sls server address(e.g.,http://cn-hangzhou.sls.aliyuncs.com)</param>
<param name="accessKeyId">aliyun accessId</param>
<param name="accessKey">aliyun accessKey</param>
</member>
<member name="M:Aliyun.Api.LOG.LogClient.ListLogstores(Aliyun.Api.LOG.Request.ListLogstoresRequest)">
<summary>
List all of the logstores under specified project
</summary>
<param name="request">The request to list logstores</param>
<exception>LogException</exception>
<returns>The response of list log logstores</returns>
</member>
<member name="M:Aliyun.Api.LOG.LogClient.PutLogs(Aliyun.Api.LOG.Request.PutLogsRequest)">
<summary>
put logs into sls server
</summary>
<param name="request">The request to put logs </param>
<exception>LogException</exception>
<returns>The response to put logs</returns>
</member>
<member name="M:Aliyun.Api.LOG.LogClient.ListTopics(Aliyun.Api.LOG.Request.ListTopicsRequest)">
<summary>
Get the topics in the logtstore
</summary>
<param name="request">The list topics request</param>
<exception>LogException</exception>
<returns>The List topics response</returns>
</member>
<member name="M:Aliyun.Api.LOG.LogClient.GetLogs(Aliyun.Api.LOG.Request.GetLogsRequest)">
<summary>
Get The sub set of logs data from sls server which match input
parameters.
</summary>
<param name="request">The get logs request</param>
<exception>LogException</exception>
<returns>The get Logs response</returns>
</member>
<member name="M:Aliyun.Api.LOG.LogClient.GetHistograms(Aliyun.Api.LOG.Request.GetHistogramsRequest)">
<summary>
Get The log status(histogram info) from sls 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.
</summary>
<param name="request">The get histograms request</param>
<exception>LogException</exception>
<returns>The get histograms response</returns>
</member>
<member name="T:Aliyun.Api.LOG.LogException">
<summary>
The Exception of the sls request and response.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.LogException.RequestId">
<summary>
Get Sls sever requestid.
</summary>
</member>
<member name="P:Aliyun.Api.LOG.LogException.ErrorCode">
<summary>
Get LogException error code.
</summary>
</member>
<member name="M:Aliyun.Api.LOG.LogException.#ctor(System.String,System.String,System.String)">
<summary>
LogException constructor
</summary>
<param name="code">error code</param>
<param name="message">error message</param>
<param name="requestId">request identifier</param>
</member>
<member name="M:Aliyun.Api.LOG.LogException.#ctor(System.String,System.String,System.Exception,System.String)">
<summary>
LogException constructor
</summary>
<param name="code">error code</param>
<param name="message">error message</param>
<param name="innerException">the inner exception wrapped by LogException</param>
<param name="requestId"></param>
</member>
<member name="M:Aliyun.Api.LOG.LogException.ToString">
<summary>
get string presentation of LogException
</summary>
<returns>object in string</returns>
</member>
</members>
</doc>