Struct Datastream

pub struct Datastream { /* private fields */ }

Implements a client for the Datastream API.

Example

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

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

impl Datastream

pub fn builder() -> ClientBuilder

Returns a builder for Datastream.

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

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.

pub fn list_connection_profiles( &self, parent: impl Into<String>, ) -> ListConnectionProfiles

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

pub fn get_connection_profile( &self, name: impl Into<String>, ) -> GetConnectionProfile

Use this method to get details about a connection profile.

pub fn create_connection_profile( &self, parent: impl Into<String>, ) -> 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.

pub fn update_connection_profile( &self, connection_profile: impl Into<ConnectionProfile>, ) -> 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.

pub fn delete_connection_profile( &self, name: impl Into<String>, ) -> 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.

pub fn discover_connection_profile( &self, parent: impl Into<String>, ) -> 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.

pub fn list_streams(&self, parent: impl Into<String>) -> ListStreams

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

pub fn get_stream(&self, name: impl Into<String>) -> GetStream

Use this method to get details about a stream.

pub fn create_stream(&self, parent: impl Into<String>) -> 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.

pub fn update_stream(&self, stream: impl Into<Stream>) -> 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.

pub fn delete_stream(&self, name: impl Into<String>) -> 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.

pub fn run_stream(&self, name: impl Into<String>) -> 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.

pub fn get_stream_object(&self, name: impl Into<String>) -> GetStreamObject

Use this method to get details about a stream object.

pub fn lookup_stream_object( &self, parent: impl Into<String>, ) -> LookupStreamObject

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

pub fn list_stream_objects( &self, parent: impl Into<String>, ) -> ListStreamObjects

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

pub fn start_backfill_job(&self, object: impl Into<String>) -> StartBackfillJob

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

pub fn stop_backfill_job(&self, object: impl Into<String>) -> StopBackfillJob

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

pub fn fetch_static_ips(&self, name: impl Into<String>) -> FetchStaticIps

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

pub fn create_private_connection( &self, parent: impl Into<String>, ) -> 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.

pub fn get_private_connection( &self, name: impl Into<String>, ) -> GetPrivateConnection

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

pub fn list_private_connections( &self, parent: impl Into<String>, ) -> ListPrivateConnections

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

pub fn delete_private_connection( &self, name: impl Into<String>, ) -> 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.

pub fn create_route(&self, parent: impl Into<String>) -> 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.

pub fn get_route(&self, name: impl Into<String>) -> GetRoute

Use this method to get details about a route.

pub fn list_routes(&self, parent: impl Into<String>) -> ListRoutes

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

pub fn delete_route(&self, name: impl Into<String>) -> 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.

pub fn list_locations(&self, name: impl Into<String>) -> ListLocations

Lists information about the supported locations for this service.

pub fn get_location(&self, name: impl Into<String>) -> GetLocation

Gets information about a location.

pub fn list_operations(&self, name: impl Into<String>) -> ListOperations

Provides the Operations service functionality in this service.

pub fn get_operation(&self, name: impl Into<String>) -> GetOperation

Provides the Operations service functionality in this service.

pub fn delete_operation(&self, name: impl Into<String>) -> DeleteOperation

Provides the Operations service functionality in this service.

pub fn cancel_operation(&self, name: impl Into<String>) -> CancelOperation

Provides the Operations service functionality in this service.

Trait Implementations

impl Clone for Datastream

fn clone(&self) -> Datastream

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Datastream

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

Formats the value using the given formatter.