@google-cloud/datastream
Version:
datastream client for Node.js
704 lines • 102 kB
TypeScript
import type * as gax from 'google-gax';
import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback } from 'google-gax';
import { Transform } from 'stream';
import * as protos from '../../protos/protos';
/**
* Datastream service
* @class
* @memberof v1alpha1
*/
export declare class DatastreamClient {
private _terminated;
private _opts;
private _providedCustomServicePath;
private _gaxModule;
private _gaxGrpc;
private _protos;
private _defaults;
private _universeDomain;
private _servicePath;
private _log;
auth: gax.GoogleAuth;
descriptors: Descriptors;
warn: (code: string, message: string, warnType?: string) => void;
innerApiCalls: {
[name: string]: Function;
};
pathTemplates: {
[name: string]: gax.PathTemplate;
};
operationsClient: gax.OperationsClient;
datastreamStub?: Promise<{
[name: string]: Function;
}>;
/**
* Construct an instance of DatastreamClient.
*
* @param {object} [options] - The configuration object.
* The options accepted by the constructor are described in detail
* in [this document](https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#creating-the-client-instance).
* The common options are:
* @param {object} [options.credentials] - Credentials object.
* @param {string} [options.credentials.client_email]
* @param {string} [options.credentials.private_key]
* @param {string} [options.email] - Account email address. Required when
* using a .pem or .p12 keyFilename.
* @param {string} [options.keyFilename] - Full path to the a .json, .pem, or
* .p12 key downloaded from the Google Developers Console. If you provide
* a path to a JSON file, the projectId option below is not necessary.
* NOTE: .pem and .p12 require you to specify options.email as well.
* @param {number} [options.port] - The port on which to connect to
* the remote host.
* @param {string} [options.projectId] - The project ID from the Google
* Developer's Console, e.g. 'grape-spaceship-123'. We will also check
* the environment variable GCLOUD_PROJECT for your project ID. If your
* app is running in an environment which supports
* {@link https://cloud.google.com/docs/authentication/application-default-credentials Application Default Credentials},
* your project ID will be detected automatically.
* @param {string} [options.apiEndpoint] - The domain name of the
* API remote host.
* @param {gax.ClientConfig} [options.clientConfig] - Client configuration override.
* Follows the structure of {@link gapicConfig}.
* @param {boolean} [options.fallback] - Use HTTP/1.1 REST mode.
* For more information, please check the
* {@link https://github.com/googleapis/gax-nodejs/blob/main/client-libraries.md#http11-rest-api-mode documentation}.
* @param {gax} [gaxInstance]: loaded instance of `google-gax`. Useful if you
* need to avoid loading the default gRPC version and want to use the fallback
* HTTP implementation. Load only fallback version and pass it to the constructor:
* ```
* const gax = require('google-gax/build/src/fallback'); // avoids loading google-gax with gRPC
* const client = new DatastreamClient({fallback: true}, gax);
* ```
*/
constructor(opts?: ClientOptions, gaxInstance?: typeof gax | typeof gax.fallback);
/**
* Initialize the client.
* Performs asynchronous operations (such as authentication) and prepares the client.
* This function will be called automatically when any class method is called for the
* first time, but if you need to initialize it before calling an actual method,
* feel free to call initialize() directly.
*
* You can await on this method if you want to make sure the client is initialized.
*
* @returns {Promise} A promise that resolves to an authenticated service stub.
*/
initialize(): Promise<{
[name: string]: Function;
}>;
/**
* The DNS address for this API service.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get servicePath(): string;
/**
* The DNS address for this API service - same as servicePath.
* @deprecated Use the apiEndpoint method of the client instance.
* @returns {string} The DNS address for this service.
*/
static get apiEndpoint(): string;
/**
* The DNS address for this API service.
* @returns {string} The DNS address for this service.
*/
get apiEndpoint(): string;
get universeDomain(): string;
/**
* The port for this API service.
* @returns {number} The default port for this service.
*/
static get port(): number;
/**
* The scopes needed to make gRPC calls for every method defined
* in this service.
* @returns {string[]} List of default scopes.
*/
static get scopes(): string[];
getProjectId(): Promise<string>;
getProjectId(callback: Callback<string, undefined, undefined>): void;
/**
* Use this method to get details about a connection profile.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the connection profile resource to get.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.datastream.v1alpha1.ConnectionProfile|ConnectionProfile}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.get_connection_profile.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_GetConnectionProfile_async
*/
getConnectionProfile(request?: protos.google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest, options?: CallOptions): Promise<[
protos.google.cloud.datastream.v1alpha1.IConnectionProfile,
protos.google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest | undefined,
{} | undefined
]>;
getConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.datastream.v1alpha1.IConnectionProfile, protos.google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
getConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest, callback: Callback<protos.google.cloud.datastream.v1alpha1.IConnectionProfile, protos.google.cloud.datastream.v1alpha1.IGetConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
/**
* 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 under a
* parent data object that's optionally supplied in the request.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent resource of the ConnectionProfile type. Must be in the
* format `projects/* /locations/*`.
* @param {google.cloud.datastream.v1alpha1.ConnectionProfile} request.connectionProfile
* An ad-hoc ConnectionProfile configuration.
* @param {string} request.connectionProfileName
* A reference to an existing ConnectionProfile.
* @param {boolean} request.recursive
* Whether to retrieve the full hierarchy of data objects (TRUE) or only the
* current level (FALSE).
* @param {number} request.recursionDepth
* The number of hierarchy levels below the current level to be retrieved.
* @param {google.cloud.datastream.v1alpha1.OracleRdbms} request.oracleRdbms
* Oracle RDBMS to enrich with child data objects and metadata.
* @param {google.cloud.datastream.v1alpha1.MysqlRdbms} request.mysqlRdbms
* MySQL RDBMS to enrich with child data objects and metadata.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.datastream.v1alpha1.DiscoverConnectionProfileResponse|DiscoverConnectionProfileResponse}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.discover_connection_profile.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_DiscoverConnectionProfile_async
*/
discoverConnectionProfile(request?: protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest, options?: CallOptions): Promise<[
protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileResponse,
protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest | undefined,
{} | undefined
]>;
discoverConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest, options: CallOptions, callback: Callback<protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileResponse, protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
discoverConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest, callback: Callback<protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileResponse, protos.google.cloud.datastream.v1alpha1.IDiscoverConnectionProfileRequest | null | undefined, {} | null | undefined>): void;
/**
* Use this method to get details about a stream.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the stream resource to get.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.datastream.v1alpha1.Stream|Stream}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.get_stream.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_GetStream_async
*/
getStream(request?: protos.google.cloud.datastream.v1alpha1.IGetStreamRequest, options?: CallOptions): Promise<[
protos.google.cloud.datastream.v1alpha1.IStream,
protos.google.cloud.datastream.v1alpha1.IGetStreamRequest | undefined,
{} | undefined
]>;
getStream(request: protos.google.cloud.datastream.v1alpha1.IGetStreamRequest, options: CallOptions, callback: Callback<protos.google.cloud.datastream.v1alpha1.IStream, protos.google.cloud.datastream.v1alpha1.IGetStreamRequest | null | undefined, {} | null | undefined>): void;
getStream(request: protos.google.cloud.datastream.v1alpha1.IGetStreamRequest, callback: Callback<protos.google.cloud.datastream.v1alpha1.IStream, protos.google.cloud.datastream.v1alpha1.IGetStreamRequest | null | undefined, {} | null | undefined>): void;
/**
* Use this method to get details about a private connectivity configuration.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the private connectivity configuration to get.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.datastream.v1alpha1.PrivateConnection|PrivateConnection}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.get_private_connection.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_GetPrivateConnection_async
*/
getPrivateConnection(request?: protos.google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest, options?: CallOptions): Promise<[
protos.google.cloud.datastream.v1alpha1.IPrivateConnection,
protos.google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest | undefined,
{} | undefined
]>;
getPrivateConnection(request: protos.google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest, options: CallOptions, callback: Callback<protos.google.cloud.datastream.v1alpha1.IPrivateConnection, protos.google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;
getPrivateConnection(request: protos.google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest, callback: Callback<protos.google.cloud.datastream.v1alpha1.IPrivateConnection, protos.google.cloud.datastream.v1alpha1.IGetPrivateConnectionRequest | null | undefined, {} | null | undefined>): void;
/**
* Use this method to get details about a route.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the Route resource to get.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing {@link protos.google.cloud.datastream.v1alpha1.Route|Route}.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.get_route.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_GetRoute_async
*/
getRoute(request?: protos.google.cloud.datastream.v1alpha1.IGetRouteRequest, options?: CallOptions): Promise<[
protos.google.cloud.datastream.v1alpha1.IRoute,
protos.google.cloud.datastream.v1alpha1.IGetRouteRequest | undefined,
{} | undefined
]>;
getRoute(request: protos.google.cloud.datastream.v1alpha1.IGetRouteRequest, options: CallOptions, callback: Callback<protos.google.cloud.datastream.v1alpha1.IRoute, protos.google.cloud.datastream.v1alpha1.IGetRouteRequest | null | undefined, {} | null | undefined>): void;
getRoute(request: protos.google.cloud.datastream.v1alpha1.IGetRouteRequest, callback: Callback<protos.google.cloud.datastream.v1alpha1.IRoute, protos.google.cloud.datastream.v1alpha1.IGetRouteRequest | null | undefined, {} | null | undefined>): void;
/**
* Use this method to create a connection profile in a project and location.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent that owns the collection of ConnectionProfiles.
* @param {string} request.connectionProfileId
* Required. The connection profile identifier.
* @param {google.cloud.datastream.v1alpha1.ConnectionProfile} request.connectionProfile
* Required. The connection profile resource to create.
* @param {string} [request.requestId]
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
*
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.create_connection_profile.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_CreateConnectionProfile_async
*/
createConnectionProfile(request?: protos.google.cloud.datastream.v1alpha1.ICreateConnectionProfileRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.datastream.v1alpha1.IConnectionProfile, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
createConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.ICreateConnectionProfileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IConnectionProfile, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
createConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.ICreateConnectionProfileRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IConnectionProfile, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `createConnectionProfile()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.create_connection_profile.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_CreateConnectionProfile_async
*/
checkCreateConnectionProfileProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1alpha1.ConnectionProfile, protos.google.cloud.datastream.v1alpha1.OperationMetadata>>;
/**
* Use this method to update the parameters of a connection profile.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.protobuf.FieldMask} [request.updateMask]
* Optional. Field mask is used to specify the fields to be overwritten in the
* ConnectionProfile resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
* @param {google.cloud.datastream.v1alpha1.ConnectionProfile} request.connectionProfile
* Required. The ConnectionProfile to update.
* @param {string} [request.requestId]
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
*
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.update_connection_profile.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_UpdateConnectionProfile_async
*/
updateConnectionProfile(request?: protos.google.cloud.datastream.v1alpha1.IUpdateConnectionProfileRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.datastream.v1alpha1.IConnectionProfile, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
updateConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.IUpdateConnectionProfileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IConnectionProfile, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
updateConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.IUpdateConnectionProfileRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IConnectionProfile, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `updateConnectionProfile()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.update_connection_profile.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_UpdateConnectionProfile_async
*/
checkUpdateConnectionProfileProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1alpha1.ConnectionProfile, protos.google.cloud.datastream.v1alpha1.OperationMetadata>>;
/**
* Use this method to delete a connection profile..
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the connection profile resource to delete.
* @param {string} [request.requestId]
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
*
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.delete_connection_profile.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_DeleteConnectionProfile_async
*/
deleteConnectionProfile(request?: protos.google.cloud.datastream.v1alpha1.IDeleteConnectionProfileRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.IDeleteConnectionProfileRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteConnectionProfile(request: protos.google.cloud.datastream.v1alpha1.IDeleteConnectionProfileRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deleteConnectionProfile()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.delete_connection_profile.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_DeleteConnectionProfile_async
*/
checkDeleteConnectionProfileProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datastream.v1alpha1.OperationMetadata>>;
/**
* Use this method to create a stream.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent that owns the collection of streams.
* @param {string} request.streamId
* Required. The stream identifier.
* @param {google.cloud.datastream.v1alpha1.Stream} request.stream
* Required. The stream resource to create.
* @param {string} [request.requestId]
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
*
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
* @param {boolean} [request.validateOnly]
* Optional. Only validate the stream, but do not create any resources.
* The default is false.
* @param {boolean} [request.force]
* Optional. Create the stream without validating it.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.create_stream.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_CreateStream_async
*/
createStream(request?: protos.google.cloud.datastream.v1alpha1.ICreateStreamRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.datastream.v1alpha1.IStream, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
createStream(request: protos.google.cloud.datastream.v1alpha1.ICreateStreamRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IStream, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
createStream(request: protos.google.cloud.datastream.v1alpha1.ICreateStreamRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IStream, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `createStream()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.create_stream.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_CreateStream_async
*/
checkCreateStreamProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1alpha1.Stream, protos.google.cloud.datastream.v1alpha1.OperationMetadata>>;
/**
* Use this method to update the configuration of a stream.
*
* @param {Object} request
* The request object that will be sent.
* @param {google.protobuf.FieldMask} [request.updateMask]
* Optional. Field mask is used to specify the fields to be overwritten in the
* stream resource by the update.
* The fields specified in the update_mask are relative to the resource, not
* the full request. A field will be overwritten if it is in the mask. If the
* user does not provide a mask then all fields will be overwritten.
* @param {google.cloud.datastream.v1alpha1.Stream} request.stream
* Required. The stream resource to update.
* @param {string} [request.requestId]
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
*
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
* @param {boolean} [request.validateOnly]
* Optional. Only validate the stream with the changes, without actually updating it.
* The default is false.
* @param {boolean} [request.force]
* Optional. Execute the update without validating it.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.update_stream.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_UpdateStream_async
*/
updateStream(request?: protos.google.cloud.datastream.v1alpha1.IUpdateStreamRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.datastream.v1alpha1.IStream, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
updateStream(request: protos.google.cloud.datastream.v1alpha1.IUpdateStreamRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IStream, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
updateStream(request: protos.google.cloud.datastream.v1alpha1.IUpdateStreamRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IStream, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `updateStream()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.update_stream.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_UpdateStream_async
*/
checkUpdateStreamProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1alpha1.Stream, protos.google.cloud.datastream.v1alpha1.OperationMetadata>>;
/**
* Use this method to delete a stream.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the stream resource to delete.
* @param {string} [request.requestId]
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
*
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.delete_stream.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_DeleteStream_async
*/
deleteStream(request?: protos.google.cloud.datastream.v1alpha1.IDeleteStreamRequest, options?: CallOptions): Promise<[
LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
deleteStream(request: protos.google.cloud.datastream.v1alpha1.IDeleteStreamRequest, options: CallOptions, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
deleteStream(request: protos.google.cloud.datastream.v1alpha1.IDeleteStreamRequest, callback: Callback<LROperation<protos.google.protobuf.IEmpty, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `deleteStream()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.delete_stream.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_DeleteStream_async
*/
checkDeleteStreamProgress(name: string): Promise<LROperation<protos.google.protobuf.Empty, protos.google.cloud.datastream.v1alpha1.OperationMetadata>>;
/**
* Use this method to fetch any errors associated with a stream.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.stream
* Name of the Stream resource for which to fetch any errors.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.fetch_errors.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_FetchErrors_async
*/
fetchErrors(request?: protos.google.cloud.datastream.v1alpha1.IFetchErrorsRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.datastream.v1alpha1.IFetchErrorsResponse, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
fetchErrors(request: protos.google.cloud.datastream.v1alpha1.IFetchErrorsRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IFetchErrorsResponse, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
fetchErrors(request: protos.google.cloud.datastream.v1alpha1.IFetchErrorsRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IFetchErrorsResponse, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `fetchErrors()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.fetch_errors.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_FetchErrors_async
*/
checkFetchErrorsProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1alpha1.FetchErrorsResponse, protos.google.cloud.datastream.v1alpha1.OperationMetadata>>;
/**
* Use this method to create a private connectivity configuration.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.parent
* Required. The parent that owns the collection of PrivateConnections.
* @param {string} request.privateConnectionId
* Required. The private connectivity identifier.
* @param {google.cloud.datastream.v1alpha1.PrivateConnection} request.privateConnection
* Required. The Private Connectivity resource to create.
* @param {string} [request.requestId]
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes since the first request.
*
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details.
* @returns {Promise} - The promise which resolves to an array.
* The first element of the array is an object representing
* a long running operation. Its `promise()` method returns a promise
* you can `await` for.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.create_private_connection.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_CreatePrivateConnection_async
*/
createPrivateConnection(request?: protos.google.cloud.datastream.v1alpha1.ICreatePrivateConnectionRequest, options?: CallOptions): Promise<[
LROperation<protos.google.cloud.datastream.v1alpha1.IPrivateConnection, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>,
protos.google.longrunning.IOperation | undefined,
{} | undefined
]>;
createPrivateConnection(request: protos.google.cloud.datastream.v1alpha1.ICreatePrivateConnectionRequest, options: CallOptions, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IPrivateConnection, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
createPrivateConnection(request: protos.google.cloud.datastream.v1alpha1.ICreatePrivateConnectionRequest, callback: Callback<LROperation<protos.google.cloud.datastream.v1alpha1.IPrivateConnection, protos.google.cloud.datastream.v1alpha1.IOperationMetadata>, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void;
/**
* Check the status of the long running operation returned by `createPrivateConnection()`.
* @param {String} name
* The operation name that will be passed.
* @returns {Promise} - The promise which resolves to an object.
* The decoded operation object has result and metadata field to get information from.
* Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#long-running-operations | documentation }
* for more details and examples.
* @example <caption>include:samples/generated/v1alpha1/datastream.create_private_connection.js</caption>
* region_tag:datastream_v1alpha1_generated_Datastream_CreatePrivateConnection_async
*/
checkCreatePrivateConnectionProgress(name: string): Promise<LROperation<protos.google.cloud.datastream.v1alpha1.PrivateConnection, protos.google.cloud.datastream.v1alpha1.OperationMetadata>>;
/**
* Use this method to delete a private connectivity configuration.
*
* @param {Object} request
* The request object that will be sent.
* @param {string} request.name
* Required. The name of the private connectivity configuration to delete.
* @param {string} [request.requestId]
* Optional. A request ID to identify requests. Specify a unique request ID
* so that if you must retry your request, the server will know to ignore
* the request if it has already been completed. The server will guarantee
* that for at least 60 minutes after the first request.
*
* For example, consider a situation where you make an initial request and the
* request times out. If you make the request again with the same request ID,
* the server can check if original operation with the same request ID was
* received, and if so, will ignore the second request. This prevents clients
* from accidentally creating duplicate commitments.
*
* The request ID must be a valid UUID with the exception that zero UUID is
* not supported (00000000-0000-0000-0000-000000000000).
* @param {boolean} [request.force]
* Optional. If set to true, any child routes that belong to this PrivateConnection will
* also be deleted.
* @param {object} [options]
* Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest