Package com.okta.sdk.resource.api

Class SystemLogApi

java.lang.Object

com.okta.sdk.resource.api.SystemLogApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2024-09-23T16:19:57.008753975Z[Etc/UTC]",
           comments="Generator version: 7.8.0")
public class SystemLogApi
extends Object

Constructor Summary

Constructors

Constructor	Description
SystemLogApi()
SystemLogApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<LogEvent>	listLogEvents(String since, String until, String after, String filter, String q, Integer limit, String sortOrder)	List all System Log Events Lists all System Log Events
List<LogEvent>	listLogEvents(String since, String until, String after, String filter, String q, Integer limit, String sortOrder, Map<String,String> additionalHeaders)	List all System Log Events Lists all System Log Events
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

SystemLogApi

public SystemLogApi()

SystemLogApi

public SystemLogApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

listLogEvents

public List<LogEvent> listLogEvents(String since,
 String until,
 String after,
 String filter,
 String q,
 Integer limit,
 String sortOrder)
                             throws ApiException

List all System Log Events Lists all System Log Events

Parameters:

since - Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries (optional, default to 7 days prior to until)

until - Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries. (optional, default to current time)

after - Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter (optional)

filter - Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter). (optional)

q - Filters log events results by one or more case insensitive keywords. (optional)

limit - Sets the number of results that are returned in the response (optional, default to 100)

sortOrder - The order of the returned events that are sorted by the `published` property (optional, default to ASCENDING)

Returns:

List<LogEvent>

Throws:

ApiException - if fails to make API call

listLogEvents

public List<LogEvent> listLogEvents(String since,
 String until,
 String after,
 String filter,
 String q,
 Integer limit,
 String sortOrder,
 Map<String,String> additionalHeaders)
                             throws ApiException

List all System Log Events Lists all System Log Events

Parameters:

since - Filters the lower time bound of the log events `published` property for bounded queries or persistence time for polling queries (optional, default to 7 days prior to until)

until - Filters the upper time bound of the log events `published` property for bounded queries or persistence time for polling queries. (optional, default to current time)

after - Retrieves the next page of results. Okta returns a link in the HTTP Header (`rel=next`) that includes the after query parameter (optional)

filter - Filter expression that filters the results. All operators except [ ] are supported. See [Filter](https://developer.okta.com/docs/api/#filter). (optional)

q - Filters log events results by one or more case insensitive keywords. (optional)

limit - Sets the number of results that are returned in the response (optional, default to 100)

sortOrder - The order of the returned events that are sorted by the `published` property (optional, default to ASCENDING)

additionalHeaders - additionalHeaders for this call

Returns:

List<LogEvent>

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()