Class LogsAdminApi
Represents a collection of functions to interact with the API endpoints
Inherited Members
Namespace: Unity.Services.Apis.Admin.Observability
Assembly: Unity.Services.Apis.dll
Syntax
public class LogsAdminApi : ILogsAdminApi, IApiAccessor
Constructors
LogsAdminApi(IApiClient)
Initializes a new instance of the Logs
Declaration
public LogsAdminApi(IApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
LogsAdminApi(IApiClient, IApiConfiguration)
Initializes a new instance of the Logs
Declaration
public LogsAdminApi(IApiClient apiClient, IApiConfiguration apiConfiguration)
Parameters
Type | Name | Description |
---|---|---|
IApi |
apiClient | The client interface for synchronous API access. |
IApi |
apiConfiguration | The configuration object. |
Properties
Client
The client for accessing this underlying API asynchronously.
Declaration
public IApiClient Client { get; }
Property Value
Type | Description |
---|---|
IApi |
Configuration
Gets the configuration object
Declaration
public IApiConfiguration Configuration { get; }
Property Value
Type | Description |
---|---|
IApi |
An instance of the Configuration |
Methods
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
string | The base path |
GetLogs(string, string, int?, int?, string, string, string, CancellationToken)
Get Logs
Declaration
public ApiOperation<LogsResponse> GetLogs(string projectId, string environmentId, int? offset = null, int? limit = null, string from = null, string to = null, string query = null, CancellationToken cancellationToken = default)
Parameters
Type | Name | Description |
---|---|---|
string | projectId | ID of the project. |
string | environmentId | ID of the environment |
int? | offset | the offset of the records to return (optional) |
int? | limit | the maximum number of records to return (optional) |
string | from | a RFC3339 timestamp used to specify the starting timestamp of the records to return. Supports relative time ranges (optional) |
string | to | a RFC3339 timestamp used to specify the ending timestamp of the records to return. Supports relative time ranges (optional) |
string | query | a query string used to filter the logs. Supports the filtering language (optional) |
Cancellation |
cancellationToken | Cancellation Token to cancel the request. |
Returns
Type | Description |
---|---|
Api |
The operation |