Function(mapping=None, *, ignore_unknown_fields=False, **kwargs)Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
Attributes | |
|---|---|
| Name | Description |
name |
str
A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*
|
description |
str
User-provided description of a function. |
build_config |
google.cloud.functions_v2.types.BuildConfig
Describes the Build step of the function that builds a container from the given source. |
service_config |
google.cloud.functions_v2.types.ServiceConfig
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed). |
event_trigger |
google.cloud.functions_v2.types.EventTrigger
An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service. |
state |
google.cloud.functions_v2.types.Function.State
Output only. State of the function. |
update_time |
google.protobuf.timestamp_pb2.Timestamp
Output only. The last update timestamp of a Cloud Function. |
labels |
MutableMapping[str, str]
Labels associated with this Cloud Function. |
state_messages |
MutableSequence[google.cloud.functions_v2.types.StateMessage]
Output only. State Messages for this Cloud Function. |
environment |
google.cloud.functions_v2.types.Environment
Describe whether the function is 1st Gen or 2nd Gen. |
url |
str
Output only. The deployed url for the function. |
kms_key_name |
str
[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources. It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.
|
Classes
LabelsEntry
LabelsEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)The abstract base class for a message.
| Parameters | |
|---|---|
| Name | Description |
kwargs |
dict
Keys and values corresponding to the fields of the message. |
mapping |
Union[dict,
A dictionary or message to be used to determine the values for this message. |
ignore_unknown_fields |
Optional(bool)
If True, do not raise errors for unknown fields. Only applied if |
State
State(value)Describes the current state of the function.
Values: STATE_UNSPECIFIED (0): Not specified. Invalid state. ACTIVE (1): Function has been successfully deployed and is serving. FAILED (2): Function deployment failed and the function is not serving. DEPLOYING (3): Function is being created or updated. DELETING (4): Function is being deleted. UNKNOWN (5): Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.