Skip to main content

ListBudgetAccountsOptions

Struct ListBudgetAccountsOptions 

Source
#[non_exhaustive]
pub struct ListBudgetAccountsOptions {
Show 26 fields pub page: Option<u32>, pub limit: Option<u32>, pub cursor: Option<String>, pub shape: Option<String>, pub flat: bool, pub flat_lists: bool, pub federal_account_symbol: Option<String>, pub fiscal_year: Option<String>, pub fiscal_year_gte: Option<String>, pub fiscal_year_lte: Option<String>, pub data_through_period: Option<String>, pub data_through_period_gte: Option<String>, pub data_through_period_lte: Option<String>, pub data_through_period_isnull: Option<bool>, pub agency: Option<String>, pub agency_code: Option<String>, pub bureau_name: Option<String>, pub account_title: Option<String>, pub subfunction_code: Option<String>, pub bea_category: Option<String>, pub on_off_budget: Option<String>, pub account_category: Option<String>, pub account_category_in: Option<String>, pub search: Option<String>, pub ordering: Option<String>, pub extra: BTreeMap<String, String>,
}
Expand description

Options for Client::list_budget_accounts and Client::iterate_budget_accounts.

The API rejects an unknown filter name with a 400 rather than ignoring it. The exact, __gte and __lte range filters on the numeric lifecycle and ratio fields (e.g. enacted_ba__gte), and the __in multi-value variants other than account_category_in, are reachable via the extra map. There is no filter on source_anomalies; it is in the default shape, so every row already carries it.

Fields (Non-exhaustive)§

This struct is marked as 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 (server caps at 100).

§cursor: Option<String>

Keyset cursor.

§shape: Option<String>

Comma-separated field selector. Use SHAPE_BUDGET_ACCOUNTS_MINIMAL or roll your own.

§flat: bool

Collapse nested objects into dot-separated keys.

§flat_lists: bool

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

§federal_account_symbol: Option<String>

Federal account symbol filter (exact, e.g. "097-0100").

§fiscal_year: Option<String>

fiscal_year filter (exact).

§fiscal_year_gte: Option<String>

Lower bound for fiscal_year (inclusive).

§fiscal_year_lte: Option<String>

Upper bound for fiscal_year (inclusive).

§data_through_period: Option<String>

data_through_period filter (exact): the File A fiscal period (1-12) the account-year’s figures run through.

§data_through_period_gte: Option<String>

Lower bound for data_through_period (inclusive).

§data_through_period_lte: Option<String>

Upper bound for data_through_period (inclusive).

§data_through_period_isnull: Option<bool>

Some(true) keeps only rows with no File A data (null data_through_period), Some(false) only rows with it (sent as data_through_period__isnull).

§agency: Option<String>

A Tango agency name, abbreviation, code or organization key (e.g. EPA), matched against the account’s resolved organization. Matches by name, abbreviation, or code (CGAC, FPDS, Federal Hierarchy key or AAC) and includes every sub-agency and office beneath it; OR several with |. A token that does not resolve falls back to an exact match on agency_code.

§agency_code: Option<String>

Agency code filter (exact).

§bureau_name: Option<String>

Bureau name filter (exact).

§account_title: Option<String>

Case-insensitive substring match on the account title (sent as account_title__icontains).

§subfunction_code: Option<String>

Budget subfunction code filter (exact).

§bea_category: Option<String>

Bureau of Economic Analysis category filter (exact).

§on_off_budget: Option<String>

On/off-budget flag filter (exact).

§account_category: Option<String>

Account category filter (exact): budgetary or credit_financing today. Credit financing accounts have no enacted budget authority (enacted_ba is null) and are left out of organization budget totals.

§account_category_in: Option<String>

Several account categories, comma-separated (sent as account_category__in).

§search: Option<String>

Free-text search filter.

§ordering: Option<String>

Server-side sort spec (prefix - for descending). The default is latest fiscal year first, then largest enacted_ba, with null enacted_ba last and id breaking ties.

§extra: BTreeMap<String, String>

Escape hatch for filter keys not yet first-classed on this struct (e.g. the *_gte / *_lte range filters on the numeric metrics).

Implementations§

Source§

impl ListBudgetAccountsOptions

Source

pub fn builder() -> ListBudgetAccountsOptionsBuilder

Create an instance of ListBudgetAccountsOptions using the builder syntax

Trait Implementations§

Source§

impl Clone for ListBudgetAccountsOptions

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ListBudgetAccountsOptions

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ListBudgetAccountsOptions

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Eq for ListBudgetAccountsOptions

Source§

impl PartialEq for ListBudgetAccountsOptions

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ListBudgetAccountsOptions

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> MaybeSendSync for T

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more