Struct WorkspaceListBuilder

pub struct WorkspaceListBuilder { /* private fields */ }

Builder for WorkspaceListRequest.

Implementations

impl WorkspaceListBuilder

pub fn include_archived<VALUE: Into<bool>>(self, value: VALUE) -> Self

Whether to include workspaces that have been archived in the response

pub fn before_id<VALUE: Into<String>>(self, value: VALUE) -> Self

ID of the object to use as a cursor for pagination (previous page)

pub fn after_id<VALUE: Into<String>>(self, value: VALUE) -> Self

ID of the object to use as a cursor for pagination (next page)

pub fn limit<VALUE: Into<u32>>(self, value: VALUE) -> Self

Number of items to return per page (1-1000)

pub fn credentials<VALUE: Into<Credentials>>(self, value: VALUE) -> Self

Credentials for authentication (not serialized)

pub fn build(self) -> Result<WorkspaceListRequest, WorkspaceListBuilderError>

Builds a new WorkspaceListRequest.

Errors

If a required field has not been initialized.

impl WorkspaceListBuilder

pub async fn create(self) -> ApiResponseOrError<WorkspaceList>

Creates a new workspace list request and returns the response.

This is a convenience method that builds the request from the builder and sends it to the Workspaces API.

Example

let credentials = Credentials::from_env();

let workspaces = WorkspaceList::builder()
    .credentials(credentials)
    .limit(10u32)
    .create()
    .await?;

Trait Implementations

impl Clone for WorkspaceListBuilder

fn clone(&self) -> WorkspaceListBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkspaceListBuilder

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

Formats the value using the given formatter.

impl Default for WorkspaceListBuilder

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for WorkspaceListBuilder

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