Struct GraphClientConfiguration

pub struct GraphClientConfiguration { /* private fields */ }

Implementations

impl GraphClientConfiguration

pub fn new() -> GraphClientConfiguration

pub fn access_token<AT: ToString>( self, access_token: AT, ) -> GraphClientConfiguration

pub fn client_application<CA: ClientApplication + 'static>( self, client_app: CA, ) -> Self

pub fn default_headers(self, headers: HeaderMap) -> GraphClientConfiguration

pub fn referer(self, enable: bool) -> GraphClientConfiguration

Enable or disable automatic setting of the Referer header.

Default is true.

pub fn timeout(self, timeout: Duration) -> GraphClientConfiguration

Enables a request timeout.

The timeout is applied from when the request starts connecting until the response body has finished.

Default is no timeout.

pub fn connect_timeout(self, timeout: Duration) -> GraphClientConfiguration

Set a timeout for only the connect phase of a Client.

Default is None.

Note

This requires the futures be executed in a tokio runtime with a tokio timer enabled.

pub fn connection_verbose(self, verbose: bool) -> GraphClientConfiguration

Set whether connections should emit verbose logs.

Enabling this option will emit log messages at the TRACE level for read and write operations on connections.

pub fn user_agent(self, value: HeaderValue) -> GraphClientConfiguration

pub fn min_tls_version(self, version: Version) -> GraphClientConfiguration

TLS 1.2 required to support all features in Microsoft Graph See Reliability and Support

pub fn proxy(self, proxy: Proxy) -> GraphClientConfiguration

Set Proxy for all network operations.

Default is no proxy.

pub fn https_only(self, https_only: bool) -> GraphClientConfiguration

pub fn retry(self, retry: Option<usize>) -> GraphClientConfiguration

Enable a request retry for a failed request. The retry parameter can be used to change how many times the request should be retried.

Some requests may fail on GraphAPI side and should be retried. Only server errors (HTTP code between 500 and 599) will be retried.

Default is no retry.

pub fn wait_for_retry_after_headers( self, retry: bool, ) -> GraphClientConfiguration

Enable a request retry if we reach the throttling limits and GraphAPI returns a 429 Too Many Requests with a Retry-After header

Retry attempts are executed when the response has a status code of 429, 500, 503, 504 and the response has a Retry-After header. The Retry-After header provides a back-off time to wait for before retrying the request again.

Be careful with this parameter as some API endpoints have quite low limits (reports for example) and the request may hang for hundreds of seconds. For maximum throughput you may want to not respect the Retry-After header as hitting another server thanks to load-balancing may lead to a successful response.

Default is no retry.

pub fn concurrency_limit( self, concurrency_limit: Option<usize>, ) -> GraphClientConfiguration

Enable a concurrency limit on the client.

Every request through this client will be subject to a concurrency limit. Can be useful to stay under the API limits set by GraphAPI.

Default is no concurrency limit.

Trait Implementations

impl Clone for GraphClientConfiguration

fn clone(&self) -> GraphClientConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphClientConfiguration

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

Formats the value using the given formatter.

impl Default for GraphClientConfiguration

fn default() -> Self

Returns the “default value” for a type.

impl From<GraphClientConfiguration> for Client

fn from(value: GraphClientConfiguration) -> Self

Converts to this type from the input type.

impl From<GraphClientConfiguration> for MinimalAsyncClient

fn from(value: GraphClientConfiguration) -> Self

Converts to this type from the input type.

impl From<GraphClientConfiguration> for MinimalBlockingClient

fn from(value: GraphClientConfiguration) -> Self

Converts to this type from the input type.

impl PartialEq for GraphClientConfiguration

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