Class protos.google.cloud.functions.v1.CloudFunction (1.1.9)

Version 1.1.9

• 3.3.0 (latest)
• 3.1.0
• 2.4.1
• 2.3.1
• 2.2.3
• 1.2.0
• 1.1.9

Represents a CloudFunction.

Package

@google-cloud/functions!

Constructors

(constructor)(properties)

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

Constructs a new CloudFunction.

Parameter

Name	Description
properties	ICloudFunction Properties to set

Properties

availableMemoryMb

public availableMemoryMb: number;

CloudFunction availableMemoryMb.

Property Value

Type	Description
number

buildId

public buildId: string;

CloudFunction buildId.

Property Value

Type	Description
string

description

public description: string;

CloudFunction description.

Property Value

Type	Description
string

entryPoint

public entryPoint: string;

CloudFunction entryPoint.

Property Value

Type	Description
string

environmentVariables

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

CloudFunction environmentVariables.

Property Value

Type	Description
{ [k: string]: string }

eventTrigger

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

CloudFunction eventTrigger.

Property Value

Type	Description
(google.cloud.functions.v1.IEventTrigger|null)

httpsTrigger

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

CloudFunction httpsTrigger.

Property Value

Type	Description
(google.cloud.functions.v1.IHttpsTrigger|null)

ingressSettings

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

CloudFunction ingressSettings.

Property Value

Type	Description
(google.cloud.functions.v1.CloudFunction.IngressSettings|keyof typeof google.cloud.functions.v1.CloudFunction.IngressSettings)

labels

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

CloudFunction labels.

Property Value

Type	Description
{ [k: string]: string }

maxInstances

public maxInstances: number;

CloudFunction maxInstances.

Property Value

Type	Description
number

name

public name: string;

CloudFunction name.

Property Value

Type	Description
string

network

public network: string;

CloudFunction network.

Property Value

Type	Description
string

runtime

public runtime: string;

CloudFunction runtime.

Property Value

Type	Description
string

serviceAccountEmail

public serviceAccountEmail: string;

CloudFunction serviceAccountEmail.

Property Value

Type	Description
string

sourceArchiveUrl

public sourceArchiveUrl?: (string|null);

CloudFunction sourceArchiveUrl.

Property Value

Type	Description
(string|null)

sourceCode

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

CloudFunction sourceCode.

Property Value

Type	Description
("sourceArchiveUrl"|"sourceRepository"|"sourceUploadUrl")

sourceRepository

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

CloudFunction sourceRepository.

Property Value

Type	Description
(google.cloud.functions.v1.ISourceRepository|null)

sourceUploadUrl

public sourceUploadUrl?: (string|null);

CloudFunction sourceUploadUrl.

Property Value

Type	Description
(string|null)

status

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

CloudFunction status.

Property Value

Type	Description
(google.cloud.functions.v1.CloudFunctionStatus|keyof typeof google.cloud.functions.v1.CloudFunctionStatus)

timeout

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

CloudFunction timeout.

Property Value

Type	Description
(google.protobuf.IDuration|null)

trigger

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

CloudFunction trigger.

Property Value

Type	Description
("httpsTrigger"|"eventTrigger")

updateTime

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

CloudFunction updateTime.

Property Value

Type	Description
(google.protobuf.ITimestamp|null)

versionId

public versionId: (number|Long|string);

CloudFunction versionId.

Property Value

Type	Description
(number|Long|string)

vpcConnector

public vpcConnector: string;

CloudFunction vpcConnector.

Property Value

Type	Description
string

vpcConnectorEgressSettings

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

CloudFunction vpcConnectorEgressSettings.

Property Value

Type	Description
(google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings|keyof typeof google.cloud.functions.v1.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

Name	Description
properties	ICloudFunction Properties to set

Returns

Type	Description
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

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from
length	number Message length if known beforehand

Returns

Type	Description
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

Name	Description
reader	($protobuf.Reader|Uint8Array) Reader or buffer to decode from

Returns

Type	Description
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

Name	Description
message	ICloudFunction CloudFunction message or plain object to encode
writer	$protobuf.Writer Writer to encode to

Returns

Type	Description
$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

Name	Description
message	ICloudFunction CloudFunction message or plain object to encode
writer	$protobuf.Writer Writer to encode to

Returns

Type	Description
$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

Name	Description
object	{ [k: string]: any } Plain object

Returns

Type	Description
google.cloud.functions.v1.CloudFunction	CloudFunction

toJSON()

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

Converts this CloudFunction to JSON.

Returns

Type	Description
{ [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

Name	Description
message	google.cloud.functions.v1.CloudFunction CloudFunction
options	$protobuf.IConversionOptions Conversion options

Returns

Type	Description
{ [k: string]: any }	Plain object

verify(message)

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

Verifies a CloudFunction message.

Parameter

Name	Description
message	{ [k: string]: any } Plain object to verify

Returns

Type	Description
(string|null)	null if valid, otherwise the reason why it is not