Struct SearchParams

pub struct SearchParams {
    pub end: Option<String>,
    pub limit: Option<u64>,
    pub max_results: Option<u64>,
    pub order: Option<String>,
    pub order_by: Option<String>,
    pub query: Option<String>,
    pub search_restriction: Option<SearchRestrictionParams>,
    pub start: Option<String>,
    pub verbose: bool,
}

Parameters for searching the audit log, all fields are optional Conforms to the Pangea API

Fields

end: Option<String>

A period of time or an absolute timestamp

limit: Option<u64>

Number of audit records to include from the first page of the results

max_results: Option<u64>

Maximum number of results to return. min: 1 max: 10,000

order: Option<String>

Specify the sort order of the response. Options: asc, desc

order_by: Option<String>

Name of the colum to sort the results by. Options: actor, action, message, new, old, source, status, target, timestamp, tenant_id, received_at

query: Option<String>

Natural search string; a space-seprated list of case-sensitive values. Enclose strings in double-quotes “ to include spaces. Optionally prefix with a field ID and a colon : to limit to a specific field. e.g. "actor:John Smith" action:Create will search for the string “John Smith” in the actor field and the string “Create” in the action field, returning results such as actor:John Smith Jr The Third.

search_restriction: Option<SearchRestrictionParams>

Optional parameters to restrict the scope of the search based on specific values. e.g. "actor": ["John Smith", "Jane Doe"] will only return results where the actor field is either “John Smith” or “Jane Doe”. “John Smith Jr The Third” will not be returned.

start: Option<String>

A period of time or an absolute timestamp

verbose: bool

If true, include the root hash of the tree and the membership proof for each record in the response. default: false (pangea API’s default is true but we override this)

Trait Implementations

impl Clone for SearchParams

fn clone(&self) -> SearchParams

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SearchParams

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for SearchParams

fn default() -> SearchParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SearchParams

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for SearchParams

fn eq(&self, other: &SearchParams) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for SearchParams

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for SearchParams

impl StructuralPartialEq for SearchParams