Struct ListSubawardsOptions 

#[non_exhaustive]
pub struct ListSubawardsOptions {

    pub page: Option<u32>,
    pub limit: Option<u32>,
    pub cursor: Option<String>,
    pub shape: Option<String>,
    pub flat: bool,
    pub flat_lists: bool,
    pub award_key: Option<String>,
    pub prime_uei: Option<String>,
    pub sub_uei: Option<String>,
    pub awarding_agency: Option<String>,
    pub funding_agency: Option<String>,
    pub fiscal_year: Option<String>,
    pub fiscal_year_gte: Option<String>,
    pub fiscal_year_lte: Option<String>,
    pub recipient: Option<String>,
    pub ordering: Option<String>,
    pub extra: BTreeMap<String, String>,
}

Options for Client::list_subawards and Client::iterate_subawards.

Mirrors ListSubawardsOptions in the Go SDK. ordering must be "last_modified_date" or "-last_modified_date"; the server rejects other values (tango#2254).

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.

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.

award_key: Option<String>

Award key filter (typically the prime PIID).

prime_uei: Option<String>

Prime recipient UEI filter.

sub_uei: Option<String>

Subrecipient UEI filter.

awarding_agency: Option<String>

Awarding agency CGAC code.

funding_agency: Option<String>

Funding agency CGAC code.

fiscal_year: Option<String>

fiscal_year filter.

fiscal_year_gte: Option<String>

Lower bound for fiscal_year.

fiscal_year_lte: Option<String>

Upper bound for fiscal_year.

recipient: Option<String>

Recipient (sub or prime depending on endpoint allowlist).

ordering: Option<String>

Server-side sort spec. Must be "last_modified_date" or "-last_modified_date".

extra: BTreeMap<String, String>

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

Implementations

impl ListSubawardsOptions

pub fn builder() -> ListSubawardsOptionsBuilder

Create an instance of ListSubawardsOptions using the builder syntax

Trait Implementations

impl Clone for ListSubawardsOptions

fn clone(&self) -> ListSubawardsOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ListSubawardsOptions

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

Formats the value using the given formatter.

impl Default for ListSubawardsOptions

fn default() -> ListSubawardsOptions

Returns the “default value” for a type.

impl PartialEq for ListSubawardsOptions

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

impl StructuralPartialEq for ListSubawardsOptions