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
impl Datastream
Sourcepub fn builder() -> ClientBuilder
pub fn builder() -> ClientBuilder
Returns a builder for Datastream.
let client = Datastream::builder().build().await?;
Sourcepub fn from_stub<T>(stub: T) -> Selfwhere
T: Datastream + 'static,
pub fn from_stub<T>(stub: T) -> Selfwhere
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.
Sourcepub fn list_connection_profiles(&self) -> ListConnectionProfiles
pub fn list_connection_profiles(&self) -> ListConnectionProfiles
Use this method to list connection profiles created in a project and location.
Sourcepub fn get_connection_profile(&self) -> GetConnectionProfile
pub fn get_connection_profile(&self) -> GetConnectionProfile
Use this method to get details about a connection profile.
Sourcepub fn create_connection_profile(&self) -> CreateConnectionProfile
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.
Sourcepub fn update_connection_profile(&self) -> UpdateConnectionProfile
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.
Sourcepub fn delete_connection_profile(&self) -> DeleteConnectionProfile
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.
Sourcepub fn discover_connection_profile(&self) -> DiscoverConnectionProfile
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.
Sourcepub fn list_streams(&self) -> ListStreams
pub fn list_streams(&self) -> ListStreams
Use this method to list streams in a project and location.
Sourcepub fn get_stream(&self) -> GetStream
pub fn get_stream(&self) -> GetStream
Use this method to get details about a stream.
Sourcepub fn create_stream(&self) -> CreateStream
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.
Sourcepub fn update_stream(&self) -> UpdateStream
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.
Sourcepub fn delete_stream(&self) -> DeleteStream
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.
Sourcepub fn run_stream(&self) -> RunStream
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.
Sourcepub fn get_stream_object(&self) -> GetStreamObject
pub fn get_stream_object(&self) -> GetStreamObject
Use this method to get details about a stream object.
Sourcepub fn lookup_stream_object(&self) -> LookupStreamObject
pub fn lookup_stream_object(&self) -> LookupStreamObject
Use this method to look up a stream object by its source object identifier.
Sourcepub fn list_stream_objects(&self) -> ListStreamObjects
pub fn list_stream_objects(&self) -> ListStreamObjects
Use this method to list the objects of a specific stream.
Sourcepub fn start_backfill_job(&self) -> StartBackfillJob
pub fn start_backfill_job(&self) -> StartBackfillJob
Use this method to start a backfill job for the specified stream object.
Sourcepub fn stop_backfill_job(&self) -> StopBackfillJob
pub fn stop_backfill_job(&self) -> StopBackfillJob
Use this method to stop a backfill job for the specified stream object.
Sourcepub fn fetch_static_ips(&self) -> FetchStaticIps
pub fn fetch_static_ips(&self) -> FetchStaticIps
The FetchStaticIps API call exposes the static IP addresses used by Datastream.
Sourcepub fn create_private_connection(&self) -> CreatePrivateConnection
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.
Sourcepub fn get_private_connection(&self) -> GetPrivateConnection
pub fn get_private_connection(&self) -> GetPrivateConnection
Use this method to get details about a private connectivity configuration.
Sourcepub fn list_private_connections(&self) -> ListPrivateConnections
pub fn list_private_connections(&self) -> ListPrivateConnections
Use this method to list private connectivity configurations in a project and location.
Sourcepub fn delete_private_connection(&self) -> DeletePrivateConnection
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.
Sourcepub fn create_route(&self) -> CreateRoute
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.
Sourcepub fn list_routes(&self) -> ListRoutes
pub fn list_routes(&self) -> ListRoutes
Use this method to list routes created for a private connectivity configuration in a project and location.
Sourcepub fn delete_route(&self) -> DeleteRoute
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.
Sourcepub fn list_locations(&self) -> ListLocations
pub fn list_locations(&self) -> ListLocations
Lists information about the supported locations for this service.
Sourcepub fn get_location(&self) -> GetLocation
pub fn get_location(&self) -> GetLocation
Gets information about a location.
Sourcepub fn list_operations(&self) -> ListOperations
pub fn list_operations(&self) -> ListOperations
Provides the Operations service functionality in this service.
Sourcepub fn get_operation(&self) -> GetOperation
pub fn get_operation(&self) -> GetOperation
Provides the Operations service functionality in this service.
Sourcepub fn delete_operation(&self) -> DeleteOperation
pub fn delete_operation(&self) -> DeleteOperation
Provides the Operations service functionality in this service.
Sourcepub fn cancel_operation(&self) -> CancelOperation
pub fn cancel_operation(&self) -> CancelOperation
Provides the Operations service functionality in this service.
Trait Implementations§
Source§impl Clone for Datastream
impl Clone for Datastream
Source§fn clone(&self) -> Datastream
fn clone(&self) -> Datastream
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more