dev testing

functions/node_modules/google-gax/build/src/longRunningCalls/longrunning.d.ts

@@ -0,0 +1,132 @@
+/**
+ * Copyright 2020 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+import { EventEmitter } from 'events';
+import { ResultTuple } from '../apitypes';
+import { CancellablePromise } from '../call';
+import { BackoffSettings, CallOptions } from '../gax';
+import { GoogleError } from '../googleError';
+import { Metadata } from '../grpc';
+import { LongRunningDescriptor } from './longRunningDescriptor';
+import * as operationProtos from '../../protos/operations';
+/**
+ * @callback GetOperationCallback
+ * @param {?Error} error
+ * @param {?Object} result
+ * @param {?Object} metadata
+ * @param {?google.longrunning.Operation} rawResponse
+ */
+export interface GetOperationCallback {
+    (err?: Error | null, result?: {}, metadata?: {}, rawResponse?: LROOperation): void;
+}
+type LROOperation = operationProtos.google.longrunning.Operation;
+export declare class Operation extends EventEmitter {
+    completeListeners: number;
+    hasActiveListeners: boolean;
+    latestResponse: LROOperation;
+    longrunningDescriptor: LongRunningDescriptor;
+    result: {} | null;
+    metadata: Metadata | null;
+    backoffSettings: BackoffSettings;
+    _callOptions?: CallOptions;
+    currentCallPromise_?: CancellablePromise<ResultTuple>;
+    name?: string;
+    done?: boolean;
+    error?: GoogleError;
+    response?: {};
+    /**
+     * Wrapper for a google.longrunnung.Operation.
+     *
+     * @constructor
+     *
+     * @param {google.longrunning.Operation} grpcOp - The operation to be wrapped.
+     * @param {LongRunningDescriptor} longrunningDescriptor - This defines the
+     * operations service client and unpacking mechanisms for the operation.
+     * @param {BackoffSettings} backoffSettings - The backoff settings used in
+     * in polling the operation.
+     * @param {CallOptions} callOptions - CallOptions used in making get operation
+     * requests.
+     */
+    constructor(grpcOp: LROOperation, longrunningDescriptor: LongRunningDescriptor, backoffSettings: BackoffSettings, callOptions?: CallOptions);
+    /**
+     * Begin listening for events on the operation. This method keeps track of how
+     * many "complete" listeners are registered and removed, making sure polling
+     * is handled automatically.
+     *
+     * As long as there is one active "complete" listener, the connection is open.
+     * When there are no more listeners, the polling stops.
+     *
+     * @private
+     */
+    _listenForEvents(): void;
+    /**
+     * Cancels current polling api call and cancels the operation.
+     *
+     * @return {Promise} the promise of the OperationsClient#cancelOperation api
+     * request.
+     */
+    cancel(): Promise<operationProtos.google.protobuf.Empty>;
+    /**
+     * Get the updated status of the operation. If the Operation has previously
+     * completed, this will use the status of the cached completed operation.
+     *
+     *   - callback(err): Operation failed
+     *   - callback(null, result, metadata, rawResponse): Operation complete
+     *   - callback(null, null, metadata, rawResponse): Operation incomplete
+     *
+     * @param {getOperationCallback} callback - Callback to handle the polled
+     * operation result and metadata.
+     * @return {Promise|undefined} - This returns a promise if a callback is not specified.
+     * The promise resolves to an array where the first element is the unpacked
+     * result, the second element is the metadata, and the third element is the
+     * raw response of the api call. The promise rejects if the operation returns
+     * an error.
+     */
+    getOperation(): Promise<{}>;
+    getOperation(callback: GetOperationCallback): void;
+    _unpackResponse(op: LROOperation, callback?: GetOperationCallback): void;
+    /**
+     * Poll `getOperation` to check the operation's status. This runs a loop to
+     * ping using the backoff strategy specified at initialization.
+     *
+     * Note: This method is automatically called once a "complete" event handler
+     * is registered on the operation.
+     *
+     * @private
+     */
+    startPolling_(): void;
+    /**
+     * Wraps the `complete` and `error` events in a Promise.
+     *
+     * @return {promise} - Promise that resolves on operation completion and rejects
+     * on operation error.
+     */
+    promise(): Promise<unknown>;
+}
+/**
+ * Method used to create Operation objects.
+ *
+ * @constructor
+ *
+ * @param {google.longrunning.Operation} op - The operation to be wrapped.
+ * @param {LongRunningDescriptor} longrunningDescriptor - This defines the
+ * operations service client and unpacking mechanisms for the operation.
+ * @param {BackoffSettings} backoffSettings - The backoff settings used in
+ * in polling the operation.
+ * @param {CallOptions=} callOptions - CallOptions used in making get operation
+ * requests.
+ */
+export declare function operation(op: LROOperation, longrunningDescriptor: LongRunningDescriptor, backoffSettings: BackoffSettings, callOptions?: CallOptions): Operation;
+export {};