621 lines
26 KiB
TypeScript
621 lines
26 KiB
TypeScript
/**
|
|
* Copyright 2015 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.
|
|
*/
|
|
|
|
/* jshint maxlen: false */
|
|
|
|
import createAPIRequest from '../../lib/apirequest';
|
|
|
|
/**
|
|
* Google Cloud Functions API
|
|
*
|
|
* API for managing lightweight user-provided functions executed in response to events.
|
|
*
|
|
* @example
|
|
* const google = require('googleapis');
|
|
* const cloudfunctions = google.cloudfunctions('v1beta2');
|
|
*
|
|
* @namespace cloudfunctions
|
|
* @type {Function}
|
|
* @version v1beta2
|
|
* @variation v1beta2
|
|
* @param {object=} options Options for Cloudfunctions
|
|
*/
|
|
function Cloudfunctions(options) { // eslint-disable-line
|
|
const self = this;
|
|
self._options = options || {};
|
|
|
|
self.operations = {
|
|
|
|
/**
|
|
* cloudfunctions.operations.get
|
|
*
|
|
* @desc 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.
|
|
*
|
|
* @alias cloudfunctions.operations.get
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.name The name of the operation resource.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* cloudfunctions.operations.list
|
|
*
|
|
* @desc 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 allows API services to override the binding to use different resource name schemes, such as `users/x/operations`. To override the binding, API services can add a binding such as `"/v1/{name=users/x}/operations"` to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
|
|
*
|
|
* @alias cloudfunctions.operations.list
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string=} params.filter The standard list filter.
|
|
* @param {string=} params.name The name of the operation's parent resource.
|
|
* @param {integer=} params.pageSize The standard list page size.
|
|
* @param {string=} params.pageToken The standard list page token.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/operations').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: [],
|
|
pathParams: [],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
|
|
};
|
|
|
|
self.projects = {
|
|
locations: {
|
|
|
|
/**
|
|
* cloudfunctions.projects.locations.list
|
|
*
|
|
* @desc Lists information about the supported locations for this service.
|
|
*
|
|
* @alias cloudfunctions.projects.locations.list
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string=} params.filter The standard list filter.
|
|
* @param {string} params.name The resource that owns the locations collection, if applicable.
|
|
* @param {integer=} params.pageSize The standard list page size.
|
|
* @param {string=} params.pageToken The standard list page token.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}/locations').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
functions: {
|
|
|
|
/**
|
|
* cloudfunctions.projects.locations.functions.call
|
|
*
|
|
* @desc Invokes synchronously deployed function. To be used for testing, very limited traffic allowed.
|
|
*
|
|
* @alias cloudfunctions.projects.locations.functions.call
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.name The name of the function to be called.
|
|
* @param {cloudfunctions(v1beta2).CallFunctionRequest} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
call: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}:call').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* cloudfunctions.projects.locations.functions.create
|
|
*
|
|
* @desc Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.
|
|
*
|
|
* @alias cloudfunctions.projects.locations.functions.create
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.location The project and location in which the function should be created, specified in the format `projects/x/locations/x`
|
|
* @param {cloudfunctions(v1beta2).CloudFunction} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
create: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{location}/functions').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'POST'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['location'],
|
|
pathParams: ['location'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* cloudfunctions.projects.locations.functions.delete
|
|
*
|
|
* @desc Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.
|
|
*
|
|
* @alias cloudfunctions.projects.locations.functions.delete
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.name The name of the function which should be deleted.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
delete: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'DELETE'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* cloudfunctions.projects.locations.functions.get
|
|
*
|
|
* @desc Returns a function with the given name from the requested project.
|
|
*
|
|
* @alias cloudfunctions.projects.locations.functions.get
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.name The name of the function which details should be obtained.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
get: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* cloudfunctions.projects.locations.functions.list
|
|
*
|
|
* @desc Returns a list of functions that belong to the requested project.
|
|
*
|
|
* @alias cloudfunctions.projects.locations.functions.list
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.location The project and location from which the function should be listed, specified in the format `projects/x/locations/x` If you want to list functions in all locations, use "-" in place of a location.
|
|
* @param {integer=} params.pageSize Maximum number of functions to return per call.
|
|
* @param {string=} params.pageToken The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
list: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{location}/functions').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'GET'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['location'],
|
|
pathParams: ['location'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
},
|
|
|
|
/**
|
|
* cloudfunctions.projects.locations.functions.update
|
|
*
|
|
* @desc Updates existing function.
|
|
*
|
|
* @alias cloudfunctions.projects.locations.functions.update
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
*
|
|
* @param {object} params Parameters for request
|
|
* @param {string} params.name The name of the function to be updated.
|
|
* @param {cloudfunctions(v1beta2).CloudFunction} params.resource Request body data
|
|
* @param {object} [options] Optionally override request options, such as `url`, `method`, and `encoding`.
|
|
* @param {callback} callback The callback that handles the response.
|
|
* @return {object} Request object
|
|
*/
|
|
update: function (params, options, callback) {
|
|
if (typeof options === 'function') {
|
|
callback = options;
|
|
options = {};
|
|
}
|
|
options || (options = {});
|
|
|
|
const rootUrl = options.rootUrl || 'https://cloudfunctions.googleapis.com/';
|
|
|
|
const parameters = {
|
|
options: Object.assign({
|
|
url: (rootUrl + '/v1beta2/{name}').replace(/([^:]\/)\/+/g, '$1'),
|
|
method: 'PUT'
|
|
}, options),
|
|
params: params,
|
|
requiredParams: ['name'],
|
|
pathParams: ['name'],
|
|
context: self
|
|
};
|
|
|
|
return createAPIRequest(parameters, callback);
|
|
}
|
|
}
|
|
}
|
|
};
|
|
}
|
|
|
|
/**
|
|
* @typedef CallFunctionRequest
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {string} data Input to be passed to the function.
|
|
*/
|
|
|
|
/**
|
|
* @typedef CallFunctionResponse
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {string} error Either system or user-function generated error. Set if execution
|
|
was not successful.
|
|
* @property {string} executionId Execution id of function invocation.
|
|
* @property {string} result Result populated for successful execution of synchronous function. Will
|
|
not be populated if function does not return a result through context.
|
|
*/
|
|
|
|
/**
|
|
* @typedef CloudFunction
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {integer} availableMemoryMb The amount of memory in MB available for a function.
|
|
Defaults to 256MB.
|
|
* @property {string} entryPoint The name of the function (as defined in source code) that will be
|
|
executed. Defaults to the resource name suffix, if not specified. For
|
|
backward compatibility, if function with given name is not found, then the
|
|
system will try to use function named "function".
|
|
For Node.js this is name of a function exported by the module specified
|
|
in `source_location`.
|
|
* @property {cloudfunctions(v1beta2).EventTrigger} eventTrigger A source that fires events in response to a condition in another service.
|
|
* @property {cloudfunctions(v1beta2).HTTPSTrigger} httpsTrigger An HTTPS endpoint type of source that can be triggered via URL.
|
|
* @property {object} labels Labels associated with this Cloud Function.
|
|
* @property {string} latestOperation Output only. Name of the most recent operation modifying the function. If
|
|
the function status is `DEPLOYING` or `DELETING`, then it points to the
|
|
active operation.
|
|
* @property {string} name A user-defined name of the function. Function names must be unique
|
|
globally and match pattern `projects/x/locations/x/functions/x
|
|
* @property {string} serviceAccount Output only. The service account of the function.
|
|
* @property {string} sourceArchiveUrl The Google Cloud Storage URL, starting with gs://, pointing to the zip
|
|
archive which contains the function.
|
|
* @property {cloudfunctions(v1beta2).SourceRepository} sourceRepository The hosted repository where the function is defined.
|
|
* @property {string} sourceRepositoryUrl The URL pointing to the hosted repository where the function is defined.
|
|
There are supported Cloud Source Repository URLs in the following
|
|
formats:
|
|
|
|
To refer to a specific commit:
|
|
`https://source.developers.google.com/projects/x/repos/x/revisions/x/paths/x
|
|
To refer to a moveable alias (branch):
|
|
`https://source.developers.google.com/projects/x/repos/x/aliases/movable/x/paths/x
|
|
In particular, to refer to HEAD use `master` moveable alias.
|
|
To refer to a specific fixed alias (tag):
|
|
`https://source.developers.google.com/projects/x/repos/x/aliases/fixed/x/paths/x
|
|
|
|
You may omit `paths/x if you want to use the main directory.
|
|
* @property {string} status Output only. Status of the function deployment.
|
|
* @property {string} timeout The function execution timeout. Execution is considered failed and
|
|
can be terminated if the function is not completed at the end of the
|
|
timeout period. Defaults to 60 seconds.
|
|
* @property {string} updateTime Output only. The last update timestamp of a Cloud Function.
|
|
* @property {string} versionId Output only.
|
|
The version identifier of the Cloud Function. Each deployment attempt
|
|
results in a new version of a function being created.
|
|
*/
|
|
|
|
/**
|
|
* @typedef EventTrigger
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {string} eventType `event_type` names contain the service that is sending an event and the
|
|
kind of event that was fired. Must be of the form
|
|
`providers/x/eventTypes/x e.g. Directly handle a Message published to
|
|
Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`
|
|
|
|
Handle an object changing in Google Cloud Storage
|
|
`providers/cloud.storage/eventTypes/object.change`
|
|
|
|
Handle a write to the Firebase Realtime Database
|
|
`providers/firebase.database/eventTypes/data.write`
|
|
* @property {cloudfunctions(v1beta2).FailurePolicy} failurePolicy Specifies policy for failed executions.
|
|
* @property {string} resource Which instance of the source's service should send events. E.g. for Pub/Sub
|
|
this would be a Pub/Sub topic at `projects/x/topics/x. For Google Cloud
|
|
Storage this would be a bucket at `projects/x/buckets/x. For any source
|
|
that only supports one instance per-project, this should be the name of the
|
|
project (`projects/x)
|
|
* @property {string} service The hostname of the service that should be observed.
|
|
|
|
If no string is provided, the default service implementing the API will
|
|
be used. For example, `storage.googleapis.com` is the default for all
|
|
event types in the 'google.storage` namespace.
|
|
*/
|
|
|
|
/**
|
|
* @typedef FailurePolicy
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {cloudfunctions(v1beta2).Retry} retry If specified, then the function will be retried in case of a failure.
|
|
*/
|
|
|
|
/**
|
|
* @typedef HTTPSTrigger
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {string} url Output only. The deployed url for the function.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ListFunctionsResponse
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {cloudfunctions(v1beta2).CloudFunction[]} functions The functions that match the request.
|
|
* @property {string} nextPageToken If not empty, indicates that there may be more functions that match
|
|
the request; this value should be passed in a new
|
|
google.cloud.functions.v1beta2.ListFunctionsRequest
|
|
to get more functions.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ListLocationsResponse
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {cloudfunctions(v1beta2).Location[]} locations A list of locations that matches the specified filter in the request.
|
|
* @property {string} nextPageToken The standard List next-page token.
|
|
*/
|
|
|
|
/**
|
|
* @typedef ListOperationsResponse
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {string} nextPageToken The standard List next-page token.
|
|
* @property {cloudfunctions(v1beta2).Operation[]} operations A list of operations that matches the specified filter in the request.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Location
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {object} labels Cross-service attributes for the location. For example
|
|
|
|
{"cloud.googleapis.com/region": "us-east1"}
|
|
* @property {string} locationId The canonical id for this location. For example: `"us-east1"`.
|
|
* @property {object} metadata Service-specific metadata. For example the available capacity at the given
|
|
location.
|
|
* @property {string} name Resource name for the location, which may vary between implementations.
|
|
For example: `"projects/example-project/locations/us-east1"`
|
|
*/
|
|
|
|
/**
|
|
* @typedef Operation
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {boolean} done If the value is `false`, it means the operation is still in progress.
|
|
If `true`, the operation is completed, and either `error` or `response` is
|
|
available.
|
|
* @property {cloudfunctions(v1beta2).Status} error The error result of the operation in case of failure or cancellation.
|
|
* @property {object} metadata Service-specific metadata associated with the operation. It typically
|
|
contains progress information and common metadata such as create time.
|
|
Some services might not provide such metadata. Any method that returns a
|
|
long-running operation should document the metadata type, if any.
|
|
* @property {string} name The server-assigned name, which is only unique within the same service that
|
|
originally returns it. If you use the default HTTP mapping, the
|
|
`name` should have the format of `operations/some/unique/name`.
|
|
* @property {object} response The normal response of the operation in case of success. If the original
|
|
method returns no data on success, such as `Delete`, the response is
|
|
`google.protobuf.Empty`. If the original method is standard
|
|
`Get`/`Create`/`Update`, the response should be the resource. For other
|
|
methods, the response should have the type `XxxResponse`, where `Xxx`
|
|
is the original method name. For example, if the original method name
|
|
is `TakeSnapshot()`, the inferred response type is
|
|
`TakeSnapshotResponse`.
|
|
*/
|
|
|
|
/**
|
|
* @typedef OperationMetadataV1Beta2
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {object} request The original request that started the operation.
|
|
* @property {string} target Target of the operation - for example
|
|
projects/project-1/locations/region-1/functions/function-1
|
|
* @property {string} type Type of operation.
|
|
* @property {string} versionId Version id of the function created or updated by an API call.
|
|
This field is only pupulated for Create and Update operations.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Retry
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
*/
|
|
|
|
/**
|
|
* @typedef SourceRepository
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {string} branch The name of the branch from which the function should be fetched.
|
|
* @property {string} deployedRevision Output only. The id of the revision that was resolved at the moment of
|
|
function creation or update. For example when a user deployed from a
|
|
branch, it will be the revision id of the latest change on this branch at
|
|
that time. If user deployed from revision then this value will be always
|
|
equal to the revision specified by the user.
|
|
* @property {string} repositoryUrl URL to the hosted repository where the function is defined. Only paths in
|
|
https://source.developers.google.com domain are supported. The path should
|
|
contain the name of the repository.
|
|
* @property {string} revision The id of the revision that captures the state of the repository from
|
|
which the function should be fetched.
|
|
* @property {string} sourcePath The path within the repository where the function is defined. The path
|
|
should point to the directory where Cloud Functions files are located. Use
|
|
"/" if the function is defined directly in the root directory of a
|
|
repository.
|
|
* @property {string} tag The name of the tag that captures the state of the repository from
|
|
which the function should be fetched.
|
|
*/
|
|
|
|
/**
|
|
* @typedef Status
|
|
* @memberOf! cloudfunctions(v1beta2)
|
|
* @type object
|
|
* @property {integer} code The status code, which should be an enum value of google.rpc.Code.
|
|
* @property {object[]} details A list of messages that carry the error details. There is a common set of
|
|
message types for APIs to use.
|
|
* @property {string} message A developer-facing error message, which should be in English. Any
|
|
user-facing error message should be localized and sent in the
|
|
google.rpc.Status.details field, or localized by the client.
|
|
*/
|
|
export = Cloudfunctions;
|