Struct QueryParams

pub struct QueryParams {
    pub count: Option<i32>,
    pub end_time: Option<i32>,
    pub page: Option<i32>,
    pub page_size: Option<i32>,
    pub total_count_required: Option<bool>,
    pub sort_by: Option<String>,
    pub sort_order: Option<String>,
    pub start_id: Option<String>,
    pub start_index: Option<i32>,
    pub start_time: Option<String>,
}

For most REST GET calls, you can include one or more query parameters on the request URI to filter, limit the size of, and sort the data in an API response. For filter parameters, see the individual GET calls. To limit, or page, and sort the data that is returned in some API responses, use these, or similar, query parameters:

Fields

count: Option<i32>

The number of items to list in the response.

end_time: Option<i32>

The end date and time for the range to show in the response, in Internet date and time format. For example, end_time=2016-03-06T11:00:00Z.

page: Option<i32>

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.

page_size: Option<i32>

The number of items to return in the response.

total_count_required: Option<bool>

Indicates whether to show the total count in the response.

sort_by: Option<String>

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

sort_order: Option<String>

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

start_id: Option<String>

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.

start_index: Option<i32>

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.

start_time: Option<String>

The start date and time for the range to show in the response, in Internet date and time format. For example, start_time=2016-03-06T11:00:00Z.

Implementations

impl QueryParams

pub fn new() -> Self

pub const fn count(self, count: i32) -> Self

pub const fn end_time(self, end_time: i32) -> Self

pub const fn page(self, page: i32) -> Self

pub const fn page_size(self, page_size: i32) -> Self

pub const fn total_count_required(self, total_count_required: bool) -> Self

pub fn sort_by(self, sort_by: String) -> Self

pub fn sort_order(self, sort_order: String) -> Self

pub fn start_id(self, start_id: String) -> Self

pub const fn start_index(self, start_index: i32) -> Self

pub fn start_time(self, start_time: String) -> Self

Trait Implementations

impl Clone for QueryParams

fn clone(&self) -> QueryParams

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for QueryParams

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

Formats the value using the given formatter.

impl Default for QueryParams

fn default() -> QueryParams

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for QueryParams

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for QueryParams

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

where __S: Serializer,

Serialize this value into the given Serde serializer.