Skip to main content

ConnectionService

Struct ConnectionService 

Source
pub struct ConnectionService { /* private fields */ }
Expand description

Implements a client for the BigQuery Connection API.

§Example

use google_cloud_gax::paginator::ItemPaginator as _;
    let client = ConnectionService::builder().build().await?;
    let parent = "parent_value";
    let mut list = client.list_connections()
        .set_parent(parent)
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }

§Service Description

Manages external data source connections and credentials.

§Configuration

To configure ConnectionService use the with_* methods in the type returned by builder(). The default configuration should work for most applications. Common configuration changes include

  • with_endpoint(): by default this client uses the global default endpoint (https://bigqueryconnection.googleapis.com). Applications using regional endpoints or running in restricted networks (e.g. a network configured override this default.
  • with_credentials(): by default this client uses Application Default Credentials. Applications using custom authentication may need to override this default.

§Pooling and Cloning

ConnectionService holds a connection pool internally, it is advised to create one and reuse it. You do not need to wrap ConnectionService in an Rc or Arc to reuse it, because it already uses an Arc internally.

Implementations§

Source§

impl ConnectionService

Source

pub fn builder() -> ClientBuilder

Returns a builder for ConnectionService.

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

pub fn from_stub<T>(stub: T) -> Self
where T: ConnectionService + 'static,

Creates a new client from the provided stub.

The most common case for calling this function is in tests mocking the client’s behavior.

Source

pub fn create_connection(&self) -> CreateConnection

Creates a new connection.

§Example
use google_cloud_bigquery_connection_v1::model::Connection;
use google_cloud_bigquery_connection_v1::Result;
async fn sample(
   client: &ConnectionService, parent: &str
) -> Result<()> {
    let response = client.create_connection()
        .set_parent(parent)
        .set_connection_id("connection_id_value")
        .set_connection(
            Connection::new()/* set fields */
        )
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn get_connection(&self) -> GetConnection

Returns specified connection.

§Example
use google_cloud_bigquery_connection_v1::Result;
async fn sample(
   client: &ConnectionService, name: &str
) -> Result<()> {
    let response = client.get_connection()
        .set_name(name)
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn list_connections(&self) -> ListConnections

Returns a list of connections in the given project.

§Example
use google_cloud_gax::paginator::ItemPaginator as _;
use google_cloud_bigquery_connection_v1::Result;
async fn sample(
   client: &ConnectionService, parent: &str
) -> Result<()> {
    let mut list = client.list_connections()
        .set_parent(parent)
        .by_item();
    while let Some(item) = list.next().await.transpose()? {
        println!("{:?}", item);
    }
    Ok(())
}
Source

pub fn update_connection(&self) -> UpdateConnection

Updates the specified connection. For security reasons, also resets credential if connection properties are in the update field mask.

§Example
use google_cloud_wkt::FieldMask;
use google_cloud_bigquery_connection_v1::model::Connection;
use google_cloud_bigquery_connection_v1::Result;
async fn sample(
   client: &ConnectionService, name: &str
) -> Result<()> {
    let response = client.update_connection()
        .set_connection(
            Connection::new().set_name(name)/* set fields */
        )
        .set_update_mask(FieldMask::default().set_paths(["updated.field.path1", "updated.field.path2"]))
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn delete_connection(&self) -> DeleteConnection

Deletes connection and associated credential.

§Example
use google_cloud_bigquery_connection_v1::Result;
async fn sample(
   client: &ConnectionService, name: &str
) -> Result<()> {
    client.delete_connection()
        .set_name(name)
        .send().await?;
    Ok(())
}
Source

pub fn get_iam_policy(&self) -> GetIamPolicy

Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.

§Example
use google_cloud_bigquery_connection_v1::Result;
async fn sample(
   client: &ConnectionService
) -> Result<()> {
    let response = client.get_iam_policy()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn set_iam_policy(&self) -> SetIamPolicy

Sets the access control policy on the specified resource. Replaces any existing policy.

Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.

§Example
use google_cloud_bigquery_connection_v1::Result;
async fn sample(
   client: &ConnectionService
) -> Result<()> {
    let response = client.set_iam_policy()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}
Source

pub fn test_iam_permissions(&self) -> TestIamPermissions

Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a NOT_FOUND error.

Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may “fail open” without warning.

§Example
use google_cloud_bigquery_connection_v1::Result;
async fn sample(
   client: &ConnectionService
) -> Result<()> {
    let response = client.test_iam_permissions()
        /* set fields */
        .send().await?;
    println!("response {:?}", response);
    Ok(())
}

Trait Implementations§

Source§

impl Clone for ConnectionService

Source§

fn clone(&self) -> ConnectionService

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ConnectionService

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more