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

IngressSettings

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

VpcConnectorEgressSettings

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

CloudFunction availableMemoryMb.

buildId

CloudFunction buildId.

description

CloudFunction description.

entryPoint

CloudFunction entryPoint.

environmentVariables

CloudFunction environmentVariables.

eventTrigger

CloudFunction eventTrigger.

httpsTrigger

CloudFunction httpsTrigger.

ingressSettings

CloudFunction ingressSettings.

labels

CloudFunction labels.

maxInstances

CloudFunction maxInstances.

name

CloudFunction name.

network

CloudFunction network.

runtime

CloudFunction runtime.

serviceAccountEmail

CloudFunction serviceAccountEmail.

sourceArchiveUrl

CloudFunction sourceArchiveUrl.

sourceCode

CloudFunction sourceCode.

sourceRepository

CloudFunction sourceRepository.

sourceUploadUrl

CloudFunction sourceUploadUrl.

status

CloudFunction status.

timeout

CloudFunction timeout.

trigger

CloudFunction trigger.

updateTime

CloudFunction updateTime.

versionId

CloudFunction versionId.

vpcConnector

CloudFunction vpcConnector.

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

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

CloudFunction instance

(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

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

CloudFunction

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

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

CloudFunction

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

Returns:
Type Description
$protobuf.Writer

Writer

(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

Returns:
Type Description
$protobuf.Writer

Writer

(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

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

CloudFunction

(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

Returns:
Type Description
Object.<string, *>

Plain object

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

Verifies a CloudFunction message.

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

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not

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

Converts this CloudFunction to JSON.

Returns:
Type Description
Object.<string, *>

JSON object