Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

A builder for Write.

Example

let builder = Write::builder();
let client = builder
    .with_endpoint("https://bigquerystorage.googleapis.com")
    .build()
    .await?;

Implementations

impl ClientBuilder

pub async fn build(self) -> BuilderResult<Write>

Creates a new client.

Example

let client = Write::builder().build().await?;

pub fn with_endpoint<V: Into<String>>(self, v: V) -> Self

Sets the endpoint.

Example

let client = Write::builder()
    .with_endpoint("https://private.googleapis.com")
    .build()
    .await?;

pub fn with_universe_domain<V: Into<String>>(self, v: V) -> Self

Configure the universe domain.

The universe domain is the default service domain for a given cloud universe. The default value is “googleapis.com”.

Example

let client = Write::builder()
    .with_universe_domain("googleapis.com")
    .build()
    .await?;

pub fn with_credentials<V: Into<Credentials>>(self, v: V) -> Self

Configures the authentication credentials.

More information about valid credentials types can be found in the google-cloud-auth crate documentation.

Example

use google_cloud_auth::credentials::mds;
let client = Write::builder()
    .with_credentials(
        mds::Builder::default()
            .with_scopes(["https://www.googleapis.com/auth/bigquery"])
            .build()?)
    .build()
    .await?;

pub fn with_grpc_subchannel_count(self, v: usize) -> Self

Configure the number of subchannels used by the client.

Example

let count = std::thread::available_parallelism()?.get();
let client = Write::builder()
    .with_grpc_subchannel_count(count)
    .build()
    .await?;

gRPC-based clients may exhibit high latency if many requests need to be demuxed over a single HTTP/2 connection (often called a subchannel in gRPC).

Consider using more subchannels if your application creates many writers. Consider using fewer subchannels if your application needs the file descriptors for other purposes.

pub fn with_pool_size_limit(self, v: usize) -> Self

Configure the maximum streams in the client’s multiplexed stream pool.

Example

let count = std::thread::available_parallelism()?.get();
let client = Write::builder()
    .with_pool_size_limit(count)
    .build()
    .await?;

This stream pool is shared by default writers with multiplexing enabled.

The client scales the stream pool up to this limit as the streams in the pool encounter load.

Note that until background stream rebalancing (#6866) is implemented, stream assignment and pool scale-up only occur when a writer is built. If multiple writers are created all at once before writes are in flight, they will all share the same initial stream. To scale across multiple streams, stagger writer creation so writes are in flight when new writers are built.

The default is 8 streams.

Trait Implementations

impl Debug for ClientBuilder

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

Formats the value using the given formatter.