Class LogViewerService

Index

Constructors

Methods

deleteLogViewerSavedSearchByName getLogViewerLevel getLogViewerLevelCount getLogViewerLog getLogViewerMessageTemplate getLogViewerSavedSearch getLogViewerSavedSearchByName getLogViewerValidateLogsSize postLogViewerSavedSearch

Constructors

constructor

new LogViewerService(): LogViewerService
Returns LogViewerService

Methods

`Static`deleteLogViewerSavedSearchByName

deleteLogViewerSavedSearchByName<ThrowOnError extends boolean = true>(
    options: Options<DeleteLogViewerSavedSearchByNameData, ThrowOnError>,
): RequestResult<
    DeleteLogViewerSavedSearchByNameResponses,
    DeleteLogViewerSavedSearchByNameErrors,
    ThrowOnError,
    "fields",
>
Deletes a saved log search.

Deletes a saved log search identified by the provided name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<DeleteLogViewerSavedSearchByNameData, ThrowOnError>
Returns RequestResult<
    DeleteLogViewerSavedSearchByNameResponses,
    DeleteLogViewerSavedSearchByNameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3207

`Static`getLogViewerLevel

getLogViewerLevel<ThrowOnError extends boolean = true>(
    options?: Options<GetLogViewerLevelData, ThrowOnError>,
): RequestResult<
    GetLogViewerLevelResponses,
    GetLogViewerLevelErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of log sink levels.

Gets a collection of configured log sinks with their minimum log levels.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetLogViewerLevelData, ThrowOnError>
Returns RequestResult<
    GetLogViewerLevelResponses,
    GetLogViewerLevelErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3095

`Static`getLogViewerLevelCount

getLogViewerLevelCount<ThrowOnError extends boolean = true>(
    options?: Options<GetLogViewerLevelCountData, ThrowOnError>,
): RequestResult<
    GetLogViewerLevelCountResponses,
    GetLogViewerLevelCountErrors,
    ThrowOnError,
    "fields",
>
Gets log level counts.

Gets the count of log entries for each log level within the specified date range.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetLogViewerLevelCountData, ThrowOnError>
Returns RequestResult<
    GetLogViewerLevelCountResponses,
    GetLogViewerLevelCountErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3113

`Static`getLogViewerLog

getLogViewerLog<ThrowOnError extends boolean = true>(
    options?: Options<GetLogViewerLogData, ThrowOnError>,
): RequestResult<
    GetLogViewerLogResponses,
    GetLogViewerLogErrors,
    ThrowOnError,
    "fields",
>
Gets a paginated collection of log entries.

Gets a paginated collection of log entries with optional filtering and date range.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetLogViewerLogData, ThrowOnError>
Returns RequestResult<
    GetLogViewerLogResponses,
    GetLogViewerLogErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3131

`Static`getLogViewerMessageTemplate

getLogViewerMessageTemplate<ThrowOnError extends boolean = true>(
    options?: Options<GetLogViewerMessageTemplateData, ThrowOnError>,
): RequestResult<
    GetLogViewerMessageTemplateResponses,
    GetLogViewerMessageTemplateErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of log message templates.

Gets a paginated collection of unique message templates found in the logs.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetLogViewerMessageTemplateData, ThrowOnError>
Returns RequestResult<
    GetLogViewerMessageTemplateResponses,
    GetLogViewerMessageTemplateErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3149

`Static`getLogViewerSavedSearch

getLogViewerSavedSearch<ThrowOnError extends boolean = true>(
    options?: Options<GetLogViewerSavedSearchData, ThrowOnError>,
): RequestResult<
    GetLogViewerSavedSearchResponses,
    GetLogViewerSavedSearchErrors,
    ThrowOnError,
    "fields",
>
Gets a collection of saved log searches.

Gets a collection of saved log searches defined in the Umbraco installation.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetLogViewerSavedSearchData, ThrowOnError>
Returns RequestResult<
    GetLogViewerSavedSearchResponses,
    GetLogViewerSavedSearchErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3167

`Static`getLogViewerSavedSearchByName

getLogViewerSavedSearchByName<ThrowOnError extends boolean = true>(
    options: Options<GetLogViewerSavedSearchByNameData, ThrowOnError>,
): RequestResult<
    GetLogViewerSavedSearchByNameResponses,
    GetLogViewerSavedSearchByNameErrors,
    ThrowOnError,
    "fields",
>
Gets a saved log search by name.

Gets a saved log search identified by the provided name.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- options: Options<GetLogViewerSavedSearchByNameData, ThrowOnError>
Returns RequestResult<
    GetLogViewerSavedSearchByNameResponses,
    GetLogViewerSavedSearchByNameErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3225

`Static`getLogViewerValidateLogsSize

getLogViewerValidateLogsSize<ThrowOnError extends boolean = true>(
    options?: Options<GetLogViewerValidateLogsSizeData, ThrowOnError>,
): RequestResult<
    GetLogViewerValidateLogsSizeResponses,
    GetLogViewerValidateLogsSizeErrors,
    ThrowOnError,
    "fields",
>
Validates if logs can be viewed.

Checks if the log files are within the size limit and can be viewed.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<GetLogViewerValidateLogsSizeData, ThrowOnError>
Returns RequestResult<
    GetLogViewerValidateLogsSizeResponses,
    GetLogViewerValidateLogsSizeErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3243

`Static`postLogViewerSavedSearch

postLogViewerSavedSearch<ThrowOnError extends boolean = true>(
    options?: Options<PostLogViewerSavedSearchData, ThrowOnError>,
): RequestResult<
    PostLogViewerSavedSearchResponses,
    PostLogViewerSavedSearchErrors,
    ThrowOnError,
    "fields",
>
Creates a saved log search.

Creates a new saved log search with the provided name and query configuration.
Type Parameters
- ThrowOnError extends boolean = true
Parameters
- Optionaloptions: Options<PostLogViewerSavedSearchData, ThrowOnError>
Returns RequestResult<
    PostLogViewerSavedSearchResponses,
    PostLogViewerSavedSearchErrors,
    ThrowOnError,
    "fields",
>
- Defined in src/packages/core/backend-api/sdk.gen.ts:3185

Class LogViewerService

Index

Constructors

Methods

Constructors

constructor

Returns LogViewerService

Methods

StaticdeleteLogViewerSavedSearchByName

Type Parameters

Parameters

Returns RequestResult< DeleteLogViewerSavedSearchByNameResponses, DeleteLogViewerSavedSearchByNameErrors, ThrowOnError, "fields",>

StaticgetLogViewerLevel

Type Parameters

Parameters

Returns RequestResult< GetLogViewerLevelResponses, GetLogViewerLevelErrors, ThrowOnError, "fields",>

StaticgetLogViewerLevelCount

Type Parameters

Parameters

Returns RequestResult< GetLogViewerLevelCountResponses, GetLogViewerLevelCountErrors, ThrowOnError, "fields",>

StaticgetLogViewerLog

Type Parameters

Parameters

Returns RequestResult< GetLogViewerLogResponses, GetLogViewerLogErrors, ThrowOnError, "fields",>

StaticgetLogViewerMessageTemplate

Type Parameters

Parameters

Returns RequestResult< GetLogViewerMessageTemplateResponses, GetLogViewerMessageTemplateErrors, ThrowOnError, "fields",>

StaticgetLogViewerSavedSearch

Type Parameters

Parameters

Returns RequestResult< GetLogViewerSavedSearchResponses, GetLogViewerSavedSearchErrors, ThrowOnError, "fields",>

StaticgetLogViewerSavedSearchByName

Type Parameters

Parameters

Returns RequestResult< GetLogViewerSavedSearchByNameResponses, GetLogViewerSavedSearchByNameErrors, ThrowOnError, "fields",>

StaticgetLogViewerValidateLogsSize

Type Parameters

Parameters

Returns RequestResult< GetLogViewerValidateLogsSizeResponses, GetLogViewerValidateLogsSizeErrors, ThrowOnError, "fields",>

StaticpostLogViewerSavedSearch

Type Parameters

Parameters

Returns RequestResult< PostLogViewerSavedSearchResponses, PostLogViewerSavedSearchErrors, ThrowOnError, "fields",>

Settings

On This Page

`Static`deleteLogViewerSavedSearchByName

Returns RequestResult<
DeleteLogViewerSavedSearchByNameResponses,
DeleteLogViewerSavedSearchByNameErrors,
ThrowOnError,
"fields",
>

`Static`getLogViewerLevel

Returns RequestResult<
GetLogViewerLevelResponses,
GetLogViewerLevelErrors,
ThrowOnError,
"fields",
>

`Static`getLogViewerLevelCount

Returns RequestResult<
GetLogViewerLevelCountResponses,
GetLogViewerLevelCountErrors,
ThrowOnError,
"fields",
>

`Static`getLogViewerLog

Returns RequestResult<
GetLogViewerLogResponses,
GetLogViewerLogErrors,
ThrowOnError,
"fields",
>

`Static`getLogViewerMessageTemplate

Returns RequestResult<
GetLogViewerMessageTemplateResponses,
GetLogViewerMessageTemplateErrors,
ThrowOnError,
"fields",
>

`Static`getLogViewerSavedSearch

Returns RequestResult<
GetLogViewerSavedSearchResponses,
GetLogViewerSavedSearchErrors,
ThrowOnError,
"fields",
>

`Static`getLogViewerSavedSearchByName

Returns RequestResult<
GetLogViewerSavedSearchByNameResponses,
GetLogViewerSavedSearchByNameErrors,
ThrowOnError,
"fields",
>

`Static`getLogViewerValidateLogsSize

Returns RequestResult<
GetLogViewerValidateLogsSizeResponses,
GetLogViewerValidateLogsSizeErrors,
ThrowOnError,
"fields",
>

`Static`postLogViewerSavedSearch

Returns RequestResult<
PostLogViewerSavedSearchResponses,
PostLogViewerSavedSearchErrors,
ThrowOnError,
"fields",
>