Struct ListEntitiesOptions 

#[non_exhaustive]
pub struct ListEntitiesOptions {

    pub page: Option<u32>,
    pub limit: Option<u32>,
    pub cursor: Option<String>,
    pub shape: Option<String>,
    pub flat: bool,
    pub flat_lists: bool,
    pub search: Option<String>,
    pub cage_code: Option<String>,
    pub naics: Option<String>,
    pub name: Option<String>,
    pub psc: Option<String>,
    pub purpose_of_registration_code: Option<String>,
    pub socioeconomic: Option<String>,
    pub state: Option<String>,
    pub total_awards_obligated_gte: Option<String>,
    pub total_awards_obligated_lte: Option<String>,
    pub uei: Option<String>,
    pub zip_code: Option<String>,
    pub extra: BTreeMap<String, String>,
}

Options for Client::list_entities and Client::iterate_entities.

Mirrors the Go SDK’s ListEntitiesOptions.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

page: Option<u32>

1-based page number. Mutually exclusive with cursor.

limit: Option<u32>

Page size.

cursor: Option<String>

Keyset cursor.

shape: Option<String>

Comma-separated field selector.

flat: bool

Collapse nested objects into dot-separated keys.

flat_lists: bool

When flat is also true, flatten list-valued fields.

search: Option<String>

Free-text search filter.

cage_code: Option<String>

CAGE code filter.

naics: Option<String>

NAICS code filter.

name: Option<String>

Entity name filter.

psc: Option<String>

PSC code filter.

purpose_of_registration_code: Option<String>

SAM purpose-of-registration code.

socioeconomic: Option<String>

Socioeconomic indicator filter.

state: Option<String>

US state filter (2-letter code).

total_awards_obligated_gte: Option<String>

Lower bound for total obligated awards (dollars).

total_awards_obligated_lte: Option<String>

Upper bound for total obligated awards (dollars).

uei: Option<String>

UEI filter.

zip_code: Option<String>

ZIP code filter.

extra: BTreeMap<String, String>

Escape hatch for filter keys not yet first-classed on this struct.

Implementations

impl ListEntitiesOptions

pub fn builder() -> ListEntitiesOptionsBuilder

Create an instance of ListEntitiesOptions using the builder syntax

Trait Implementations

impl Clone for ListEntitiesOptions

fn clone(&self) -> ListEntitiesOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListEntitiesOptions

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

Formats the value using the given formatter.

impl Default for ListEntitiesOptions

fn default() -> ListEntitiesOptions

Returns the “default value” for a type.

impl PartialEq for ListEntitiesOptions

fn eq(&self, other: &ListEntitiesOptions) -> 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 Eq for ListEntitiesOptions

impl StructuralPartialEq for ListEntitiesOptions