CloudFunction

google.cloud.functions.v1. CloudFunction

Represents a CloudFunction.

Constructor

new CloudFunction(propertiesopt)

Constructs a new CloudFunction.

Parameters:
Name Type Attributes Description
properties google.cloud.functions.v1.ICloudFunction <optional>

Properties to set
Implements:
  • ICloudFunction

Members

(static) IngressSettings :number

IngressSettings enum.

Properties:
Name Type Description
INGRESS_SETTINGS_UNSPECIFIED number

INGRESS_SETTINGS_UNSPECIFIED value
ALLOW_ALL number

ALLOW_ALL value
ALLOW_INTERNAL_ONLY number

ALLOW_INTERNAL_ONLY value
ALLOW_INTERNAL_AND_GCLB number

ALLOW_INTERNAL_AND_GCLB value

(static) VpcConnectorEgressSettings :number

VpcConnectorEgressSettings enum.

Properties:
Name Type Description
VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED number

VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED value
PRIVATE_RANGES_ONLY number

PRIVATE_RANGES_ONLY value
ALL_TRAFFIC number

ALL_TRAFFIC value

availableMemoryMb :number

CloudFunction availableMemoryMb.

buildId :string

CloudFunction buildId.

description :string

CloudFunction description.

entryPoint :string

CloudFunction entryPoint.

environmentVariables :Object.<string, string>

CloudFunction environmentVariables.

eventTrigger :google.cloud.functions.v1.IEventTrigger|null|undefined

CloudFunction eventTrigger.

httpsTrigger :google.cloud.functions.v1.IHttpsTrigger|null|undefined

CloudFunction httpsTrigger.

ingressSettings :google.cloud.functions.v1.CloudFunction.IngressSettings

CloudFunction ingressSettings.

labels :Object.<string, string>

CloudFunction labels.

maxInstances :number

CloudFunction maxInstances.

name :string

CloudFunction name.

network :string

CloudFunction network.

runtime :string

CloudFunction runtime.

serviceAccountEmail :string

CloudFunction serviceAccountEmail.

sourceArchiveUrl :string

CloudFunction sourceArchiveUrl.

sourceCode :"sourceArchiveUrl"|"sourceRepository"|"sourceUploadUrl"|undefined

CloudFunction sourceCode.

sourceRepository :google.cloud.functions.v1.ISourceRepository|null|undefined

CloudFunction sourceRepository.

sourceUploadUrl :string

CloudFunction sourceUploadUrl.

status :google.cloud.functions.v1.CloudFunctionStatus

CloudFunction status.

timeout :google.protobuf.IDuration|null|undefined

CloudFunction timeout.

trigger :"httpsTrigger"|"eventTrigger"|undefined

CloudFunction trigger.

updateTime :google.protobuf.ITimestamp|null|undefined

CloudFunction updateTime.

versionId :number|Long

CloudFunction versionId.

vpcConnector :string

CloudFunction vpcConnector.

vpcConnectorEgressSettings :google.cloud.functions.v1.CloudFunction.VpcConnectorEgressSettings

CloudFunction vpcConnectorEgressSettings.

Methods

(static) create(propertiesopt) → {google.cloud.functions.v1.CloudFunction}

Creates a new CloudFunction instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.functions.v1.ICloudFunction <optional>

Properties to set

(static) decode(reader, lengthopt) → {google.cloud.functions.v1.CloudFunction}

Decodes a CloudFunction message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
length number <optional>

Message length if known beforehand
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.functions.v1.CloudFunction}

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

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from
Throws:

  • If the payload is not a reader or valid buffer

    Type
    Error

  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified CloudFunction message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.functions.v1.ICloudFunction

CloudFunction message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.functions.v1.ICloudFunction

CloudFunction message or plain object to encode
writer $protobuf.Writer <optional>

Writer to encode to

(static) fromObject(object) → {google.cloud.functions.v1.CloudFunction}

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

Parameters:
Name Type Description
object Object.<string, *>

Plain object

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.functions.v1.CloudFunction

CloudFunction
options $protobuf.IConversionOptions <optional>

Conversion options

(static) verify(message) → {string|null}

Verifies a CloudFunction message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

toJSON() → {Object.<string, *>}

Converts this CloudFunction to JSON.