@google-cloud/functions
Version:
Functions client for Node.js
938 lines (753 loc) • 1.22 MB
TypeScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
import type {protobuf as $protobuf} from "google-gax";
import Long = require("long");
/** Namespace google. */
export namespace google {
/** Namespace cloud. */
namespace cloud {
/** Namespace functions. */
namespace functions {
/** Namespace v1. */
namespace v1 {
/** Represents a CloudFunctionsService */
class CloudFunctionsService extends $protobuf.rpc.Service {
/**
* Constructs a new CloudFunctionsService service.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
*/
constructor(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean);
/**
* Creates new CloudFunctionsService service using the specified rpc implementation.
* @param rpcImpl RPC implementation
* @param [requestDelimited=false] Whether requests are length-delimited
* @param [responseDelimited=false] Whether responses are length-delimited
* @returns RPC service. Useful where requests and/or responses are streamed.
*/
public static create(rpcImpl: $protobuf.RPCImpl, requestDelimited?: boolean, responseDelimited?: boolean): CloudFunctionsService;
/**
* Calls ListFunctions.
* @param request ListFunctionsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and ListFunctionsResponse
*/
public listFunctions(request: google.cloud.functions.v1.IListFunctionsRequest, callback: google.cloud.functions.v1.CloudFunctionsService.ListFunctionsCallback): void;
/**
* Calls ListFunctions.
* @param request ListFunctionsRequest message or plain object
* @returns Promise
*/
public listFunctions(request: google.cloud.functions.v1.IListFunctionsRequest): Promise<google.cloud.functions.v1.ListFunctionsResponse>;
/**
* Calls GetFunction.
* @param request GetFunctionRequest message or plain object
* @param callback Node-style callback called with the error, if any, and CloudFunction
*/
public getFunction(request: google.cloud.functions.v1.IGetFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.GetFunctionCallback): void;
/**
* Calls GetFunction.
* @param request GetFunctionRequest message or plain object
* @returns Promise
*/
public getFunction(request: google.cloud.functions.v1.IGetFunctionRequest): Promise<google.cloud.functions.v1.CloudFunction>;
/**
* Calls CreateFunction.
* @param request CreateFunctionRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public createFunction(request: google.cloud.functions.v1.ICreateFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.CreateFunctionCallback): void;
/**
* Calls CreateFunction.
* @param request CreateFunctionRequest message or plain object
* @returns Promise
*/
public createFunction(request: google.cloud.functions.v1.ICreateFunctionRequest): Promise<google.longrunning.Operation>;
/**
* Calls UpdateFunction.
* @param request UpdateFunctionRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public updateFunction(request: google.cloud.functions.v1.IUpdateFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.UpdateFunctionCallback): void;
/**
* Calls UpdateFunction.
* @param request UpdateFunctionRequest message or plain object
* @returns Promise
*/
public updateFunction(request: google.cloud.functions.v1.IUpdateFunctionRequest): Promise<google.longrunning.Operation>;
/**
* Calls DeleteFunction.
* @param request DeleteFunctionRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Operation
*/
public deleteFunction(request: google.cloud.functions.v1.IDeleteFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.DeleteFunctionCallback): void;
/**
* Calls DeleteFunction.
* @param request DeleteFunctionRequest message or plain object
* @returns Promise
*/
public deleteFunction(request: google.cloud.functions.v1.IDeleteFunctionRequest): Promise<google.longrunning.Operation>;
/**
* Calls CallFunction.
* @param request CallFunctionRequest message or plain object
* @param callback Node-style callback called with the error, if any, and CallFunctionResponse
*/
public callFunction(request: google.cloud.functions.v1.ICallFunctionRequest, callback: google.cloud.functions.v1.CloudFunctionsService.CallFunctionCallback): void;
/**
* Calls CallFunction.
* @param request CallFunctionRequest message or plain object
* @returns Promise
*/
public callFunction(request: google.cloud.functions.v1.ICallFunctionRequest): Promise<google.cloud.functions.v1.CallFunctionResponse>;
/**
* Calls GenerateUploadUrl.
* @param request GenerateUploadUrlRequest message or plain object
* @param callback Node-style callback called with the error, if any, and GenerateUploadUrlResponse
*/
public generateUploadUrl(request: google.cloud.functions.v1.IGenerateUploadUrlRequest, callback: google.cloud.functions.v1.CloudFunctionsService.GenerateUploadUrlCallback): void;
/**
* Calls GenerateUploadUrl.
* @param request GenerateUploadUrlRequest message or plain object
* @returns Promise
*/
public generateUploadUrl(request: google.cloud.functions.v1.IGenerateUploadUrlRequest): Promise<google.cloud.functions.v1.GenerateUploadUrlResponse>;
/**
* Calls GenerateDownloadUrl.
* @param request GenerateDownloadUrlRequest message or plain object
* @param callback Node-style callback called with the error, if any, and GenerateDownloadUrlResponse
*/
public generateDownloadUrl(request: google.cloud.functions.v1.IGenerateDownloadUrlRequest, callback: google.cloud.functions.v1.CloudFunctionsService.GenerateDownloadUrlCallback): void;
/**
* Calls GenerateDownloadUrl.
* @param request GenerateDownloadUrlRequest message or plain object
* @returns Promise
*/
public generateDownloadUrl(request: google.cloud.functions.v1.IGenerateDownloadUrlRequest): Promise<google.cloud.functions.v1.GenerateDownloadUrlResponse>;
/**
* Calls SetIamPolicy.
* @param request SetIamPolicyRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Policy
*/
public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest, callback: google.cloud.functions.v1.CloudFunctionsService.SetIamPolicyCallback): void;
/**
* Calls SetIamPolicy.
* @param request SetIamPolicyRequest message or plain object
* @returns Promise
*/
public setIamPolicy(request: google.iam.v1.ISetIamPolicyRequest): Promise<google.iam.v1.Policy>;
/**
* Calls GetIamPolicy.
* @param request GetIamPolicyRequest message or plain object
* @param callback Node-style callback called with the error, if any, and Policy
*/
public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest, callback: google.cloud.functions.v1.CloudFunctionsService.GetIamPolicyCallback): void;
/**
* Calls GetIamPolicy.
* @param request GetIamPolicyRequest message or plain object
* @returns Promise
*/
public getIamPolicy(request: google.iam.v1.IGetIamPolicyRequest): Promise<google.iam.v1.Policy>;
/**
* Calls TestIamPermissions.
* @param request TestIamPermissionsRequest message or plain object
* @param callback Node-style callback called with the error, if any, and TestIamPermissionsResponse
*/
public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest, callback: google.cloud.functions.v1.CloudFunctionsService.TestIamPermissionsCallback): void;
/**
* Calls TestIamPermissions.
* @param request TestIamPermissionsRequest message or plain object
* @returns Promise
*/
public testIamPermissions(request: google.iam.v1.ITestIamPermissionsRequest): Promise<google.iam.v1.TestIamPermissionsResponse>;
}
namespace CloudFunctionsService {
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|listFunctions}.
* @param error Error, if any
* @param [response] ListFunctionsResponse
*/
type ListFunctionsCallback = (error: (Error|null), response?: google.cloud.functions.v1.ListFunctionsResponse) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|getFunction}.
* @param error Error, if any
* @param [response] CloudFunction
*/
type GetFunctionCallback = (error: (Error|null), response?: google.cloud.functions.v1.CloudFunction) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|createFunction}.
* @param error Error, if any
* @param [response] Operation
*/
type CreateFunctionCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|updateFunction}.
* @param error Error, if any
* @param [response] Operation
*/
type UpdateFunctionCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|deleteFunction}.
* @param error Error, if any
* @param [response] Operation
*/
type DeleteFunctionCallback = (error: (Error|null), response?: google.longrunning.Operation) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|callFunction}.
* @param error Error, if any
* @param [response] CallFunctionResponse
*/
type CallFunctionCallback = (error: (Error|null), response?: google.cloud.functions.v1.CallFunctionResponse) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|generateUploadUrl}.
* @param error Error, if any
* @param [response] GenerateUploadUrlResponse
*/
type GenerateUploadUrlCallback = (error: (Error|null), response?: google.cloud.functions.v1.GenerateUploadUrlResponse) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|generateDownloadUrl}.
* @param error Error, if any
* @param [response] GenerateDownloadUrlResponse
*/
type GenerateDownloadUrlCallback = (error: (Error|null), response?: google.cloud.functions.v1.GenerateDownloadUrlResponse) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|setIamPolicy}.
* @param error Error, if any
* @param [response] Policy
*/
type SetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|getIamPolicy}.
* @param error Error, if any
* @param [response] Policy
*/
type GetIamPolicyCallback = (error: (Error|null), response?: google.iam.v1.Policy) => void;
/**
* Callback as used by {@link google.cloud.functions.v1.CloudFunctionsService|testIamPermissions}.
* @param error Error, if any
* @param [response] TestIamPermissionsResponse
*/
type TestIamPermissionsCallback = (error: (Error|null), response?: google.iam.v1.TestIamPermissionsResponse) => void;
}
/** Properties of a CloudFunction. */
interface ICloudFunction {
/** CloudFunction name */
name?: (string|null);
/** CloudFunction description */
description?: (string|null);
/** CloudFunction sourceArchiveUrl */
sourceArchiveUrl?: (string|null);
/** CloudFunction sourceRepository */
sourceRepository?: (google.cloud.functions.v1.ISourceRepository|null);
/** CloudFunction sourceUploadUrl */
sourceUploadUrl?: (string|null);
/** CloudFunction httpsTrigger */
httpsTrigger?: (google.cloud.functions.v1.IHttpsTrigger|null);
/** CloudFunction eventTrigger */
eventTrigger?: (google.cloud.functions.v1.IEventTrigger|null);
/** CloudFunction status */
status?: (google.cloud.functions.v1.CloudFunctionStatus|keyof typeof google.cloud.functions.v1.CloudFunctionStatus|null);
/** CloudFunction entryPoint */
entryPoint?: (string|null);
/** CloudFunction runtime */
runtime?: (string|null);
/** CloudFunction timeout */
timeout?: (google.protobuf.IDuration|null);
/** CloudFunction availableMemoryMb */
availableMemoryMb?: (number|null);
/** CloudFunction serviceAccountEmail */
serviceAccountEmail?: (string|null);
/** CloudFunction updateTime */
updateTime?: (google.protobuf.ITimestamp|null);
/** CloudFunction versionId */
versionId?: (number|Long|string|null);
/** CloudFunction labels */
labels?: ({ [k: string]: string }|null);
/** CloudFunction environmentVariables */
environmentVariables?: ({ [k: string]: string }|null);
/** CloudFunction buildEnvironmentVariables */
buildEnvironmentVariables?: ({ [k: string]: string }|null);
/** CloudFunction network */
network?: (string|null);
/** CloudFunction maxInstances */
maxInstances?: (number|null);
/** CloudFunction minInstances */
minInstances?: (number|null);
/** CloudFunction vpcConnector */
vpcConnector?: (string|null);
/** CloudFunction vpcConnectorEgressSettings */
vpcConnectorEgressSettings?: (google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings|keyof typeof google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings|null);
/** CloudFunction ingressSettings */
ingressSettings?: (google.cloud.functions.v1.CloudFunction.IngressSettings|keyof typeof google.cloud.functions.v1.CloudFunction.IngressSettings|null);
/** CloudFunction kmsKeyName */
kmsKeyName?: (string|null);
/** CloudFunction buildWorkerPool */
buildWorkerPool?: (string|null);
/** CloudFunction buildId */
buildId?: (string|null);
/** CloudFunction buildName */
buildName?: (string|null);
/** CloudFunction secretEnvironmentVariables */
secretEnvironmentVariables?: (google.cloud.functions.v1.ISecretEnvVar[]|null);
/** CloudFunction secretVolumes */
secretVolumes?: (google.cloud.functions.v1.ISecretVolume[]|null);
/** CloudFunction sourceToken */
sourceToken?: (string|null);
/** CloudFunction dockerRepository */
dockerRepository?: (string|null);
/** CloudFunction dockerRegistry */
dockerRegistry?: (google.cloud.functions.v1.CloudFunction.DockerRegistry|keyof typeof google.cloud.functions.v1.CloudFunction.DockerRegistry|null);
/** CloudFunction automaticUpdatePolicy */
automaticUpdatePolicy?: (google.cloud.functions.v1.CloudFunction.IAutomaticUpdatePolicy|null);
/** CloudFunction onDeployUpdatePolicy */
onDeployUpdatePolicy?: (google.cloud.functions.v1.CloudFunction.IOnDeployUpdatePolicy|null);
/** CloudFunction buildServiceAccount */
buildServiceAccount?: (string|null);
}
/** Represents a CloudFunction. */
class CloudFunction implements ICloudFunction {
/**
* Constructs a new CloudFunction.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.functions.v1.ICloudFunction);
/** CloudFunction name. */
public name: string;
/** CloudFunction description. */
public description: string;
/** CloudFunction sourceArchiveUrl. */
public sourceArchiveUrl?: (string|null);
/** CloudFunction sourceRepository. */
public sourceRepository?: (google.cloud.functions.v1.ISourceRepository|null);
/** CloudFunction sourceUploadUrl. */
public sourceUploadUrl?: (string|null);
/** CloudFunction httpsTrigger. */
public httpsTrigger?: (google.cloud.functions.v1.IHttpsTrigger|null);
/** CloudFunction eventTrigger. */
public eventTrigger?: (google.cloud.functions.v1.IEventTrigger|null);
/** CloudFunction status. */
public status: (google.cloud.functions.v1.CloudFunctionStatus|keyof typeof google.cloud.functions.v1.CloudFunctionStatus);
/** CloudFunction entryPoint. */
public entryPoint: string;
/** CloudFunction runtime. */
public runtime: string;
/** CloudFunction timeout. */
public timeout?: (google.protobuf.IDuration|null);
/** CloudFunction availableMemoryMb. */
public availableMemoryMb: number;
/** CloudFunction serviceAccountEmail. */
public serviceAccountEmail: string;
/** CloudFunction updateTime. */
public updateTime?: (google.protobuf.ITimestamp|null);
/** CloudFunction versionId. */
public versionId: (number|Long|string);
/** CloudFunction labels. */
public labels: { [k: string]: string };
/** CloudFunction environmentVariables. */
public environmentVariables: { [k: string]: string };
/** CloudFunction buildEnvironmentVariables. */
public buildEnvironmentVariables: { [k: string]: string };
/** CloudFunction network. */
public network: string;
/** CloudFunction maxInstances. */
public maxInstances: number;
/** CloudFunction minInstances. */
public minInstances: number;
/** CloudFunction vpcConnector. */
public vpcConnector: string;
/** CloudFunction vpcConnectorEgressSettings. */
public vpcConnectorEgressSettings: (google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings|keyof typeof google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings);
/** CloudFunction ingressSettings. */
public ingressSettings: (google.cloud.functions.v1.CloudFunction.IngressSettings|keyof typeof google.cloud.functions.v1.CloudFunction.IngressSettings);
/** CloudFunction kmsKeyName. */
public kmsKeyName: string;
/** CloudFunction buildWorkerPool. */
public buildWorkerPool: string;
/** CloudFunction buildId. */
public buildId: string;
/** CloudFunction buildName. */
public buildName: string;
/** CloudFunction secretEnvironmentVariables. */
public secretEnvironmentVariables: google.cloud.functions.v1.ISecretEnvVar[];
/** CloudFunction secretVolumes. */
public secretVolumes: google.cloud.functions.v1.ISecretVolume[];
/** CloudFunction sourceToken. */
public sourceToken: string;
/** CloudFunction dockerRepository. */
public dockerRepository: string;
/** CloudFunction dockerRegistry. */
public dockerRegistry: (google.cloud.functions.v1.CloudFunction.DockerRegistry|keyof typeof google.cloud.functions.v1.CloudFunction.DockerRegistry);
/** CloudFunction automaticUpdatePolicy. */
public automaticUpdatePolicy?: (google.cloud.functions.v1.CloudFunction.IAutomaticUpdatePolicy|null);
/** CloudFunction onDeployUpdatePolicy. */
public onDeployUpdatePolicy?: (google.cloud.functions.v1.CloudFunction.IOnDeployUpdatePolicy|null);
/** CloudFunction buildServiceAccount. */
public buildServiceAccount: string;
/** CloudFunction sourceCode. */
public sourceCode?: ("sourceArchiveUrl"|"sourceRepository"|"sourceUploadUrl");
/** CloudFunction trigger. */
public trigger?: ("httpsTrigger"|"eventTrigger");
/** CloudFunction runtimeUpdatePolicy. */
public runtimeUpdatePolicy?: ("automaticUpdatePolicy"|"onDeployUpdatePolicy");
/**
* Creates a new CloudFunction instance using the specified properties.
* @param [properties] Properties to set
* @returns CloudFunction instance
*/
public static create(properties?: google.cloud.functions.v1.ICloudFunction): google.cloud.functions.v1.CloudFunction;
/**
* Encodes the specified CloudFunction message. Does not implicitly {@link google.cloud.functions.v1.CloudFunction.verify|verify} messages.
* @param message CloudFunction message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.functions.v1.ICloudFunction, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified CloudFunction message, length delimited. Does not implicitly {@link google.cloud.functions.v1.CloudFunction.verify|verify} messages.
* @param message CloudFunction message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.functions.v1.ICloudFunction, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a CloudFunction message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns CloudFunction
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.functions.v1.CloudFunction;
/**
* Decodes a CloudFunction message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns CloudFunction
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.functions.v1.CloudFunction;
/**
* Verifies a CloudFunction message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a CloudFunction message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns CloudFunction
*/
public static fromObject(object: { [k: string]: any }): google.cloud.functions.v1.CloudFunction;
/**
* Creates a plain object from a CloudFunction message. Also converts values to other types if specified.
* @param message CloudFunction
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.functions.v1.CloudFunction, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this CloudFunction to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for CloudFunction
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
namespace CloudFunction {
/** VpcConnectorEgressSettings enum. */
enum VpcConnectorEgressSettings {
VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0,
PRIVATE_RANGES_ONLY = 1,
ALL_TRAFFIC = 2
}
/** IngressSettings enum. */
enum IngressSettings {
INGRESS_SETTINGS_UNSPECIFIED = 0,
ALLOW_ALL = 1,
ALLOW_INTERNAL_ONLY = 2,
ALLOW_INTERNAL_AND_GCLB = 3
}
/** DockerRegistry enum. */
enum DockerRegistry {
DOCKER_REGISTRY_UNSPECIFIED = 0,
CONTAINER_REGISTRY = 1,
ARTIFACT_REGISTRY = 2
}
/** Properties of an AutomaticUpdatePolicy. */
interface IAutomaticUpdatePolicy {
}
/** Represents an AutomaticUpdatePolicy. */
class AutomaticUpdatePolicy implements IAutomaticUpdatePolicy {
/**
* Constructs a new AutomaticUpdatePolicy.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.functions.v1.CloudFunction.IAutomaticUpdatePolicy);
/**
* Creates a new AutomaticUpdatePolicy instance using the specified properties.
* @param [properties] Properties to set
* @returns AutomaticUpdatePolicy instance
*/
public static create(properties?: google.cloud.functions.v1.CloudFunction.IAutomaticUpdatePolicy): google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy;
/**
* Encodes the specified AutomaticUpdatePolicy message. Does not implicitly {@link google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy.verify|verify} messages.
* @param message AutomaticUpdatePolicy message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.functions.v1.CloudFunction.IAutomaticUpdatePolicy, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified AutomaticUpdatePolicy message, length delimited. Does not implicitly {@link google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy.verify|verify} messages.
* @param message AutomaticUpdatePolicy message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.functions.v1.CloudFunction.IAutomaticUpdatePolicy, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an AutomaticUpdatePolicy message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns AutomaticUpdatePolicy
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy;
/**
* Decodes an AutomaticUpdatePolicy message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns AutomaticUpdatePolicy
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy;
/**
* Verifies an AutomaticUpdatePolicy message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an AutomaticUpdatePolicy message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns AutomaticUpdatePolicy
*/
public static fromObject(object: { [k: string]: any }): google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy;
/**
* Creates a plain object from an AutomaticUpdatePolicy message. Also converts values to other types if specified.
* @param message AutomaticUpdatePolicy
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.functions.v1.CloudFunction.AutomaticUpdatePolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this AutomaticUpdatePolicy to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for AutomaticUpdatePolicy
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of an OnDeployUpdatePolicy. */
interface IOnDeployUpdatePolicy {
/** OnDeployUpdatePolicy runtimeVersion */
runtimeVersion?: (string|null);
}
/** Represents an OnDeployUpdatePolicy. */
class OnDeployUpdatePolicy implements IOnDeployUpdatePolicy {
/**
* Constructs a new OnDeployUpdatePolicy.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.functions.v1.CloudFunction.IOnDeployUpdatePolicy);
/** OnDeployUpdatePolicy runtimeVersion. */
public runtimeVersion: string;
/**
* Creates a new OnDeployUpdatePolicy instance using the specified properties.
* @param [properties] Properties to set
* @returns OnDeployUpdatePolicy instance
*/
public static create(properties?: google.cloud.functions.v1.CloudFunction.IOnDeployUpdatePolicy): google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy;
/**
* Encodes the specified OnDeployUpdatePolicy message. Does not implicitly {@link google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy.verify|verify} messages.
* @param message OnDeployUpdatePolicy message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.functions.v1.CloudFunction.IOnDeployUpdatePolicy, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified OnDeployUpdatePolicy message, length delimited. Does not implicitly {@link google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy.verify|verify} messages.
* @param message OnDeployUpdatePolicy message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.functions.v1.CloudFunction.IOnDeployUpdatePolicy, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes an OnDeployUpdatePolicy message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns OnDeployUpdatePolicy
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy;
/**
* Decodes an OnDeployUpdatePolicy message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns OnDeployUpdatePolicy
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy;
/**
* Verifies an OnDeployUpdatePolicy message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates an OnDeployUpdatePolicy message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns OnDeployUpdatePolicy
*/
public static fromObject(object: { [k: string]: any }): google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy;
/**
* Creates a plain object from an OnDeployUpdatePolicy message. Also converts values to other types if specified.
* @param message OnDeployUpdatePolicy
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.functions.v1.CloudFunction.OnDeployUpdatePolicy, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this OnDeployUpdatePolicy to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for OnDeployUpdatePolicy
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
}
/** Properties of a SourceRepository. */
interface ISourceRepository {
/** SourceRepository url */
url?: (string|null);
/** SourceRepository deployedUrl */
deployedUrl?: (string|null);
}
/** Represents a SourceRepository. */
class SourceRepository implements ISourceRepository {
/**
* Constructs a new SourceRepository.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.functions.v1.ISourceRepository);
/** SourceRepository url. */
public url: string;
/** SourceRepository deployedUrl. */
public deployedUrl: string;
/**
* Creates a new SourceRepository instance using the specified properties.
* @param [properties] Properties to set
* @returns SourceRepository instance
*/
public static create(properties?: google.cloud.functions.v1.ISourceRepository): google.cloud.functions.v1.SourceRepository;
/**
* Encodes the specified SourceRepository message. Does not implicitly {@link google.cloud.functions.v1.SourceRepository.verify|verify} messages.
* @param message SourceRepository message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encode(message: google.cloud.functions.v1.ISourceRepository, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Encodes the specified SourceRepository message, length delimited. Does not implicitly {@link google.cloud.functions.v1.SourceRepository.verify|verify} messages.
* @param message SourceRepository message or plain object to encode
* @param [writer] Writer to encode to
* @returns Writer
*/
public static encodeDelimited(message: google.cloud.functions.v1.ISourceRepository, writer?: $protobuf.Writer): $protobuf.Writer;
/**
* Decodes a SourceRepository message from the specified reader or buffer.
* @param reader Reader or buffer to decode from
* @param [length] Message length if known beforehand
* @returns SourceRepository
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.functions.v1.SourceRepository;
/**
* Decodes a SourceRepository message from the specified reader or buffer, length delimited.
* @param reader Reader or buffer to decode from
* @returns SourceRepository
* @throws {Error} If the payload is not a reader or valid buffer
* @throws {$protobuf.util.ProtocolError} If required fields are missing
*/
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.functions.v1.SourceRepository;
/**
* Verifies a SourceRepository message.
* @param message Plain object to verify
* @returns `null` if valid, otherwise the reason why it is not
*/
public static verify(message: { [k: string]: any }): (string|null);
/**
* Creates a SourceRepository message from a plain object. Also converts values to their respective internal types.
* @param object Plain object
* @returns SourceRepository
*/
public static fromObject(object: { [k: string]: any }): google.cloud.functions.v1.SourceRepository;
/**
* Creates a plain object from a SourceRepository message. Also converts values to other types if specified.
* @param message SourceRepository
* @param [options] Conversion options
* @returns Plain object
*/
public static toObject(message: google.cloud.functions.v1.SourceRepository, options?: $protobuf.IConversionOptions): { [k: string]: any };
/**
* Converts this SourceRepository to JSON.
* @returns JSON object
*/
public toJSON(): { [k: string]: any };
/**
* Gets the default type url for SourceRepository
* @param [typeUrlPrefix] your custom typeUrlPrefix(default "type.googleapis.com")
* @returns The default type url
*/
public static getTypeUrl(typeUrlPrefix?: string): string;
}
/** Properties of a HttpsTrigger. */
interface IHttpsTrigger {
/** HttpsTrigger url */
url?: (string|null);
/** HttpsTrigger securityLevel */
securityLevel?: (google.cloud.functions.v1.HttpsTrigger.SecurityLevel|keyof typeof google.cloud.functions.v1.HttpsTrigger.SecurityLevel|null);
}
/** Represents a HttpsTrigger. */
class HttpsTrigger implements IHttpsTrigger {
/**
* Constructs a new HttpsTrigger.
* @param [properties] Properties to set
*/
constructor(properties?: google.cloud.functions.v1.IHttpsTrigger);
/** HttpsTrigger url. */
public url: string;
/** HttpsTrigger securit