Class protos.google.cloud.functions.v1.CloudFunction

Represents a CloudFunction.

Package

@google-cloud/functions

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.functions.v1.ICloudFunction);

Constructs a new CloudFunction.

Parameter
NameDescription
properties ICloudFunction

Properties to set

Properties

availableMemoryMb

public availableMemoryMb: number;

CloudFunction availableMemoryMb.

buildEnvironmentVariables

public buildEnvironmentVariables: { [k: string]: string };

CloudFunction buildEnvironmentVariables.

buildId

public buildId: string;

CloudFunction buildId.

buildName

public buildName: string;

CloudFunction buildName.

buildWorkerPool

public buildWorkerPool: string;

CloudFunction buildWorkerPool.

description

public description: string;

CloudFunction description.

dockerRepository

public dockerRepository: string;

CloudFunction dockerRepository.

entryPoint

public entryPoint: string;

CloudFunction entryPoint.

environmentVariables

public environmentVariables: { [k: string]: string };

CloudFunction environmentVariables.

eventTrigger

public eventTrigger?: (google.cloud.functions.v1.IEventTrigger|null);

CloudFunction eventTrigger.

httpsTrigger

public httpsTrigger?: (google.cloud.functions.v1.IHttpsTrigger|null);

CloudFunction httpsTrigger.

ingressSettings

public ingressSettings: (google.cloud.functions.v1.CloudFunction.IngressSettings|keyof typeof google.cloud.functions.v1.CloudFunction.IngressSettings);

CloudFunction ingressSettings.

kmsKeyName

public kmsKeyName: string;

CloudFunction kmsKeyName.

labels

public labels: { [k: string]: string };

CloudFunction labels.

maxInstances

public maxInstances: number;

CloudFunction maxInstances.

minInstances

public minInstances: number;

CloudFunction minInstances.

name

public name: string;

CloudFunction name.

network

public network: string;

CloudFunction network.

runtime

public runtime: string;

CloudFunction runtime.

secretEnvironmentVariables

public secretEnvironmentVariables: google.cloud.functions.v1.ISecretEnvVar[];

CloudFunction secretEnvironmentVariables.

secretVolumes

public secretVolumes: google.cloud.functions.v1.ISecretVolume[];

CloudFunction secretVolumes.

serviceAccountEmail

public serviceAccountEmail: string;

CloudFunction serviceAccountEmail.

sourceArchiveUrl

public sourceArchiveUrl?: (string|null);

CloudFunction sourceArchiveUrl.

sourceCode

public sourceCode?: ("sourceArchiveUrl"|"sourceRepository"|"sourceUploadUrl");

CloudFunction sourceCode.

sourceRepository

public sourceRepository?: (google.cloud.functions.v1.ISourceRepository|null);

CloudFunction sourceRepository.

sourceToken

public sourceToken: string;

CloudFunction sourceToken.

sourceUploadUrl

public sourceUploadUrl?: (string|null);

CloudFunction sourceUploadUrl.

status

public status: (google.cloud.functions.v1.CloudFunctionStatus|keyof typeof google.cloud.functions.v1.CloudFunctionStatus);

CloudFunction status.

timeout

public timeout?: (google.protobuf.IDuration|null);

CloudFunction timeout.

trigger

public trigger?: ("httpsTrigger"|"eventTrigger");

CloudFunction trigger.

updateTime

public updateTime?: (google.protobuf.ITimestamp|null);

CloudFunction updateTime.

versionId

public versionId: (number|Long|string);

CloudFunction versionId.

vpcConnector

public vpcConnector: string;

CloudFunction vpcConnector.

vpcConnectorEgressSettings

public vpcConnectorEgressSettings: (google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings|keyof typeof google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings);

CloudFunction vpcConnectorEgressSettings.

Methods

create(properties)

public static create(properties?: google.cloud.functions.v1.ICloudFunction): google.cloud.functions.v1.CloudFunction;

Creates a new CloudFunction instance using the specified properties.

Parameter
NameDescription
properties ICloudFunction

Properties to set

Returns
TypeDescription
google.cloud.functions.v1.CloudFunction

CloudFunction instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.functions.v1.CloudFunction;

Decodes a CloudFunction message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.functions.v1.CloudFunction

CloudFunction

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.functions.v1.CloudFunction;

Decodes a CloudFunction message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.functions.v1.CloudFunction

CloudFunction

encode(message, writer)

public static encode(message: google.cloud.functions.v1.ICloudFunction, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CloudFunction message. Does not implicitly messages.

Parameters
NameDescription
message ICloudFunction

CloudFunction message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.functions.v1.ICloudFunction, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified CloudFunction message, length delimited. Does not implicitly messages.

Parameters
NameDescription
message ICloudFunction

CloudFunction message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.functions.v1.CloudFunction;

Creates a CloudFunction message from a plain object. Also converts values to their respective internal types.

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.functions.v1.CloudFunction

CloudFunction

toJSON()

public toJSON(): { [k: string]: any };

Converts this CloudFunction to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.functions.v1.CloudFunction, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from a CloudFunction message. Also converts values to other types if specified.

Parameters
NameDescription
message google.cloud.functions.v1.CloudFunction

CloudFunction

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a CloudFunction message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not