Function

import type { Function } from "https://googleapis.deno.dev/v1/cloudfunctions:v2.ts";

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.

interface Function {

buildConfig?: BuildConfig;

readonly createTime?: Date;

description?: string;

environment?: "ENVIRONMENT_UNSPECIFIED" | "GEN_1" | "GEN_2";

eventTrigger?: EventTrigger;

kmsKeyName?: string;

labels?: {

[key: string]: string;

};

name?: string;

readonly satisfiesPzs?: boolean;

serviceConfig?: ServiceConfig;

readonly state?:

| "STATE_UNSPECIFIED"

| "ACTIVE"

| "FAILED"

| "DEPLOYING"

| "DELETING"

| "UNKNOWN";

readonly stateMessages?: GoogleCloudFunctionsV2StateMessage[];

readonly updateTime?: Date;

readonly upgradeInfo?: UpgradeInfo;

readonly url?: string;

}

§Properties

buildConfig?: BuildConfig

[src]

Describes the Build step of the function that builds a container from the given source.

readonly createTime?: Date

[src]

Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.

description?: string

[src]

User-provided description of a function.

environment?: "ENVIRONMENT_UNSPECIFIED" | "GEN_1" | "GEN_2"

[src]

Describe whether the function is 1st Gen or 2nd Gen.

eventTrigger?: EventTrigger

[src]

An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.

kmsKeyName?: string

[src]

[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

labels?: {

[key: string]: string;

}

[src]

Labels associated with this Cloud Function.

name?: string

[src]

A user-defined name of the function. Function names must be unique globally and match pattern projects/*\/locations/*\/functions/*

readonly satisfiesPzs?: boolean

[src]

Output only. Reserved for future use.

serviceConfig?: ServiceConfig

[src]

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

[src]

Output only. State of the function.

readonly stateMessages?: GoogleCloudFunctionsV2StateMessage[]

[src]

Output only. State Messages for this Cloud Function.

readonly updateTime?: Date

[src]

Output only. The last update timestamp of a Cloud Function.

readonly upgradeInfo?: UpgradeInfo

[src]

Output only. UpgradeInfo for this Cloud Function

readonly url?: string

[src]

Output only. The deployed url for the function.