Package com.atlan.api

Class LogsEndpoint

java.lang.Object
com.atlan.api.AbstractEndpoint
com.atlan.api.HeraclesEndpoint
com.atlan.api.LogsEndpoint
public class LogsEndpoint extends HeraclesEndpoint
API endpoints for access Atlan's event logs.

  • Constructor Details

    • LogsEndpoint

      public LogsEndpoint(AtlanClient client)

  • Method Details

    • getAdminEvents

      public AdminEventResponse getAdminEvents() throws AtlanException
      Retrieve the 100 most recent admin events.
      Returns:
      a list of the 100 most recent admin events
      Throws:
      AtlanException - on any issue interacting with the API

    • getAdminEvents

      public AdminEventResponse getAdminEvents(RequestOptions options) throws AtlanException
      Retrieve the 100 most recent admin events.
      Parameters:
      options - to override default client options
      Returns:
      a list of the 100 most recent admin events
      Throws:
      AtlanException - on any issue interacting with the API

    • getAdminEvents

      public AdminEventResponse getAdminEvents(AdminEventRequest request) throws AtlanException
      Retrieve admin events based on the supplied filters.
      Parameters:
      request - details of the filters to apply when retrieving admin events
      Returns:
      the admin events that match the supplied filters
      Throws:
      AtlanException - on any issue interacting with the API

    • getAdminEvents

      public AdminEventResponse getAdminEvents(AdminEventRequest request, RequestOptions options) throws AtlanException
      Retrieve admin events based on the supplied filters.
      Parameters:
      request - details of the filters to apply when retrieving admin events
      options - to override default client options
      Returns:
      the admin events that match the supplied filters
      Throws:
      AtlanException - on any issue interacting with the API

    • getEvents

      public KeycloakEventResponse getEvents() throws AtlanException
      Retrieve the 100 most recent events.
      Returns:
      a list of the 100 most recent events
      Throws:
      AtlanException - on any issue interacting with the API

    • getEvents

      public KeycloakEventResponse getEvents(RequestOptions options) throws AtlanException
      Retrieve the 100 most recent events.
      Parameters:
      options - to override default client settings
      Returns:
      a list of the 100 most recent events
      Throws:
      AtlanException - on any issue interacting with the API

    • getEvents

      public KeycloakEventResponse getEvents(KeycloakEventRequest request) throws AtlanException
      Retrieve all events, based on the supplied filters.
      Parameters:
      request - details of the filters to apply when retrieving events
      Returns:
      the events that match the supplied filters
      Throws:
      AtlanException - on any issue interacting with the API

    • getEvents

      public KeycloakEventResponse getEvents(KeycloakEventRequest request, RequestOptions options) throws AtlanException
      Retrieve all events, based on the supplied filters.
      Parameters:
      request - details of the filters to apply when retrieving events
      options - to override default client settings
      Returns:
      the events that match the supplied filters
      Throws:
      AtlanException - on any issue interacting with the API