Struct ClientBuilder 

pub struct ClientBuilder { /* private fields */ }

A builder for BigQuery.

Example

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

Implementations

impl ClientBuilder

pub fn new() -> Self

Creates a new default ClientBuilder.

pub fn with_project_id<V: Into<String>>(self, project_id: V) -> Self

Sets the default Google Cloud project ID for the client.

Example

let client = BigQuery::builder()
    .with_project_id("my-project-id")
    .build()
    .await?;

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

Sets the BigQuery v2 API endpoint.

Example

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

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

Configure the authentication credentials.

Most Google Cloud services require authentication, though some services allow for anonymous access, and some services provide emulators where no authentication is required. 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 = BigQuery::builder()
    .with_credentials(
        mds::Builder::default()
            .with_scopes(["https://www.googleapis.com/auth/cloud-platform.read-only"])
            .build()?)
    .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 = BigQuery::builder()
    .with_universe_domain("googleapis.com")
    .build()
    .await?;

pub fn with_tracing(self) -> Self

Enables tracing.

The client libraries can be dynamically instrumented with the Tokio tracing framework. Setting this flag enables this instrumentation.

Example

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

pub fn with_retry_policy<V: Into<RetryPolicyArg>>(self, v: V) -> Self

Configure the retry policy.

The client libraries can automatically retry operations that fail. The retry policy controls what errors are considered retryable, sets limits on the number of attempts or the time trying to make attempts.

Example

use google_cloud_bigquery::query::retry_policy::RetryableErrors;
use google_cloud_gax::retry_policy::RetryPolicyExt;
let client = BigQuery::builder()
    .with_retry_policy(RetryableErrors.with_attempt_limit(3))
    .build()
    .await?;

pub fn with_backoff_policy<V: Into<BackoffPolicyArg>>(self, v: V) -> Self

Configure the retry backoff policy.

The client libraries can automatically retry operations that fail. The backoff policy controls how long to wait in between retry attempts.

Example

use google_cloud_gax::exponential_backoff::ExponentialBackoff;
use std::time::Duration;
let policy = ExponentialBackoff::default();
let client = BigQuery::builder()
    .with_backoff_policy(policy)
    .build()
    .await?;

pub async fn build(self) -> Result<BigQuery>

Creates a new BigQuery client.

Example

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

Trait Implementations

impl Clone for ClientBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ClientBuilder

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

Formats the value using the given formatter.

impl Default for ClientBuilder

fn default() -> Self

Returns the “default value” for a type.