import type * as gax from 'google-gax'; import type { Callback, CallOptions, Descriptors, ClientOptions, LROperation, PaginationCallback, LocationsClient, LocationProtos } from 'google-gax'; import { Transform } from 'stream'; import * as protos from '../../protos/protos'; /** * A service that application uses to manipulate triggers and functions. * @class * @memberof v1 */ export declare class CloudFunctionsServiceClient { 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; }; locationsClient: LocationsClient; pathTemplates: { [name: string]: gax.PathTemplate; }; operationsClient: gax.OperationsClient; cloudFunctionsServiceStub?: Promise<{ [name: string]: Function; }>; /** * Construct an instance of CloudFunctionsServiceClient. * * @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 CloudFunctionsServiceClient({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; getProjectId(callback: Callback): void; /** * Returns a function with the given name from the requested project. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the function which details should be obtained. * @param {number} [request.versionId] * Optional. The optional version of the function whose details should be * obtained. The version of a 1st Gen function is an integer that starts from * 1 and gets incremented on redeployments. Each deployment creates a config * version of the underlying function. GCF may keep historical configs for old * versions. This field can be specified to fetch the historical configs. * Leave it blank or set to 0 to get the latest version of the function. * @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.functions.v1.CloudFunction|CloudFunction}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/cloud_functions_service.get_function.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_GetFunction_async */ getFunction(request?: protos.google.cloud.functions.v1.IGetFunctionRequest, options?: CallOptions): Promise<[ protos.google.cloud.functions.v1.ICloudFunction, protos.google.cloud.functions.v1.IGetFunctionRequest | undefined, {} | undefined ]>; getFunction(request: protos.google.cloud.functions.v1.IGetFunctionRequest, options: CallOptions, callback: Callback): void; getFunction(request: protos.google.cloud.functions.v1.IGetFunctionRequest, callback: Callback): void; /** * Synchronously invokes a deployed Cloud Function. To be used for testing * purposes as very limited traffic is allowed. For more information on * the actual limits, refer to * [Rate Limits](https://cloud.google.com/functions/quotas#rate_limits). * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the function to be called. * @param {string} request.data * Required. Input to be passed to the function. * @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.functions.v1.CallFunctionResponse|CallFunctionResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/cloud_functions_service.call_function.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_CallFunction_async */ callFunction(request?: protos.google.cloud.functions.v1.ICallFunctionRequest, options?: CallOptions): Promise<[ protos.google.cloud.functions.v1.ICallFunctionResponse, protos.google.cloud.functions.v1.ICallFunctionRequest | undefined, {} | undefined ]>; callFunction(request: protos.google.cloud.functions.v1.ICallFunctionRequest, options: CallOptions, callback: Callback): void; callFunction(request: protos.google.cloud.functions.v1.ICallFunctionRequest, callback: Callback): void; /** * Returns a signed URL for uploading a function source code. * For more information about the signed URL usage see: * https://cloud.google.com/storage/docs/access-control/signed-urls. * Once the function source code upload is complete, the used signed * URL should be provided in CreateFunction or UpdateFunction request * as a reference to the function source code. * * When uploading source code to the generated signed URL, please follow * these restrictions: * * * Source file type should be a zip file. * * Source file size should not exceed 100MB limit. * * No credentials should be attached - the signed URLs provide access to the * target bucket using internal service identity; if credentials were * attached, the identity from the credentials would be used, but that * identity does not have permissions to upload files to the URL. * * When making a HTTP PUT request, these two headers need to be specified: * * * `content-type: application/zip` * * `x-goog-content-length-range: 0,104857600` * * And this header SHOULD NOT be specified: * * * `Authorization: Bearer YOUR_TOKEN` * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * The project and location in which the Google Cloud Storage signed URL * should be generated, specified in the format `projects/* /locations/*`. * @param {string} request.kmsKeyName * Resource name of a KMS crypto key (managed by the user) used to * encrypt/decrypt function source code objects in intermediate Cloud Storage * buckets. When you generate an upload url and upload your source code, it * gets copied to an intermediate Cloud Storage bucket. The source code is * then copied to a versioned directory in the sources bucket in the consumer * project during the function deployment. * * It must match the pattern * `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. * * The Google Cloud Functions service account * (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be * granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter * (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the * Key/KeyRing/Project/Organization (least access preferred). GCF will * delegate access to the Google Storage service account in the internal * project. * @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.functions.v1.GenerateUploadUrlResponse|GenerateUploadUrlResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/cloud_functions_service.generate_upload_url.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_GenerateUploadUrl_async */ generateUploadUrl(request?: protos.google.cloud.functions.v1.IGenerateUploadUrlRequest, options?: CallOptions): Promise<[ protos.google.cloud.functions.v1.IGenerateUploadUrlResponse, protos.google.cloud.functions.v1.IGenerateUploadUrlRequest | undefined, {} | undefined ]>; generateUploadUrl(request: protos.google.cloud.functions.v1.IGenerateUploadUrlRequest, options: CallOptions, callback: Callback): void; generateUploadUrl(request: protos.google.cloud.functions.v1.IGenerateUploadUrlRequest, callback: Callback): void; /** * Returns a signed URL for downloading deployed function source code. * The URL is only valid for a limited period and should be used within * minutes after generation. * For more information about the signed URL usage see: * https://cloud.google.com/storage/docs/access-control/signed-urls * * @param {Object} request * The request object that will be sent. * @param {string} request.name * The name of function for which source code Google Cloud Storage signed * URL should be generated. * @param {number} request.versionId * The optional version of function. If not set, default, current version * is used. * @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.functions.v1.GenerateDownloadUrlResponse|GenerateDownloadUrlResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/cloud_functions_service.generate_download_url.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_GenerateDownloadUrl_async */ generateDownloadUrl(request?: protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest, options?: CallOptions): Promise<[ protos.google.cloud.functions.v1.IGenerateDownloadUrlResponse, protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest | undefined, {} | undefined ]>; generateDownloadUrl(request: protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest, options: CallOptions, callback: Callback): void; generateDownloadUrl(request: protos.google.cloud.functions.v1.IGenerateDownloadUrlRequest, callback: Callback): void; /** * Sets the IAM access control policy on the specified function. * Replaces any existing policy. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being specified. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.Policy} request.policy * REQUIRED: The complete policy to be applied to the `resource`. The size of * the policy is limited to a few 10s of KB. An empty policy is a * valid policy but certain Cloud Platform services (such as Projects) * might reject them. * @param {google.protobuf.FieldMask} request.updateMask * OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only * the fields in the mask will be modified. If no mask is provided, the * following default mask is used: * * `paths: "bindings, etag"` * @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.iam.v1.Policy|Policy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/cloud_functions_service.set_iam_policy.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_SetIamPolicy_async */ setIamPolicy(request?: protos.google.iam.v1.ISetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.ISetIamPolicyRequest | undefined, {} | undefined ]>; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, options: CallOptions, callback: Callback): void; setIamPolicy(request: protos.google.iam.v1.ISetIamPolicyRequest, callback: Callback): void; /** * Gets the IAM access control policy for a function. * Returns an empty policy if the function exists and does not have a policy * set. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy is being requested. * See the operation documentation for the appropriate value for this field. * @param {google.iam.v1.GetPolicyOptions} request.options * OPTIONAL: A `GetPolicyOptions` object for specifying options to * `GetIamPolicy`. * @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.iam.v1.Policy|Policy}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/cloud_functions_service.get_iam_policy.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_GetIamPolicy_async */ getIamPolicy(request?: protos.google.iam.v1.IGetIamPolicyRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.IPolicy, protos.google.iam.v1.IGetIamPolicyRequest | undefined, {} | undefined ]>; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, options: CallOptions, callback: Callback): void; getIamPolicy(request: protos.google.iam.v1.IGetIamPolicyRequest, callback: Callback): void; /** * Tests the specified permissions against the IAM access control policy * for a function. * If the function does not exist, this will return an empty set of * permissions, not a NOT_FOUND error. * * @param {Object} request * The request object that will be sent. * @param {string} request.resource * REQUIRED: The resource for which the policy detail is being requested. * See the operation documentation for the appropriate value for this field. * @param {string[]} request.permissions * The set of permissions to check for the `resource`. Permissions with * wildcards (such as '*' or 'storage.*') are not allowed. For more * information see * [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions). * @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.iam.v1.TestIamPermissionsResponse|TestIamPermissionsResponse}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example include:samples/generated/v1/cloud_functions_service.test_iam_permissions.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_TestIamPermissions_async */ testIamPermissions(request?: protos.google.iam.v1.ITestIamPermissionsRequest, options?: CallOptions): Promise<[ protos.google.iam.v1.ITestIamPermissionsResponse, protos.google.iam.v1.ITestIamPermissionsRequest | undefined, {} | undefined ]>; testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, options: CallOptions, callback: Callback): void; testIamPermissions(request: protos.google.iam.v1.ITestIamPermissionsRequest, callback: Callback): void; /** * 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.location * Required. The project and location in which the function should be created, * specified in the format `projects/* /locations/*` * @param {google.cloud.functions.v1.CloudFunction} request.function * Required. Function to be created. * @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 include:samples/generated/v1/cloud_functions_service.create_function.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_CreateFunction_async */ createFunction(request?: protos.google.cloud.functions.v1.ICreateFunctionRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; createFunction(request: protos.google.cloud.functions.v1.ICreateFunctionRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; createFunction(request: protos.google.cloud.functions.v1.ICreateFunctionRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `createFunction()`. * @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 include:samples/generated/v1/cloud_functions_service.create_function.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_CreateFunction_async */ checkCreateFunctionProgress(name: string): Promise>; /** * Updates existing function. * * @param {Object} request * The request object that will be sent. * @param {google.cloud.functions.v1.CloudFunction} request.function * Required. New version of the function. * @param {google.protobuf.FieldMask} request.updateMask * Required. The list of fields in `CloudFunction` that have to be updated. * @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 include:samples/generated/v1/cloud_functions_service.update_function.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_UpdateFunction_async */ updateFunction(request?: protos.google.cloud.functions.v1.IUpdateFunctionRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; updateFunction(request: protos.google.cloud.functions.v1.IUpdateFunctionRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; updateFunction(request: protos.google.cloud.functions.v1.IUpdateFunctionRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `updateFunction()`. * @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 include:samples/generated/v1/cloud_functions_service.update_function.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_UpdateFunction_async */ checkUpdateFunctionProgress(name: string): Promise>; /** * 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. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Required. The name of the function which should be deleted. * @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 include:samples/generated/v1/cloud_functions_service.delete_function.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_DeleteFunction_async */ deleteFunction(request?: protos.google.cloud.functions.v1.IDeleteFunctionRequest, options?: CallOptions): Promise<[ LROperation, protos.google.longrunning.IOperation | undefined, {} | undefined ]>; deleteFunction(request: protos.google.cloud.functions.v1.IDeleteFunctionRequest, options: CallOptions, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; deleteFunction(request: protos.google.cloud.functions.v1.IDeleteFunctionRequest, callback: Callback, protos.google.longrunning.IOperation | null | undefined, {} | null | undefined>): void; /** * Check the status of the long running operation returned by `deleteFunction()`. * @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 include:samples/generated/v1/cloud_functions_service.delete_function.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_DeleteFunction_async */ checkDeleteFunctionProgress(name: string): Promise>; /** * Returns a list of functions that belong to the requested project. * * @param {Object} request * The request object that will be sent. * @param {string} request.parent * The project and location from which the function should be listed, * specified in the format `projects/* /locations/*` * If you want to list functions in all locations, use "-" in place of a * location. When listing functions in all locations, if one or more * location(s) are unreachable, the response will contain functions from all * reachable locations along with the names of any unreachable locations. * @param {number} request.pageSize * Maximum number of functions to return per call. * @param {string} request.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] * 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 Array of {@link protos.google.cloud.functions.v1.CloudFunction|CloudFunction}. * The client library will perform auto-pagination by default: it will call the API as many * times as needed and will merge results from all the pages into this array. * Note that it can affect your quota. * We recommend using `listFunctionsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFunctions(request?: protos.google.cloud.functions.v1.IListFunctionsRequest, options?: CallOptions): Promise<[ protos.google.cloud.functions.v1.ICloudFunction[], protos.google.cloud.functions.v1.IListFunctionsRequest | null, protos.google.cloud.functions.v1.IListFunctionsResponse ]>; listFunctions(request: protos.google.cloud.functions.v1.IListFunctionsRequest, options: CallOptions, callback: PaginationCallback): void; listFunctions(request: protos.google.cloud.functions.v1.IListFunctionsRequest, callback: PaginationCallback): void; /** * Equivalent to `listFunctions`, but returns a NodeJS Stream object. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * The project and location from which the function should be listed, * specified in the format `projects/* /locations/*` * If you want to list functions in all locations, use "-" in place of a * location. When listing functions in all locations, if one or more * location(s) are unreachable, the response will contain functions from all * reachable locations along with the names of any unreachable locations. * @param {number} request.pageSize * Maximum number of functions to return per call. * @param {string} request.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] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Stream} * An object stream which emits an object representing {@link protos.google.cloud.functions.v1.CloudFunction|CloudFunction} on 'data' event. * The client library will perform auto-pagination by default: it will call the API as many * times as needed. Note that it can affect your quota. * We recommend using `listFunctionsAsync()` * method described below for async iteration which you can stop as needed. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. */ listFunctionsStream(request?: protos.google.cloud.functions.v1.IListFunctionsRequest, options?: CallOptions): Transform; /** * Equivalent to `listFunctions`, but returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.parent * The project and location from which the function should be listed, * specified in the format `projects/* /locations/*` * If you want to list functions in all locations, use "-" in place of a * location. When listing functions in all locations, if one or more * location(s) are unreachable, the response will contain functions from all * reachable locations along with the names of any unreachable locations. * @param {number} request.pageSize * Maximum number of functions to return per call. * @param {string} request.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] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link protos.google.cloud.functions.v1.CloudFunction|CloudFunction}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example include:samples/generated/v1/cloud_functions_service.list_functions.js * region_tag:cloudfunctions_v1_generated_CloudFunctionsService_ListFunctions_async */ listFunctionsAsync(request?: protos.google.cloud.functions.v1.IListFunctionsRequest, options?: CallOptions): AsyncIterable; /** * Gets information about a location. * * @param {Object} request * The request object that will be sent. * @param {string} request.name * Resource name for the location. * @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 google.cloud.location.Location | Location}. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#regular-methods | documentation } * for more details and examples. * @example * ``` * const [response] = await client.getLocation(request); * ``` */ getLocation(request: LocationProtos.google.cloud.location.IGetLocationRequest, options?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * Lists information about the supported locations for this service. Returns an iterable object. * * `for`-`await`-`of` syntax is used with the iterable to get response elements on-demand. * @param {Object} request * The request object that will be sent. * @param {string} request.name * The resource that owns the locations collection, if applicable. * @param {string} request.filter * The standard list filter. * @param {number} request.pageSize * The standard list page size. * @param {string} request.pageToken * The standard list page token. * @param {object} [options] * Call options. See {@link https://googleapis.dev/nodejs/google-gax/latest/interfaces/CallOptions.html|CallOptions} for more details. * @returns {Object} * An iterable Object that allows {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | async iteration }. * When you iterate the returned iterable, each element will be an object representing * {@link google.cloud.location.Location | Location}. The API will be called under the hood as needed, once per the page, * so you can stop the iteration when you don't need more results. * Please see the {@link https://github.com/googleapis/gax-nodejs/blob/master/client-libraries.md#auto-pagination | documentation } * for more details and examples. * @example * ``` * const iterable = client.listLocationsAsync(request); * for await (const response of iterable) { * // process response * } * ``` */ listLocationsAsync(request: LocationProtos.google.cloud.location.IListLocationsRequest, options?: CallOptions): AsyncIterable; /** * 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 {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.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 * {@link google.longrunning.Operation | google.longrunning.Operation}. * @return {Promise} - The promise which resolves to an array. * The first element of the array is an object representing * {@link google.longrunning.Operation | 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: protos.google.longrunning.GetOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise<[protos.google.longrunning.Operation]>; /** * Lists operations that match the specified filter in the request. If the * server doesn't support this method, it returns `UNIMPLEMENTED`. Returns an iterable object. * * For-await-of syntax is used with the iterable to recursively get response element on-demand. * * @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 {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.CallOptions} for the * details. * @returns {Object} * An iterable Object that conforms to {@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols | iteration protocols}. * * @example * ``` * const client = longrunning.operationsClient(); * for await (const response of client.listOperationsAsync(request)); * // doThingsWith(response) * ``` */ listOperationsAsync(request: protos.google.longrunning.ListOperationsRequest, options?: gax.CallOptions): AsyncIterable; /** * 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 {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.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: protos.google.longrunning.CancelOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * 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 {@link * https://googleapis.github.io/gax-nodejs/global.html#CallOptions | gax.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: protos.google.longrunning.DeleteOperationRequest, optionsOrCallback?: gax.CallOptions | Callback, callback?: Callback): Promise; /** * Return a fully-qualified cloudFunction resource name string. * * @param {string} project * @param {string} location * @param {string} functionParam * @returns {string} Resource name string. */ cloudFunctionPath(project: string, location: string, functionParam: string): string; /** * Parse the project from CloudFunction resource. * * @param {string} cloudFunctionName * A fully-qualified path representing CloudFunction resource. * @returns {string} A string representing the project. */ matchProjectFromCloudFunctionName(cloudFunctionName: string): string | number; /** * Parse the location from CloudFunction resource. * * @param {string} cloudFunctionName * A fully-qualified path representing CloudFunction resource. * @returns {string} A string representing the location. */ matchLocationFromCloudFunctionName(cloudFunctionName: string): string | number; /** * Parse the function from CloudFunction resource. * * @param {string} cloudFunctionName * A fully-qualified path representing CloudFunction resource. * @returns {string} A string representing the function. */ matchFunctionFromCloudFunctionName(cloudFunctionName: string): string | number; /** * Return a fully-qualified cryptoKey resource name string. * * @param {string} project * @param {string} location * @param {string} key_ring * @param {string} crypto_key * @returns {string} Resource name string. */ cryptoKeyPath(project: string, location: string, keyRing: string, cryptoKey: string): string; /** * Parse the project from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the project. */ matchProjectFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the location from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the location. */ matchLocationFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the key_ring from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the key_ring. */ matchKeyRingFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Parse the crypto_key from CryptoKey resource. * * @param {string} cryptoKeyName * A fully-qualified path representing CryptoKey resource. * @returns {string} A string representing the crypto_key. */ matchCryptoKeyFromCryptoKeyName(cryptoKeyName: string): string | number; /** * Return a fully-qualified location resource name string. * * @param {string} project * @param {string} location * @returns {string} Resource name string. */ locationPath(project: string, location: string): string; /** * Parse the project from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the project. */ matchProjectFromLocationName(locationName: string): string | number; /** * Parse the location from Location resource. * * @param {string} locationName * A fully-qualified path representing Location resource. * @returns {string} A string representing the location. */ matchLocationFromLocationName(locationName: string): string | number; /** * Return a fully-qualified repository resource name string. * * @param {string} project * @param {string} location * @param {string} repository * @returns {string} Resource name string. */ repositoryPath(project: string, location: string, repository: string): string; /** * Parse the project from Repository resource. * * @param {string} repositoryName * A fully-qualified path representing Repository resource. * @returns {string} A string representing the project. */ matchProjectFromRepositoryName(repositoryName: string): string | number; /** * Parse the location from Repository resource. * * @param {string} repositoryName * A fully-qualified path representing Repository resource. * @returns {string} A string representing the location. */ matchLocationFromRepositoryName(repositoryName: string): string | number; /** * Parse the repository from Repository resource. * * @param {string} repositoryName * A fully-qualified path representing Repository resource. * @returns {string} A string representing the repository. */ matchRepositoryFromRepositoryName(repositoryName: string): string | number; /** * Terminate the gRPC channel and close the client. * * The client will no longer be usable and all future behavior is undefined. * @returns {Promise} A promise that resolves when the client is closed. */ close(): Promise; }