Struct pinata_sdk::PinListFilterBuilder

pub struct PinListFilterBuilder { /* fields omitted */ }

Builder for PinListFilter.

Methods

impl PinListFilterBuilder

pub fn set_hash_contains(&mut self, value: String) -> &mut Self

Filter on alphanumeric characters inside of pin hashes. Hashes which do not include the characters passed in will not be returned

pub fn set_pin_start(&mut self, value: String) -> &mut Self

Exclude pin records that were pinned before the passed in "pinStart" datetime (must be in ISO_8601 format)

pub fn set_pin_end(&mut self, value: String) -> &mut Self

(must be in ISO_8601 format) - Exclude pin records that were pinned after the passed in "pinEnd" datetime

pub fn set_unpin_start(&mut self, value: String) -> &mut Self

(must be in ISO_8601 format) - Exclude pin records that were unpinned before the passed in "unpinStart" datetime

pub fn set_unpin_end(&mut self, value: String) -> &mut Self

(must be in ISO_8601 format) - Exclude pin records that were unpinned after the passed in "unpinEnd" datetime

pub fn set_pin_size_min(&mut self, value: usize) -> &mut Self

The minimum byte size that pin record you're looking for can have

pub fn set_pin_size_max(&mut self, value: usize) -> &mut Self

The maximum byte size that pin record you're looking for can have

pub fn set_status(&mut self, value: PinListFilterStatus) -> &mut Self

The status of pin lists results

pub fn set_metadata(&mut self, value: HashMap<String, String>) -> &mut Self

Filter on metadata name or metadata keyvalues. If specifying a metadata[keyvalues] filter, you need to ensure that you encode the values as the recommended JSON accordingly. See the pinata docs here under the 'Metadata Querying' section for more details.

pub fn set_page_limit(&mut self, value: String) -> &mut Self

This sets the amount of records that will be returned per API response. (Max 1000)

pub fn set_page_offset(&mut self, value: String) -> &mut Self

This tells the API how far to offset the record responses. For example, if there's 30 records that match your query, and you passed in a pageLimit of 10, providing a pageOffset of 10 would return records 11-20

pub fn build(&self) -> Result<PinListFilter, String>

Builds a new PinListFilter.

Errors

If a required field has not been initialized.

Trait Implementations

impl Clone for PinListFilterBuilder

fn clone(&self) -> PinListFilterBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for PinListFilterBuilder

fn default() -> PinListFilterBuilder

Returns the "default value" for a type.