Struct QueryBuilder

pub struct QueryBuilder { /* private fields */ }

Builder for Query.

Implementations

impl QueryBuilder

pub fn count(&mut self, value: Option<i32>) -> &mut Self

The number of items to list in the response.

pub fn end_time(&mut self, value: Option<DateTime<Utc>>) -> &mut Self

The end date and time for the range to show in the response.

pub fn page(&mut self, value: Option<i32>) -> &mut Self

The page number indicating which set of items will be returned in the response. So, the combination of page=1 and page_size=20 returns the first 20 items. The combination of page=2 and page_size=20 returns items 21 through 40.

pub fn page_size(&mut self, value: Option<i32>) -> &mut Self

The number of items to return in the response.

pub fn total_count_required(&mut self, value: Option<bool>) -> &mut Self

Indicates whether to show the total count in the response.

pub fn sort_by(&mut self, value: Option<String>) -> &mut Self

Sorts the payments in the response by a specified value, such as the create time or update time.

pub fn sort_order(&mut self, value: Option<String>) -> &mut Self

Sorts the items in the response in ascending or descending order.

pub fn start_id(&mut self, value: Option<String>) -> &mut Self

The ID of the starting resource in the response. When results are paged, you can use the next_id value as the start_id to continue with the next set of results.

pub fn start_index(&mut self, value: Option<i32>) -> &mut Self

The start index of the payments to list. Typically, you use the start_index to jump to a specific position in the resource history based on its cart. For example, to start at the second item in a list of results, specify start_index=2.

pub fn start_time(&mut self, value: Option<DateTime<Utc>>) -> &mut Self

The start date and time for the range to show in the response.

pub fn build(&self) -> Result<Query, QueryBuilderError>

Builds a new Query.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for QueryBuilder

fn clone(&self) -> QueryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for QueryBuilder

fn default() -> Self

Returns the “default value” for a type.