Guardsix.Core.Search (guardsix v1.2.2)

Copy Markdown View Source

Search logs and retrieve instance data from Guardsix.

Wraps the Search API. Use Guardsix.search_params/4 to build the query struct.

Summary

Functions

Get devices from the Guardsix instance.

Create a search and get its search ID.

Retrieve the search result for a given search ID.

Get livesearches from the Guardsix instance.

Get loginspects from the Guardsix instance.

Get repos from the Guardsix instance.

Get user preference from the Guardsix instance.

Functions

devices(client)

@spec devices(Guardsix.Data.Client.t()) :: {:ok, map()} | {:error, term()}

Get devices from the Guardsix instance.

get_id(client, query)

@spec get_id(Guardsix.Data.Client.t(), Guardsix.Data.SearchParams.t()) ::
  {:ok, map()} | {:error, term()}

Create a search and get its search ID.

get_result(client, search_id)

@spec get_result(Guardsix.Data.Client.t(), String.t()) ::
  {:ok, map()} | {:error, term()}

Retrieve the search result for a given search ID.

livesearches(client)

@spec livesearches(Guardsix.Data.Client.t()) :: {:ok, map()} | {:error, term()}

Get livesearches from the Guardsix instance.

loginspects(client)

@spec loginspects(Guardsix.Data.Client.t()) :: {:ok, map()} | {:error, term()}

Get loginspects from the Guardsix instance.

repos(client)

@spec repos(Guardsix.Data.Client.t()) :: {:ok, map()} | {:error, term()}

Get repos from the Guardsix instance.

user_preference(client)

@spec user_preference(Guardsix.Data.Client.t()) :: {:ok, map()} | {:error, term()}

Get user preference from the Guardsix instance.