--- /dev/null
+import { GoogleAuth } from 'google-auth-library';
+import { ProjectIdCallback } from 'google-auth-library/build/src/auth/googleauth';
+import * as gax from './gax';
+import { GrpcClient } from './grpc';
+export declare const SERVICE_ADDRESS = "longrunning.googleapis.com";
+/**
+ * The scopes needed to make gRPC calls to all of the methods defined in
+ * this service.
+ */
+export declare const ALL_SCOPES: string[];
+export interface OperationsClientOptions {
+ libName?: string;
+ libVersion?: string;
+ clientConfig: gax.ClientConfig;
+}
+/**
+ * Manages long-running operations with an API service.
+ *
+ * When an API method normally takes long time to complete, it can be designed
+ * to return {@link Operation} to the client, and the client can use this
+ * interface to receive the real response asynchronously by polling the
+ * operation resource, or pass the operation resource to another API (such as
+ * Google Cloud Pub/Sub API) to receive the response. Any API service that
+ * returns long-running operations should implement the `Operations` interface
+ * so developers can have a consistent client experience.
+ *
+ * This will be created through a builder function which can be obtained by the
+ * module. See the following example of how to initialize the module and how to
+ * access to the builder.
+ * @see {@link operationsClient}
+ *
+ * @class
+ */
+export declare class OperationsClient {
+ auth: GoogleAuth;
+ private _getOperation;
+ private _listOperations;
+ private _cancelOperation;
+ private _deleteOperation;
+ constructor(gaxGrpc: GrpcClient, grpcClients: any, options: OperationsClientOptions);
+ /**
+ * Get the project ID used by this class.
+ * @aram {function(Error, string)} callback - the callback to be called with
+ * the current project Id.
+ */
+ getProjectId(): Promise<string>;
+ getProjectId(callback: ProjectIdCallback): void;
+ /**
+ * 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 {Object} request - The request object that will be sent.
+ * @param {string} request.name - The name of the operation resource.
+ * @param {Object=} options
+ * Optional parameters. You can override the default settings for this call,
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
+ * details.
+ * @param {function(?Error, ?Object)=} callback
+ * The function which will be called with the result of the API call.
+ *
+ * The second parameter to the callback is an object representing
+ * [google.longrunning.Operation]{@link
+ * external:"google.longrunning.Operation"}.
+ * @return {Promise} - The promise which resolves to an array.
+ * The first element of the array is an object representing
+ * [google.longrunning.Operation]{@link
+ * external:"google.longrunning.Operation"}. The promise has a method named
+ * "cancel" which cancels the ongoing API call.
+ *
+ * @example
+ *
+ * const client = longrunning.operationsClient();
+ * const name = '';
+ * const [response] = await client.getOperation({name});
+ * // doThingsWith(response)
+ */
+ getOperation(request: {}, options: {}, callback?: any): any;
+ /**
+ * Lists operations that match the specified filter in the request. If the
+ * server doesn't support this method, it returns `UNIMPLEMENTED`.
+ *
+ * NOTE: the `name` binding below allows API services to override the binding
+ * to use different resource name schemes.
+ *
+ * @param {Object} request - The request object that will be sent.
+ * @param {string} request.name - The name of the operation collection.
+ * @param {string} request.filter - The standard list filter.
+ * @param {number=} request.pageSize
+ * The maximum number of resources contained in the underlying API
+ * response. If page streaming is performed per-resource, this
+ * parameter does not affect the return value. If page streaming is
+ * performed per-page, this determines the maximum number of
+ * resources in a page.
+ * @param {Object=} options
+ * Optional parameters. You can override the default settings for this call,
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
+ * details.
+ * @param {function(?Error, ?Array, ?Object, ?Object)=} callback
+ * The function which will be called with the result of the API call.
+ *
+ * The second parameter to the callback is Array of
+ * [google.longrunning.Operation]{@link
+ * external:"google.longrunning.Operation"}.
+ *
+ * When autoPaginate: false is specified through options, it contains the
+ * result in a single response. If the response indicates the next page
+ * exists, the third parameter is set to be used for the next request object.
+ * The fourth parameter keeps the raw response object of an object
+ * representing [google.longrunning.ListOperationsResponse]{@link
+ * external:"google.longrunning.ListOperationsResponse"}.
+ * @return {Promise} - The promise which resolves to an array.
+ * The first element of the array is Array of
+ * [google.longrunning.Operation]{@link
+ * external:"google.longrunning.Operation"}.
+ *
+ * When autoPaginate: false is specified through options, the array has
+ * three elements. The first element is Array of
+ * [google.longrunning.Operation]{@link
+ * external:"google.longrunning.Operation"} in a single response. The second
+ * element is the next request object if the response indicates the next page
+ * exists, or null. The third element is an object representing
+ * [google.longrunning.ListOperationsResponse]{@link
+ * external:"google.longrunning.ListOperationsResponse"}.
+ *
+ * The promise has a method named "cancel" which cancels the ongoing API
+ * call.
+ *
+ * @example
+ *
+ * const client = longrunning.operationsClient();
+ * const request = {
+ * name: '',
+ * filter: ''
+ * };
+ * // Iterate over all elements.
+ * const [resources] = await client.listOperations(request);
+ * for (const resource of resources) {
+ * console.log(resources);
+ * }
+ *
+ * // Or obtain the paged response.
+ * const options = {autoPaginate: false};
+ * let nextRequest = request;
+ * while(nextRequest) {
+ * const response = await client.listOperations(nextRequest, options);
+ * const resources = response[0];
+ * nextRequest = response[1];
+ * const rawResponse = response[2];
+ * for (const resource of resources) {
+ * // doThingsWith(resource);
+ * }
+ * };
+ */
+ listOperations(request: any, options: any, callback: any): any;
+ /**
+ * Equivalent to {@link listOperations}, but returns a NodeJS Stream object.
+ *
+ * This fetches the paged responses for {@link listOperations} continuously
+ * and invokes the callback registered for 'data' event for each element in
+ * the responses.
+ *
+ * The returned object has 'end' method when no more elements are required.
+ *
+ * autoPaginate option will be ignored.
+ *
+ * @see {@link https://nodejs.org/api/stream.html}
+ *
+ * @param {Object} request - The request object that will be sent.
+ * @param {string} request.name - The name of the operation collection.
+ * @param {string} request.filter - The standard list filter.
+ * @param {number=} request.pageSize -
+ * The maximum number of resources contained in the underlying API
+ * response. If page streaming is performed per-resource, this
+ * parameter does not affect the return value. If page streaming is
+ * performed per-page, this determines the maximum number of
+ * resources in a page.
+ * @param {Object=} options
+ * Optional parameters. You can override the default settings for this call,
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
+ * details.
+ * @return {Stream} - An object stream which emits an object representing [google.longrunning.Operation]{@link external:"google.longrunning.Operation"} on 'data' event.
+ *
+ * @example
+ *
+ * const client = longrunning.operationsClient();
+ * const request = {
+ * name: '',
+ * filter: ''
+ * };
+ * client.listOperationsStream(request)
+ * .on('data', element => {
+ * // doThingsWith(element)
+ * })
+ * .on('error', err => {
+ * console.error(err);
+ * });
+ */
+ listOperationsStream(request: any, options?: {}): any;
+ /**
+ * 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
+ * {@link 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 {@link Operation.error} value with a {@link google.rpc.Status.code} of
+ * 1, corresponding to `Code.CANCELLED`.
+ *
+ * @param {Object} request - The request object that will be sent.
+ * @param {string} request.name - The name of the operation resource to be cancelled.
+ * @param {Object=} options
+ * Optional parameters. You can override the default settings for this call,
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
+ * details.
+ * @param {function(?Error)=} callback
+ * The function which will be called with the result of the API call.
+ * @return {Promise} - The promise which resolves when API call finishes.
+ * The promise has a method named "cancel" which cancels the ongoing API
+ * call.
+ *
+ * @example
+ *
+ * const client = longrunning.operationsClient();
+ * await client.cancelOperation({name: ''});
+ */
+ cancelOperation(request: any, options?: any, callback?: any): any;
+ /**
+ * 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 {Object} request - The request object that will be sent.
+ * @param {string} request.name - The name of the operation resource to be deleted.
+ * @param {Object=} options
+ * Optional parameters. You can override the default settings for this call,
+ * e.g, timeout, retries, paginations, etc. See [gax.CallOptions]{@link
+ * https://googleapis.github.io/gax-nodejs/global.html#CallOptions} for the
+ * details.
+ * @param {function(?Error)=} callback
+ * The function which will be called with the result of the API call.
+ * @return {Promise} - The promise which resolves when API call finishes.
+ * The promise has a method named "cancel" which cancels the ongoing API
+ * call.
+ *
+ * @example
+ *
+ * const client = longrunning.operationsClient();
+ * await client.deleteOperation({name: ''});
+ */
+ deleteOperation(request: any, options: any, callback: any): any;
+}
+export declare class OperationsClientBuilder {
+ operationsClient: (opts: OperationsClientOptions) => OperationsClient;
+ /**
+ * Builds a new Operations Client
+ * @param gaxGrpc {GrpcClient}
+ */
+ constructor(gaxGrpc: GrpcClient);
+}
git://repos.xcallymotion.com / motion2.git / blobdiff