Constructor
new Function(propertiesopt)
Constructs a new Function.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.functions.v2.IFunction |
<optional> |
Properties to set |
- Implements:
-
- IFunction
Members
buildConfig
Function buildConfig.
description
Function description.
environment
Function environment.
eventTrigger
Function eventTrigger.
kmsKeyName
Function kmsKeyName.
labels
Function labels.
name
Function name.
serviceConfig
Function serviceConfig.
state
Function state.
stateMessages
Function stateMessages.
updateTime
Function updateTime.
url
Function url.
State
State enum.
Properties:
| Name | Type | Description |
|---|---|---|
STATE_UNSPECIFIED |
number |
STATE_UNSPECIFIED value |
ACTIVE |
number |
ACTIVE value |
FAILED |
number |
FAILED value |
DEPLOYING |
number |
DEPLOYING value |
DELETING |
number |
DELETING value |
UNKNOWN |
number |
UNKNOWN value |
Methods
toJSON() → {Object.<string, *>}
Converts this Function to JSON.
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
JSON object |
(static) create(propertiesopt) → {google.cloud.functions.v2.Function}
Creates a new Function instance using the specified properties.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
properties |
google.cloud.functions.v2.IFunction |
<optional> |
Properties to set |
Returns:
| Type | Description |
|---|---|
| google.cloud.functions.v2.Function |
Function instance |
(static) decode(reader, lengthopt) → {google.cloud.functions.v2.Function}
Decodes a Function 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.v2.Function |
Function |
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.v2.Function}
Decodes a Function 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.v2.Function |
Function |
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 Function message. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.functions.v2.IFunction |
Function 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 Function message, length delimited. Does not implicitly verify messages.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.functions.v2.IFunction |
Function 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.v2.Function}
Creates a Function 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.v2.Function |
Function |
(static) getTypeUrl(typeUrlPrefixopt) → {string}
Gets the default type url for Function
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
typeUrlPrefix |
string |
<optional> |
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns:
| Type | Description |
|---|---|
| string |
The default type url |
(static) toObject(message, optionsopt) → {Object.<string, *>}
Creates a plain object from a Function message. Also converts values to other types if specified.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
message |
google.cloud.functions.v2.Function |
Function |
|
options |
$protobuf.IConversionOptions |
<optional> |
Conversion options |
Returns:
| Type | Description |
|---|---|
| Object.<string, *> |
Plain object |
(static) verify(message) → {string|null}
Verifies a Function message.
Parameters:
| Name | Type | Description |
|---|---|---|
message |
Object.<string, *> |
Plain object to verify |
Returns:
| Type | Description |
|---|---|
| string | null |
|