Datastream

Struct Datastream 

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

Implements a client for the Datastream API.

§Example

let client = Datastream::builder().build().await?;
// use `client` to make requests to the Datastream API.

§Service Description

Datastream service

§Configuration

To configure Datastream 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://datastream.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

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

Implementations§

Source§

impl Datastream

Source

pub fn builder() -> ClientBuilder

Returns a builder for Datastream.

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

pub fn from_stub<T>(stub: T) -> Self
where T: Datastream + '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 list_connection_profiles(&self) -> ListConnectionProfiles

Use this method to list connection profiles created in a project and location.

Source

pub fn get_connection_profile(&self) -> GetConnectionProfile

Use this method to get details about a connection profile.

Source

pub fn create_connection_profile(&self) -> CreateConnectionProfile

Use this method to create a connection profile in a project and location.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn update_connection_profile(&self) -> UpdateConnectionProfile

Use this method to update the parameters of a connection profile.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn delete_connection_profile(&self) -> DeleteConnectionProfile

Use this method to delete a connection profile.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn discover_connection_profile(&self) -> DiscoverConnectionProfile

Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects of a parent data object that’s optionally supplied in the request.

Source

pub fn list_streams(&self) -> ListStreams

Use this method to list streams in a project and location.

Source

pub fn get_stream(&self) -> GetStream

Use this method to get details about a stream.

Source

pub fn create_stream(&self) -> CreateStream

Use this method to create a stream.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn update_stream(&self) -> UpdateStream

Use this method to update the configuration of a stream.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn delete_stream(&self) -> DeleteStream

Use this method to delete a stream.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn run_stream(&self) -> RunStream

Use this method to start, resume or recover a stream with a non default CDC strategy.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn get_stream_object(&self) -> GetStreamObject

Use this method to get details about a stream object.

Source

pub fn lookup_stream_object(&self) -> LookupStreamObject

Use this method to look up a stream object by its source object identifier.

Source

pub fn list_stream_objects(&self) -> ListStreamObjects

Use this method to list the objects of a specific stream.

Source

pub fn start_backfill_job(&self) -> StartBackfillJob

Use this method to start a backfill job for the specified stream object.

Source

pub fn stop_backfill_job(&self) -> StopBackfillJob

Use this method to stop a backfill job for the specified stream object.

Source

pub fn fetch_static_ips(&self) -> FetchStaticIps

The FetchStaticIps API call exposes the static IP addresses used by Datastream.

Source

pub fn create_private_connection(&self) -> CreatePrivateConnection

Use this method to create a private connectivity configuration.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn get_private_connection(&self) -> GetPrivateConnection

Use this method to get details about a private connectivity configuration.

Source

pub fn list_private_connections(&self) -> ListPrivateConnections

Use this method to list private connectivity configurations in a project and location.

Source

pub fn delete_private_connection(&self) -> DeletePrivateConnection

Use this method to delete a private connectivity configuration.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn create_route(&self) -> CreateRoute

Use this method to create a route for a private connectivity configuration in a project and location.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn get_route(&self) -> GetRoute

Use this method to get details about a route.

Source

pub fn list_routes(&self) -> ListRoutes

Use this method to list routes created for a private connectivity configuration in a project and location.

Source

pub fn delete_route(&self) -> DeleteRoute

Use this method to delete a route.

§Long running operations

This method is used to start, and/or poll a long-running Operation. The Working with long-running operations chapter in the user guide covers these operations in detail.

Source

pub fn list_locations(&self) -> ListLocations

Lists information about the supported locations for this service.

Source

pub fn get_location(&self) -> GetLocation

Gets information about a location.

Source

pub fn list_operations(&self) -> ListOperations

Provides the Operations service functionality in this service.

Source

pub fn get_operation(&self) -> GetOperation

Provides the Operations service functionality in this service.

Source

pub fn delete_operation(&self) -> DeleteOperation

Provides the Operations service functionality in this service.

Source

pub fn cancel_operation(&self) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations§

Source§

impl Clone for Datastream

Source§

fn clone(&self) -> Datastream

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 Datastream

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> 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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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
Source§

impl<T> ErasedDestructor for T
where T: 'static,