DataStream v1 API - Class Datastream.DatastreamBase (2.4.0)

Version 2.4.0

• 2.7.0 (latest)
• 2.6.0
• 2.5.0
• 2.4.0
• 2.3.0
• 2.2.0
• 2.1.0
• 2.0.0
• 1.0.0

[BindServiceMethod(typeof(Datastream), "BindService")]
public abstract class Datastream.DatastreamBase

Reference documentation and code samples for the DataStream v1 API class Datastream.DatastreamBase.

Base class for server-side implementations of Datastream

Inheritance

object > Datastream.DatastreamBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Datastream.V1

Assembly

Google.Cloud.Datastream.V1.dll

Methods

CreateConnectionProfile(CreateConnectionProfileRequest, ServerCallContext)

public virtual Task<Operation> CreateConnectionProfile(CreateConnectionProfileRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateConnectionProfileRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreatePrivateConnection(CreatePrivateConnectionRequest, ServerCallContext)

public virtual Task<Operation> CreatePrivateConnection(CreatePrivateConnectionRequest request, ServerCallContext context)

Use this method to create a private connectivity configuration.

Parameters
Name	Description
request	CreatePrivateConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateRoute(CreateRouteRequest, ServerCallContext)

public virtual Task<Operation> CreateRoute(CreateRouteRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	CreateRouteRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

CreateStream(CreateStreamRequest, ServerCallContext)

public virtual Task<Operation> CreateStream(CreateStreamRequest request, ServerCallContext context)

Use this method to create a stream.

Parameters
Name	Description
request	CreateStreamRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteConnectionProfile(DeleteConnectionProfileRequest, ServerCallContext)

public virtual Task<Operation> DeleteConnectionProfile(DeleteConnectionProfileRequest request, ServerCallContext context)

Use this method to delete a connection profile.

Parameters
Name	Description
request	DeleteConnectionProfileRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeletePrivateConnection(DeletePrivateConnectionRequest, ServerCallContext)

public virtual Task<Operation> DeletePrivateConnection(DeletePrivateConnectionRequest request, ServerCallContext context)

Use this method to delete a private connectivity configuration.

Parameters
Name	Description
request	DeletePrivateConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteRoute(DeleteRouteRequest, ServerCallContext)

public virtual Task<Operation> DeleteRoute(DeleteRouteRequest request, ServerCallContext context)

Use this method to delete a route.

Parameters
Name	Description
request	DeleteRouteRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteStream(DeleteStreamRequest, ServerCallContext)

public virtual Task<Operation> DeleteStream(DeleteStreamRequest request, ServerCallContext context)

Use this method to delete a stream.

Parameters
Name	Description
request	DeleteStreamRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DiscoverConnectionProfile(DiscoverConnectionProfileRequest, ServerCallContext)

public virtual Task<DiscoverConnectionProfileResponse> DiscoverConnectionProfile(DiscoverConnectionProfileRequest request, ServerCallContext context)

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.

Parameters
Name	Description
request	DiscoverConnectionProfileRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskDiscoverConnectionProfileResponse	The response to send back to the client (wrapped by a task).

FetchStaticIps(FetchStaticIpsRequest, ServerCallContext)

public virtual Task<FetchStaticIpsResponse> FetchStaticIps(FetchStaticIpsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	FetchStaticIpsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskFetchStaticIpsResponse	The response to send back to the client (wrapped by a task).

GetConnectionProfile(GetConnectionProfileRequest, ServerCallContext)

public virtual Task<ConnectionProfile> GetConnectionProfile(GetConnectionProfileRequest request, ServerCallContext context)

Use this method to get details about a connection profile.

Parameters
Name	Description
request	GetConnectionProfileRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskConnectionProfile	The response to send back to the client (wrapped by a task).

GetPrivateConnection(GetPrivateConnectionRequest, ServerCallContext)

public virtual Task<PrivateConnection> GetPrivateConnection(GetPrivateConnectionRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	GetPrivateConnectionRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskPrivateConnection	The response to send back to the client (wrapped by a task).

GetRoute(GetRouteRequest, ServerCallContext)

public virtual Task<Route> GetRoute(GetRouteRequest request, ServerCallContext context)

Use this method to get details about a route.

Parameters
Name	Description
request	GetRouteRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskRoute	The response to send back to the client (wrapped by a task).

GetStream(GetStreamRequest, ServerCallContext)

public virtual Task<Stream> GetStream(GetStreamRequest request, ServerCallContext context)

Use this method to get details about a stream.

Parameters
Name	Description
request	GetStreamRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskStream	The response to send back to the client (wrapped by a task).

GetStreamObject(GetStreamObjectRequest, ServerCallContext)

public virtual Task<StreamObject> GetStreamObject(GetStreamObjectRequest request, ServerCallContext context)

Use this method to get details about a stream object.

Parameters
Name	Description
request	GetStreamObjectRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskStreamObject	The response to send back to the client (wrapped by a task).

ListConnectionProfiles(ListConnectionProfilesRequest, ServerCallContext)

public virtual Task<ListConnectionProfilesResponse> ListConnectionProfiles(ListConnectionProfilesRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListConnectionProfilesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListConnectionProfilesResponse	The response to send back to the client (wrapped by a task).

ListPrivateConnections(ListPrivateConnectionsRequest, ServerCallContext)

public virtual Task<ListPrivateConnectionsResponse> ListPrivateConnections(ListPrivateConnectionsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListPrivateConnectionsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListPrivateConnectionsResponse	The response to send back to the client (wrapped by a task).

ListRoutes(ListRoutesRequest, ServerCallContext)

public virtual Task<ListRoutesResponse> ListRoutes(ListRoutesRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListRoutesRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListRoutesResponse	The response to send back to the client (wrapped by a task).

ListStreamObjects(ListStreamObjectsRequest, ServerCallContext)

public virtual Task<ListStreamObjectsResponse> ListStreamObjects(ListStreamObjectsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListStreamObjectsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListStreamObjectsResponse	The response to send back to the client (wrapped by a task).

ListStreams(ListStreamsRequest, ServerCallContext)

public virtual Task<ListStreamsResponse> ListStreams(ListStreamsRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	ListStreamsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListStreamsResponse	The response to send back to the client (wrapped by a task).

LookupStreamObject(LookupStreamObjectRequest, ServerCallContext)

public virtual Task<StreamObject> LookupStreamObject(LookupStreamObjectRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	LookupStreamObjectRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskStreamObject	The response to send back to the client (wrapped by a task).

StartBackfillJob(StartBackfillJobRequest, ServerCallContext)

public virtual Task<StartBackfillJobResponse> StartBackfillJob(StartBackfillJobRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	StartBackfillJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskStartBackfillJobResponse	The response to send back to the client (wrapped by a task).

StopBackfillJob(StopBackfillJobRequest, ServerCallContext)

public virtual Task<StopBackfillJobResponse> StopBackfillJob(StopBackfillJobRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	StopBackfillJobRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskStopBackfillJobResponse	The response to send back to the client (wrapped by a task).

UpdateConnectionProfile(UpdateConnectionProfileRequest, ServerCallContext)

public virtual Task<Operation> UpdateConnectionProfile(UpdateConnectionProfileRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	UpdateConnectionProfileRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

UpdateStream(UpdateStreamRequest, ServerCallContext)

public virtual Task<Operation> UpdateStream(UpdateStreamRequest request, ServerCallContext context)

Use this method to update the configuration of a stream.

Parameters
Name	Description
request	UpdateStreamRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).