Initial commit
This commit is contained in:
pasketti
464
node_modules/google-gax/lib/operations_client.js
generated
vendored
Normal file
464
node_modules/google-gax/lib/operations_client.js
generated
vendored
Normal file
@@ -0,0 +1,464 @@
|
||||
/*
|
||||
* Copyright 2016 Google Inc. All rights reserved.
|
||||
*
|
||||
* 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.
|
||||
*
|
||||
* EDITING INSTRUCTIONS
|
||||
* This file was generated from the file
|
||||
* https://github.com/googleapis/googleapis/blob/master/google/longrunning/operations.proto,
|
||||
* and updates to that file get reflected here through a refresh process.
|
||||
* For the short term, the refresh process will only be runnable by Google
|
||||
* engineers.
|
||||
*
|
||||
* The only allowed edits are to method and file documentation. A 3-way
|
||||
* merge preserves those additions if the generated source changes.
|
||||
*/
|
||||
/* TODO: introduce line-wrapping so that it never exceeds the limit. */
|
||||
/* jscs: disable maximumLineLength */
|
||||
'use strict';
|
||||
|
||||
var configData = require('./operations_client_config');
|
||||
var extend = require('extend');
|
||||
var gax = require('./gax');
|
||||
extend(gax, require('./api_callable'));
|
||||
extend(gax, require('./path_template'));
|
||||
extend(gax, require('./paged_iteration'));
|
||||
|
||||
var SERVICE_ADDRESS = 'longrunning.googleapis.com';
|
||||
|
||||
var DEFAULT_SERVICE_PORT = 443;
|
||||
|
||||
var CODE_GEN_NAME_VERSION = 'gapic/0.7.1';
|
||||
|
||||
var PAGE_DESCRIPTORS = {
|
||||
listOperations: new gax.PageDescriptor(
|
||||
'pageToken',
|
||||
'nextPageToken',
|
||||
'operations'
|
||||
),
|
||||
};
|
||||
|
||||
/**
|
||||
* The scopes needed to make gRPC calls to all of the methods defined in
|
||||
* this service.
|
||||
*/
|
||||
var ALL_SCOPES = [];
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
function OperationsClient(gaxGrpc, grpcClients, opts) {
|
||||
opts = extend(
|
||||
{
|
||||
servicePath: SERVICE_ADDRESS,
|
||||
port: DEFAULT_SERVICE_PORT,
|
||||
clientConfig: {},
|
||||
},
|
||||
opts
|
||||
);
|
||||
|
||||
var googleApiClient = ['gl-node/' + process.versions.node];
|
||||
if (opts.libName && opts.libVersion) {
|
||||
googleApiClient.push(opts.libName + '/' + opts.libVersion);
|
||||
}
|
||||
googleApiClient.push(
|
||||
CODE_GEN_NAME_VERSION,
|
||||
'gax/' + gax.version,
|
||||
'grpc/' + gaxGrpc.grpcVersion
|
||||
);
|
||||
|
||||
var defaults = gaxGrpc.constructSettings(
|
||||
'google.longrunning.Operations',
|
||||
configData,
|
||||
opts.clientConfig,
|
||||
{'x-goog-api-client': googleApiClient.join(' ')}
|
||||
);
|
||||
|
||||
var self = this;
|
||||
|
||||
this.auth = gaxGrpc.auth;
|
||||
var operationsStub = gaxGrpc.createStub(
|
||||
grpcClients.google.longrunning.Operations,
|
||||
opts
|
||||
);
|
||||
var operationsStubMethods = [
|
||||
'getOperation',
|
||||
'listOperations',
|
||||
'cancelOperation',
|
||||
'deleteOperation',
|
||||
];
|
||||
operationsStubMethods.forEach(function(methodName) {
|
||||
self['_' + methodName] = gax.createApiCall(
|
||||
operationsStub.then(function(operationsStub) {
|
||||
return function() {
|
||||
var args = Array.prototype.slice.call(arguments, 0);
|
||||
return operationsStub[methodName].apply(operationsStub, args);
|
||||
};
|
||||
}),
|
||||
defaults[methodName],
|
||||
PAGE_DESCRIPTORS[methodName]
|
||||
);
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the project ID used by this class.
|
||||
* @aram {function(Error, string)} callback - the callback to be called with
|
||||
* the current project Id.
|
||||
*/
|
||||
OperationsClient.prototype.getProjectId = function(callback) {
|
||||
return this.auth.getProjectId(callback);
|
||||
};
|
||||
|
||||
// Service calls
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* var client = longrunning.operationsClient();
|
||||
* var name = '';
|
||||
* client.getOperation({name: name}).then(function(responses) {
|
||||
* var response = responses[0];
|
||||
* // doThingsWith(response)
|
||||
* }).catch(function(err) {
|
||||
* console.error(err);
|
||||
* });
|
||||
*/
|
||||
OperationsClient.prototype.getOperation = function(request, options, callback) {
|
||||
if (options instanceof Function && callback === undefined) {
|
||||
callback = options;
|
||||
options = {};
|
||||
}
|
||||
if (options === undefined) {
|
||||
options = {};
|
||||
}
|
||||
|
||||
return this._getOperation(request, options, callback);
|
||||
};
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* var client = longrunning.operationsClient();
|
||||
* var name = '';
|
||||
* var filter = '';
|
||||
* var request = {
|
||||
* name: name,
|
||||
* filter: filter
|
||||
* };
|
||||
* // Iterate over all elements.
|
||||
* client.listOperations(request).then(function(responses) {
|
||||
* var resources = responses[0];
|
||||
* for (var i = 0; i < resources.length; ++i) {
|
||||
* // doThingsWith(resources[i])
|
||||
* }
|
||||
* }).catch(function(err) {
|
||||
* console.error(err);
|
||||
* });
|
||||
*
|
||||
* // Or obtain the paged response.
|
||||
* var options = {autoPaginate: false};
|
||||
* function callback(responses) {
|
||||
* // The actual resources in a response.
|
||||
* var resources = responses[0];
|
||||
* // The next request if the response shows there's more responses.
|
||||
* var nextRequest = responses[1];
|
||||
* // The actual response object, if necessary.
|
||||
* // var rawResponse = responses[2];
|
||||
* for (var i = 0; i < resources.length; ++i) {
|
||||
* // doThingsWith(resources[i]);
|
||||
* }
|
||||
* if (nextRequest) {
|
||||
* // Fetch the next page.
|
||||
* return client.listOperations(nextRequest, options).then(callback);
|
||||
* }
|
||||
* }
|
||||
* client.listOperations(request, options)
|
||||
* .then(callback)
|
||||
* .catch(function(err) {
|
||||
* console.error(err);
|
||||
* });
|
||||
*/
|
||||
OperationsClient.prototype.listOperations = function(
|
||||
request,
|
||||
options,
|
||||
callback
|
||||
) {
|
||||
if (options instanceof Function && callback === undefined) {
|
||||
callback = options;
|
||||
options = {};
|
||||
}
|
||||
if (options === undefined) {
|
||||
options = {};
|
||||
}
|
||||
|
||||
return this._listOperations(request, options, callback);
|
||||
};
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* var client = longrunning.operationsClient();
|
||||
* var name = '';
|
||||
* var filter = '';
|
||||
* var request = {
|
||||
* name: name,
|
||||
* filter: filter
|
||||
* };
|
||||
* client.listOperationsStream(request).on('data', function(element) {
|
||||
* // doThingsWith(element)
|
||||
* }).on('error', function(err) {
|
||||
* console.error(err);
|
||||
* });
|
||||
*/
|
||||
OperationsClient.prototype.listOperationsStream = function(request, options) {
|
||||
if (options === undefined) {
|
||||
options = {};
|
||||
}
|
||||
|
||||
return PAGE_DESCRIPTORS.listOperations.createStream(
|
||||
this._listOperations,
|
||||
request,
|
||||
options
|
||||
);
|
||||
};
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* var client = longrunning.operationsClient();
|
||||
* var name = '';
|
||||
* client.cancelOperation({name: name}).catch(function(err) {
|
||||
* console.error(err);
|
||||
* });
|
||||
*/
|
||||
OperationsClient.prototype.cancelOperation = function(
|
||||
request,
|
||||
options,
|
||||
callback
|
||||
) {
|
||||
if (options instanceof Function && callback === undefined) {
|
||||
callback = options;
|
||||
options = {};
|
||||
}
|
||||
if (options === undefined) {
|
||||
options = {};
|
||||
}
|
||||
|
||||
return this._cancelOperation(request, options, callback);
|
||||
};
|
||||
|
||||
/**
|
||||
* 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
|
||||
*
|
||||
* var client = longrunning.operationsClient();
|
||||
* var name = '';
|
||||
* client.deleteOperation({name: name}).catch(function(err) {
|
||||
* console.error(err);
|
||||
* });
|
||||
*/
|
||||
OperationsClient.prototype.deleteOperation = function(
|
||||
request,
|
||||
options,
|
||||
callback
|
||||
) {
|
||||
if (options instanceof Function && callback === undefined) {
|
||||
callback = options;
|
||||
options = {};
|
||||
}
|
||||
if (options === undefined) {
|
||||
options = {};
|
||||
}
|
||||
|
||||
return this._deleteOperation(request, options, callback);
|
||||
};
|
||||
|
||||
function OperationsClientBuilder(gaxGrpc) {
|
||||
if (!(this instanceof OperationsClientBuilder)) {
|
||||
return new OperationsClientBuilder(gaxGrpc);
|
||||
}
|
||||
|
||||
var operationsClient = gaxGrpc.load([
|
||||
{
|
||||
root: require('google-proto-files')('..'),
|
||||
file: 'google/longrunning/operations.proto',
|
||||
},
|
||||
]);
|
||||
extend(this, operationsClient.google.longrunning);
|
||||
|
||||
/**
|
||||
* Build a new instance of {@link OperationsClient}.
|
||||
*
|
||||
* @param {Object=} opts - The optional parameters.
|
||||
* @param {String=} opts.servicePath
|
||||
* The domain name of the API remote host.
|
||||
* @param {number=} opts.port
|
||||
* The port on which to connect to the remote host.
|
||||
* @param {grpc.ClientCredentials=} opts.sslCreds
|
||||
* A ClientCredentials for use with an SSL-enabled channel.
|
||||
* @param {Object=} opts.clientConfig
|
||||
* The customized config to build the call settings. See
|
||||
* {@link gax.constructSettings} for the format.
|
||||
*/
|
||||
this.operationsClient = function(opts) {
|
||||
return new OperationsClient(gaxGrpc, operationsClient, opts);
|
||||
};
|
||||
extend(this.operationsClient, OperationsClient);
|
||||
}
|
||||
module.exports = OperationsClientBuilder;
|
||||
module.exports.SERVICE_ADDRESS = SERVICE_ADDRESS;
|
||||
module.exports.ALL_SCOPES = ALL_SCOPES;
|
||||
Reference in New Issue
Block a user