Class protos.google.cloud.datastream.v1alpha1.Datastream (3.1.0)

Version latest

• 3.1.0 (latest)
• 2.2.2
• 2.1.2
• 1.1.0
• 1.0.0
• 0.2.0

Represents a Datastream

Inheritance

$protobuf.rpc.Service > protos.google.cloud.datastream.v1alpha1.Datastream

Package

@google-cloud/datastream

Constructors

(constructor)(rpcImpl, requestDelimited, responseDelimited)

constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);

Constructs a new Datastream service.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Methods

create(rpcImpl, requestDelimited, responseDelimited)

public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): Datastream;

Creates new Datastream service using the specified rpc implementation.

Parameters
Name	Description
rpcImpl	$protobuf.RPCImpl RPC implementation
requestDelimited	boolean Whether requests are length-delimited
responseDelimited	boolean Whether responses are length-delimited

Returns
Type	Description
Datastream	RPC service. Useful where requests and/or responses are streamed.

createConnectionProfile(request, callback)

public createConnectionProfile(request: google.cloud.datastream.v1alpha1.ICreateConnectionProfileRequest, callback: google.cloud.datastream.v1alpha1.Datastream.CreateConnectionProfileCallback): void;

Calls CreateConnectionProfile.

Parameters
Name	Description
request	ICreateConnectionProfileRequest CreateConnectionProfileRequest message or plain object
callback	CreateConnectionProfileCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createConnectionProfile(request)

public createConnectionProfile(request: google.cloud.datastream.v1alpha1.ICreateConnectionProfileRequest): Promise<google.longrunning.Operation>;

Calls CreateConnectionProfile.

Parameter
Name	Description
request	ICreateConnectionProfileRequest CreateConnectionProfileRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createPrivateConnection(request, callback)

public createPrivateConnection(request: google.cloud.datastream.v1alpha1.ICreatePrivateConnectionRequest, callback: google.cloud.datastream.v1alpha1.Datastream.CreatePrivateConnectionCallback): void;

Calls CreatePrivateConnection.

Parameters
Name	Description
request	ICreatePrivateConnectionRequest CreatePrivateConnectionRequest message or plain object
callback	CreatePrivateConnectionCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createPrivateConnection(request)

public createPrivateConnection(request: google.cloud.datastream.v1alpha1.ICreatePrivateConnectionRequest): Promise<google.longrunning.Operation>;

Calls CreatePrivateConnection.

Parameter
Name	Description
request	ICreatePrivateConnectionRequest CreatePrivateConnectionRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createRoute(request, callback)

public createRoute(request: google.cloud.datastream.v1alpha1.ICreateRouteRequest, callback: google.cloud.datastream.v1alpha1.Datastream.CreateRouteCallback): void;

Calls CreateRoute.

Parameters
Name	Description
request	ICreateRouteRequest CreateRouteRequest message or plain object
callback	CreateRouteCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createRoute(request)

public createRoute(request: google.cloud.datastream.v1alpha1.ICreateRouteRequest): Promise<google.longrunning.Operation>;

Calls CreateRoute.

Parameter
Name	Description
request	ICreateRouteRequest CreateRouteRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

createStream(request, callback)

public createStream(request: google.cloud.datastream.v1alpha1.ICreateStreamRequest, callback: google.cloud.datastream.v1alpha1.Datastream.CreateStreamCallback): void;

Calls CreateStream.

Parameters
Name	Description
request	ICreateStreamRequest CreateStreamRequest message or plain object
callback	CreateStreamCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

createStream(request)

public createStream(request: google.cloud.datastream.v1alpha1.ICreateStreamRequest): Promise<google.longrunning.Operation>;

Calls CreateStream.

Parameter
Name	Description
request	ICreateStreamRequest CreateStreamRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteConnectionProfile(request, callback)

public deleteConnectionProfile(request: google.cloud.datastream.v1alpha1.IDeleteConnectionProfileRequest, callback: google.cloud.datastream.v1alpha1.Datastream.DeleteConnectionProfileCallback): void;

Calls DeleteConnectionProfile.

Parameters
Name	Description
request	IDeleteConnectionProfileRequest DeleteConnectionProfileRequest message or plain object
callback	DeleteConnectionProfileCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteConnectionProfile(request)

public deleteConnectionProfile(request: google.cloud.datastream.v1alpha1.IDeleteConnectionProfileRequest): Promise<google.longrunning.Operation>;

Calls DeleteConnectionProfile.

Parameter
Name	Description
request	IDeleteConnectionProfileRequest DeleteConnectionProfileRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deletePrivateConnection(request, callback)

public deletePrivateConnection(request: google.cloud.datastream.v1alpha1.IDeletePrivateConnectionRequest, callback: google.cloud.datastream.v1alpha1.Datastream.DeletePrivateConnectionCallback): void;

Calls DeletePrivateConnection.

Parameters
Name	Description
request	IDeletePrivateConnectionRequest DeletePrivateConnectionRequest message or plain object
callback	DeletePrivateConnectionCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deletePrivateConnection(request)

public deletePrivateConnection(request: google.cloud.datastream.v1alpha1.IDeletePrivateConnectionRequest): Promise<google.longrunning.Operation>;

Calls DeletePrivateConnection.

Parameter
Name	Description
request	IDeletePrivateConnectionRequest DeletePrivateConnectionRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteRoute(request, callback)

public deleteRoute(request: google.cloud.datastream.v1alpha1.IDeleteRouteRequest, callback: google.cloud.datastream.v1alpha1.Datastream.DeleteRouteCallback): void;

Calls DeleteRoute.

Parameters
Name	Description
request	IDeleteRouteRequest DeleteRouteRequest message or plain object
callback	DeleteRouteCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteRoute(request)

public deleteRoute(request: google.cloud.datastream.v1alpha1.IDeleteRouteRequest): Promise<google.longrunning.Operation>;

Calls DeleteRoute.

Parameter
Name	Description
request	IDeleteRouteRequest DeleteRouteRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

deleteStream(request, callback)

public deleteStream(request: google.cloud.datastream.v1alpha1.IDeleteStreamRequest, callback: google.cloud.datastream.v1alpha1.Datastream.DeleteStreamCallback): void;

Calls DeleteStream.

Parameters
Name	Description
request	IDeleteStreamRequest DeleteStreamRequest message or plain object
callback	DeleteStreamCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

deleteStream(request)

public deleteStream(request: google.cloud.datastream.v1alpha1.IDeleteStreamRequest): Promise<google.longrunning.Operation>;

Calls DeleteStream.

Parameter
Name	Description
request	IDeleteStreamRequest DeleteStreamRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

discoverConnectionProfile(request, callback)

public discoverConnectionProfile(request: google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest, callback: google.cloud.datastream.v1alpha1.Datastream.DiscoverConnectionProfileCallback): void;

Calls DiscoverConnectionProfile.

Parameters
Name	Description
request	IDiscoverConnectionProfileRequest DiscoverConnectionProfileRequest message or plain object
callback	DiscoverConnectionProfileCallback Node-style callback called with the error, if any, and DiscoverConnectionProfileResponse

Returns
Type	Description
void

discoverConnectionProfile(request)

public discoverConnectionProfile(request: google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest): Promise<google.cloud.datastream.v1alpha1.DiscoverConnectionProfileResponse>;

Calls DiscoverConnectionProfile.

Parameter
Name	Description
request	IDiscoverConnectionProfileRequest DiscoverConnectionProfileRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.DiscoverConnectionProfileResponse>	Promise

fetchErrors(request, callback)

public fetchErrors(request: google.cloud.datastream.v1alpha1.IFetchErrorsRequest, callback: google.cloud.datastream.v1alpha1.Datastream.FetchErrorsCallback): void;

Calls FetchErrors.

Parameters
Name	Description
request	IFetchErrorsRequest FetchErrorsRequest message or plain object
callback	FetchErrorsCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

fetchErrors(request)

public fetchErrors(request: google.cloud.datastream.v1alpha1.IFetchErrorsRequest): Promise<google.longrunning.Operation>;

Calls FetchErrors.

Parameter
Name	Description
request	IFetchErrorsRequest FetchErrorsRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

fetchStaticIps(request, callback)

public fetchStaticIps(request: google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest, callback: google.cloud.datastream.v1alpha1.Datastream.FetchStaticIpsCallback): void;

Calls FetchStaticIps.

Parameters
Name	Description
request	IFetchStaticIpsRequest FetchStaticIpsRequest message or plain object
callback	FetchStaticIpsCallback Node-style callback called with the error, if any, and FetchStaticIpsResponse

Returns
Type	Description
void

fetchStaticIps(request)

public fetchStaticIps(request: google.cloud.datastream.v1alpha1.IFetchStaticIpsRequest): Promise<google.cloud.datastream.v1alpha1.FetchStaticIpsResponse>;

Calls FetchStaticIps.

Parameter
Name	Description
request	IFetchStaticIpsRequest FetchStaticIpsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.FetchStaticIpsResponse>	Promise

getConnectionProfile(request, callback)

public getConnectionProfile(request: google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest, callback: google.cloud.datastream.v1alpha1.Datastream.GetConnectionProfileCallback): void;

Calls GetConnectionProfile.

Parameters
Name	Description
request	IGetConnectionProfileRequest GetConnectionProfileRequest message or plain object
callback	GetConnectionProfileCallback Node-style callback called with the error, if any, and ConnectionProfile

Returns
Type	Description
void

getConnectionProfile(request)

public getConnectionProfile(request: google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest): Promise<google.cloud.datastream.v1alpha1.ConnectionProfile>;

Calls GetConnectionProfile.

Parameter
Name	Description
request	IGetConnectionProfileRequest GetConnectionProfileRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.ConnectionProfile>	Promise

getPrivateConnection(request, callback)

public getPrivateConnection(request: google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest, callback: google.cloud.datastream.v1alpha1.Datastream.GetPrivateConnectionCallback): void;

Calls GetPrivateConnection.

Parameters
Name	Description
request	IGetPrivateConnectionRequest GetPrivateConnectionRequest message or plain object
callback	GetPrivateConnectionCallback Node-style callback called with the error, if any, and PrivateConnection

Returns
Type	Description
void

getPrivateConnection(request)

public getPrivateConnection(request: google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest): Promise<google.cloud.datastream.v1alpha1.PrivateConnection>;

Calls GetPrivateConnection.

Parameter
Name	Description
request	IGetPrivateConnectionRequest GetPrivateConnectionRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.PrivateConnection>	Promise

getRoute(request, callback)

public getRoute(request: google.cloud.datastream.v1alpha1.IGetRouteRequest, callback: google.cloud.datastream.v1alpha1.Datastream.GetRouteCallback): void;

Calls GetRoute.

Parameters
Name	Description
request	IGetRouteRequest GetRouteRequest message or plain object
callback	GetRouteCallback Node-style callback called with the error, if any, and Route

Returns
Type	Description
void

getRoute(request)

public getRoute(request: google.cloud.datastream.v1alpha1.IGetRouteRequest): Promise<google.cloud.datastream.v1alpha1.Route>;

Calls GetRoute.

Parameter
Name	Description
request	IGetRouteRequest GetRouteRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.Route>	Promise

getStream(request, callback)

public getStream(request: google.cloud.datastream.v1alpha1.IGetStreamRequest, callback: google.cloud.datastream.v1alpha1.Datastream.GetStreamCallback): void;

Calls GetStream.

Parameters
Name	Description
request	IGetStreamRequest GetStreamRequest message or plain object
callback	GetStreamCallback Node-style callback called with the error, if any, and Stream

Returns
Type	Description
void

getStream(request)

public getStream(request: google.cloud.datastream.v1alpha1.IGetStreamRequest): Promise<google.cloud.datastream.v1alpha1.Stream>;

Calls GetStream.

Parameter
Name	Description
request	IGetStreamRequest GetStreamRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.Stream>	Promise

listConnectionProfiles(request, callback)

public listConnectionProfiles(request: google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest, callback: google.cloud.datastream.v1alpha1.Datastream.ListConnectionProfilesCallback): void;

Calls ListConnectionProfiles.

Parameters
Name	Description
request	IListConnectionProfilesRequest ListConnectionProfilesRequest message or plain object
callback	ListConnectionProfilesCallback Node-style callback called with the error, if any, and ListConnectionProfilesResponse

Returns
Type	Description
void

listConnectionProfiles(request)

public listConnectionProfiles(request: google.cloud.datastream.v1alpha1.IListConnectionProfilesRequest): Promise<google.cloud.datastream.v1alpha1.ListConnectionProfilesResponse>;

Calls ListConnectionProfiles.

Parameter
Name	Description
request	IListConnectionProfilesRequest ListConnectionProfilesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.ListConnectionProfilesResponse>	Promise

listPrivateConnections(request, callback)

public listPrivateConnections(request: google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest, callback: google.cloud.datastream.v1alpha1.Datastream.ListPrivateConnectionsCallback): void;

Calls ListPrivateConnections.

Parameters
Name	Description
request	IListPrivateConnectionsRequest ListPrivateConnectionsRequest message or plain object
callback	ListPrivateConnectionsCallback Node-style callback called with the error, if any, and ListPrivateConnectionsResponse

Returns
Type	Description
void

listPrivateConnections(request)

public listPrivateConnections(request: google.cloud.datastream.v1alpha1.IListPrivateConnectionsRequest): Promise<google.cloud.datastream.v1alpha1.ListPrivateConnectionsResponse>;

Calls ListPrivateConnections.

Parameter
Name	Description
request	IListPrivateConnectionsRequest ListPrivateConnectionsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.ListPrivateConnectionsResponse>	Promise

listRoutes(request, callback)

public listRoutes(request: google.cloud.datastream.v1alpha1.IListRoutesRequest, callback: google.cloud.datastream.v1alpha1.Datastream.ListRoutesCallback): void;

Calls ListRoutes.

Parameters
Name	Description
request	IListRoutesRequest ListRoutesRequest message or plain object
callback	ListRoutesCallback Node-style callback called with the error, if any, and ListRoutesResponse

Returns
Type	Description
void

listRoutes(request)

public listRoutes(request: google.cloud.datastream.v1alpha1.IListRoutesRequest): Promise<google.cloud.datastream.v1alpha1.ListRoutesResponse>;

Calls ListRoutes.

Parameter
Name	Description
request	IListRoutesRequest ListRoutesRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.ListRoutesResponse>	Promise

listStreams(request, callback)

public listStreams(request: google.cloud.datastream.v1alpha1.IListStreamsRequest, callback: google.cloud.datastream.v1alpha1.Datastream.ListStreamsCallback): void;

Calls ListStreams.

Parameters
Name	Description
request	IListStreamsRequest ListStreamsRequest message or plain object
callback	ListStreamsCallback Node-style callback called with the error, if any, and ListStreamsResponse

Returns
Type	Description
void

listStreams(request)

public listStreams(request: google.cloud.datastream.v1alpha1.IListStreamsRequest): Promise<google.cloud.datastream.v1alpha1.ListStreamsResponse>;

Calls ListStreams.

Parameter
Name	Description
request	IListStreamsRequest ListStreamsRequest message or plain object

Returns
Type	Description
Promise<google.cloud.datastream.v1alpha1.ListStreamsResponse>	Promise

updateConnectionProfile(request, callback)

public updateConnectionProfile(request: google.cloud.datastream.v1alpha1.IUpdateConnectionProfileRequest, callback: google.cloud.datastream.v1alpha1.Datastream.UpdateConnectionProfileCallback): void;

Calls UpdateConnectionProfile.

Parameters
Name	Description
request	IUpdateConnectionProfileRequest UpdateConnectionProfileRequest message or plain object
callback	UpdateConnectionProfileCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateConnectionProfile(request)

public updateConnectionProfile(request: google.cloud.datastream.v1alpha1.IUpdateConnectionProfileRequest): Promise<google.longrunning.Operation>;

Calls UpdateConnectionProfile.

Parameter
Name	Description
request	IUpdateConnectionProfileRequest UpdateConnectionProfileRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise

updateStream(request, callback)

public updateStream(request: google.cloud.datastream.v1alpha1.IUpdateStreamRequest, callback: google.cloud.datastream.v1alpha1.Datastream.UpdateStreamCallback): void;

Calls UpdateStream.

Parameters
Name	Description
request	IUpdateStreamRequest UpdateStreamRequest message or plain object
callback	UpdateStreamCallback Node-style callback called with the error, if any, and Operation

Returns
Type	Description
void

updateStream(request)

public updateStream(request: google.cloud.datastream.v1alpha1.IUpdateStreamRequest): Promise<google.longrunning.Operation>;

Calls UpdateStream.

Parameter
Name	Description
request	IUpdateStreamRequest UpdateStreamRequest message or plain object

Returns
Type	Description
Promise<google.longrunning.Operation>	Promise