Datastream

import { Datastream } from "https://googleapis.deno.dev/v1/datastream:v1.ts";

class Datastream {

constructor(client?: CredentialsClient, baseUrl?: string);

locations;

async projectsLocationsConnectionProfilesCreate(

parent: string,

req: ConnectionProfile,

opts?: ProjectsLocationsConnectionProfilesCreateOptions,

): Promise<Operation>;

async projectsLocationsConnectionProfilesDelete(name: string, opts?: ProjectsLocationsConnectionProfilesDeleteOptions): Promise<Operation>;

async projectsLocationsConnectionProfilesDiscover(parent: string, req: DiscoverConnectionProfileRequest): Promise<DiscoverConnectionProfileResponse>;

async projectsLocationsConnectionProfilesGet(name: string): Promise<ConnectionProfile>;

async projectsLocationsConnectionProfilesList(parent: string, opts?: ProjectsLocationsConnectionProfilesListOptions): Promise<ListConnectionProfilesResponse>;

async projectsLocationsConnectionProfilesPatch(

name: string,

req: ConnectionProfile,

opts?: ProjectsLocationsConnectionProfilesPatchOptions,

): Promise<Operation>;

async projectsLocationsFetchStaticIps(name: string, opts?: ProjectsLocationsFetchStaticIpsOptions): Promise<FetchStaticIpsResponse>;

async projectsLocationsGet(name: string): Promise<Location>;

async projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>;

async projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>;

async projectsLocationsOperationsDelete(name: string): Promise<Empty>;

async projectsLocationsOperationsGet(name: string): Promise<Operation>;

async projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>;

async projectsLocationsPrivateConnectionsCreate(

parent: string,

req: PrivateConnection,

opts?: ProjectsLocationsPrivateConnectionsCreateOptions,

): Promise<Operation>;

async projectsLocationsPrivateConnectionsDelete(name: string, opts?: ProjectsLocationsPrivateConnectionsDeleteOptions): Promise<Operation>;

async projectsLocationsPrivateConnectionsGet(name: string): Promise<PrivateConnection>;

async projectsLocationsPrivateConnectionsList(parent: string, opts?: ProjectsLocationsPrivateConnectionsListOptions): Promise<ListPrivateConnectionsResponse>;

async projectsLocationsPrivateConnectionsRoutesCreate(

parent: string,

req: Route,

opts?: ProjectsLocationsPrivateConnectionsRoutesCreateOptions,

): Promise<Operation>;

async projectsLocationsPrivateConnectionsRoutesDelete(name: string, opts?: ProjectsLocationsPrivateConnectionsRoutesDeleteOptions): Promise<Operation>;

async projectsLocationsPrivateConnectionsRoutesGet(name: string): Promise<Route>;

async projectsLocationsPrivateConnectionsRoutesList(parent: string, opts?: ProjectsLocationsPrivateConnectionsRoutesListOptions): Promise<ListRoutesResponse>;

async projectsLocationsStreamsCreate(

parent: string,

req: Stream,

opts?: ProjectsLocationsStreamsCreateOptions,

): Promise<Operation>;

async projectsLocationsStreamsDelete(name: string, opts?: ProjectsLocationsStreamsDeleteOptions): Promise<Operation>;

async projectsLocationsStreamsGet(name: string): Promise<Stream>;

async projectsLocationsStreamsList(parent: string, opts?: ProjectsLocationsStreamsListOptions): Promise<ListStreamsResponse>;

async projectsLocationsStreamsObjectsGet(name: string): Promise<StreamObject>;

async projectsLocationsStreamsObjectsList(parent: string, opts?: ProjectsLocationsStreamsObjectsListOptions): Promise<ListStreamObjectsResponse>;

async projectsLocationsStreamsObjectsLookup(parent: string, req: LookupStreamObjectRequest): Promise<StreamObject>;

async projectsLocationsStreamsObjectsStartBackfillJob(object: string, req: StartBackfillJobRequest): Promise<StartBackfillJobResponse>;

async projectsLocationsStreamsObjectsStopBackfillJob(object: string, req: StopBackfillJobRequest): Promise<StopBackfillJobResponse>;

async projectsLocationsStreamsPatch(

name: string,

req: Stream,

opts?: ProjectsLocationsStreamsPatchOptions,

): Promise<Operation>;

async projectsLocationsStreamsRun(name: string, req: RunStreamRequest): Promise<Operation>;

}

§Constructors

new Datastream(client?: CredentialsClient, baseUrl?: string)

[src]

§Properties

locations

[src]

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.

locations

[src]

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

§Methods

projectsLocationsConnectionProfilesCreate(parent: string, req: ConnectionProfile, opts?: ProjectsLocationsConnectionProfilesCreateOptions): Promise<Operation>

[src]

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

@param parent

Required. The parent that owns the collection of ConnectionProfiles.

projectsLocationsConnectionProfilesDelete(name: string, opts?: ProjectsLocationsConnectionProfilesDeleteOptions): Promise<Operation>

[src]

Use this method to delete a connection profile.

@param name

Required. The name of the connection profile resource to delete.

projectsLocationsConnectionProfilesDiscover(parent: string, req: DiscoverConnectionProfileRequest): Promise<DiscoverConnectionProfileResponse>

[src]

projectsLocationsConnectionProfilesGet(name: string): Promise<ConnectionProfile>

[src]

Use this method to get details about a connection profile.

@param name

Required. The name of the connection profile resource to get.

projectsLocationsConnectionProfilesList(parent: string, opts?: ProjectsLocationsConnectionProfilesListOptions): Promise<ListConnectionProfilesResponse>

[src]

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

@param parent

Required. The parent that owns the collection of connection profiles.

projectsLocationsConnectionProfilesPatch(name: string, req: ConnectionProfile, opts?: ProjectsLocationsConnectionProfilesPatchOptions): Promise<Operation>

[src]

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

@param name

Output only. The resource's name.

projectsLocationsFetchStaticIps(name: string, opts?: ProjectsLocationsFetchStaticIpsOptions): Promise<FetchStaticIpsResponse>

[src]

projectsLocationsGet(name: string): Promise<Location>

[src]

Gets information about a location.

@param name

Resource name for the location.

projectsLocationsList(name: string, opts?: ProjectsLocationsListOptions): Promise<ListLocationsResponse>

[src]

Lists information about the supported locations for this service.

@param name

The resource that owns the locations collection, if applicable.

projectsLocationsOperationsCancel(name: string, req: CancelOperationRequest): Promise<Empty>

[src]

Starts asynchronous cancellation on a long-running operation. The server makes a best effort to cancel the operation, but success is not guaranteed. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED. Clients can use Operations.GetOperation or other methods to check whether the cancellation succeeded or whether the operation completed despite cancellation. On successful cancellation, the operation is not deleted; instead, it becomes an operation with an Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

@param name

The name of the operation resource to be cancelled.

projectsLocationsOperationsDelete(name: string): Promise<Empty>

[src]

Deletes a long-running operation. This method indicates that the client is no longer interested in the operation result. It does not cancel the operation. If the server doesn't support this method, it returns google.rpc.Code.UNIMPLEMENTED.

@param name

The name of the operation resource to be deleted.

projectsLocationsOperationsGet(name: string): Promise<Operation>

[src]

Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.

@param name

The name of the operation resource.

projectsLocationsOperationsList(name: string, opts?: ProjectsLocationsOperationsListOptions): Promise<ListOperationsResponse>

[src]

Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED.

@param name

The name of the operation's parent resource.

projectsLocationsPrivateConnectionsCreate(parent: string, req: PrivateConnection, opts?: ProjectsLocationsPrivateConnectionsCreateOptions): Promise<Operation>

[src]

Use this method to create a private connectivity configuration.

@param parent

Required. The parent that owns the collection of PrivateConnections.

projectsLocationsPrivateConnectionsDelete(name: string, opts?: ProjectsLocationsPrivateConnectionsDeleteOptions): Promise<Operation>

[src]

Use this method to delete a private connectivity configuration.

@param name

Required. The name of the private connectivity configuration to delete.

projectsLocationsPrivateConnectionsGet(name: string): Promise<PrivateConnection>

[src]

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

@param name

Required. The name of the private connectivity configuration to get.

projectsLocationsPrivateConnectionsList(parent: string, opts?: ProjectsLocationsPrivateConnectionsListOptions): Promise<ListPrivateConnectionsResponse>

[src]

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

@param parent

Required. The parent that owns the collection of private connectivity configurations.

projectsLocationsPrivateConnectionsRoutesCreate(parent: string, req: Route, opts?: ProjectsLocationsPrivateConnectionsRoutesCreateOptions): Promise<Operation>

[src]

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

@param parent

Required. The parent that owns the collection of Routes.

projectsLocationsPrivateConnectionsRoutesDelete(name: string, opts?: ProjectsLocationsPrivateConnectionsRoutesDeleteOptions): Promise<Operation>

[src]

Use this method to delete a route.

@param name

Required. The name of the Route resource to delete.

projectsLocationsPrivateConnectionsRoutesGet(name: string): Promise<Route>

[src]

Use this method to get details about a route.

@param name

Required. The name of the Route resource to get.

projectsLocationsPrivateConnectionsRoutesList(parent: string, opts?: ProjectsLocationsPrivateConnectionsRoutesListOptions): Promise<ListRoutesResponse>

[src]

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

@param parent

Required. The parent that owns the collection of Routess.

projectsLocationsStreamsCreate(parent: string, req: Stream, opts?: ProjectsLocationsStreamsCreateOptions): Promise<Operation>

[src]

Use this method to create a stream.

@param parent

Required. The parent that owns the collection of streams.

projectsLocationsStreamsDelete(name: string, opts?: ProjectsLocationsStreamsDeleteOptions): Promise<Operation>

[src]

Use this method to delete a stream.

@param name

Required. The name of the stream resource to delete.

projectsLocationsStreamsGet(name: string): Promise<Stream>

[src]

Use this method to get details about a stream.

@param name

Required. The name of the stream resource to get.

projectsLocationsStreamsList(parent: string, opts?: ProjectsLocationsStreamsListOptions): Promise<ListStreamsResponse>

[src]

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

@param parent

Required. The parent that owns the collection of streams.

projectsLocationsStreamsObjectsGet(name: string): Promise<StreamObject>

[src]

Use this method to get details about a stream object.

@param name

Required. The name of the stream object resource to get.

projectsLocationsStreamsObjectsList(parent: string, opts?: ProjectsLocationsStreamsObjectsListOptions): Promise<ListStreamObjectsResponse>

[src]

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

@param parent

Required. The parent stream that owns the collection of objects.

projectsLocationsStreamsObjectsLookup(parent: string, req: LookupStreamObjectRequest): Promise<StreamObject>

[src]

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

@param parent

Required. The parent stream that owns the collection of objects.

projectsLocationsStreamsObjectsStartBackfillJob(object: string, req: StartBackfillJobRequest): Promise<StartBackfillJobResponse>

[src]

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

@param object

Required. The name of the stream object resource to start a backfill job for.

projectsLocationsStreamsObjectsStopBackfillJob(object: string, req: StopBackfillJobRequest): Promise<StopBackfillJobResponse>

[src]

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

@param object

Required. The name of the stream object resource to stop the backfill job for.

projectsLocationsStreamsPatch(name: string, req: Stream, opts?: ProjectsLocationsStreamsPatchOptions): Promise<Operation>

[src]

Use this method to update the configuration of a stream.

@param name

Output only. The stream's name.

projectsLocationsStreamsRun(name: string, req: RunStreamRequest): Promise<Operation>

[src]

Use this method to start, resume or recover a stream with a non default CDC strategy. NOTE: This feature is currently experimental.

@param name

Required. Name of the stream resource to start, in the format: projects/{project_id}/locations/{location}/streams/{stream_name}