CloudFunction class
Describes a Cloud Function that contains user computation executed in response to an event.
It encapsulate function and triggers configurations.
Constructors
-
CloudFunction({AutomaticUpdatePolicy? automaticUpdatePolicy, int? availableMemoryMb, Map<
String, String> ? buildEnvironmentVariables, String? buildId, String? buildName, String? buildServiceAccount, String? buildWorkerPool, String? description, String? dockerRegistry, String? dockerRepository, String? entryPoint, Map<String, String> ? environmentVariables, EventTrigger? eventTrigger, HttpsTrigger? httpsTrigger, String? ingressSettings, String? kmsKeyName, Map<String, String> ? labels, int? maxInstances, int? minInstances, String? name, String? network, OnDeployUpdatePolicy? onDeployUpdatePolicy, String? runtime, List<SecretEnvVar> ? secretEnvironmentVariables, List<SecretVolume> ? secretVolumes, String? serviceAccountEmail, String? sourceArchiveUrl, SourceRepository? sourceRepository, String? sourceToken, String? sourceUploadUrl, String? status, String? timeout, String? updateTime, String? versionId, String? vpcConnector, String? vpcConnectorEgressSettings}) - CloudFunction.fromJson(Map json_)
Properties
- automaticUpdatePolicy ↔ AutomaticUpdatePolicy?
-
getter/setter pair
- availableMemoryMb ↔ int?
-
The amount of memory in MB available for a function.
getter/setter pair
-
buildEnvironmentVariables
↔ Map<
String, String> ? -
Build environment variables that shall be available during build time.
getter/setter pair
- buildId ↔ String?
-
The Cloud Build ID of the latest successful deployment of the function.
getter/setter pair
- buildName ↔ String?
-
The Cloud Build Name of the function deployment.
getter/setter pair
- buildServiceAccount ↔ String?
-
A service account the user provides for use with Cloud Build.
getter/setter pair
- buildWorkerPool ↔ String?
-
Name of the Cloud Build Custom Worker Pool that should be used to build
the function.
getter/setter pair
- description ↔ String?
-
User-provided description of a function.
getter/setter pair
- dockerRegistry ↔ String?
-
Docker Registry to use for this deployment.
getter/setter pair
- dockerRepository ↔ String?
-
User managed repository created in Artifact Registry optionally with a
customer managed encryption key.
getter/setter pair
- entryPoint ↔ String?
-
The name of the function (as defined in source code) that will be
executed.
getter/setter pair
-
environmentVariables
↔ Map<
String, String> ? -
Environment variables that shall be available during function execution.
getter/setter pair
- eventTrigger ↔ EventTrigger?
-
A source that fires events in response to a condition in another service.
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- httpsTrigger ↔ HttpsTrigger?
-
An HTTPS endpoint type of source that can be triggered via URL.
getter/setter pair
- ingressSettings ↔ String?
-
The ingress settings for the function, controlling what traffic can reach
it.
Possible string values are:
getter/setter pair
- kmsKeyName ↔ String?
-
Resource name of a KMS crypto key (managed by the user) used to
encrypt/decrypt function resources.
getter/setter pair
-
labels
↔ Map<
String, String> ? -
Labels associated with this Cloud Function.
getter/setter pair
- maxInstances ↔ int?
-
The limit on the maximum number of function instances that may coexist at
a given time.
getter/setter pair
- minInstances ↔ int?
-
A lower bound for the number function instances that may coexist at a
given time.
getter/setter pair
- name ↔ String?
-
A user-defined name of the function.
getter/setter pair
- network ↔ String?
-
Deprecated: use vpc_connector
getter/setter pair
- onDeployUpdatePolicy ↔ OnDeployUpdatePolicy?
-
getter/setter pair
- runtime ↔ String?
-
The runtime in which to run the function.
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
secretEnvironmentVariables
↔ List<
SecretEnvVar> ? -
Secret environment variables configuration.
getter/setter pair
-
secretVolumes
↔ List<
SecretVolume> ? -
Secret volumes configuration.
getter/setter pair
- serviceAccountEmail ↔ String?
-
The email of the function's service account.
getter/setter pair
- sourceArchiveUrl ↔ String?
-
The Google Cloud Storage URL, starting with
gs://
, pointing to the zip archive which contains the function.getter/setter pair - sourceRepository ↔ SourceRepository?
-
Beta Feature The source repository where a function is hosted.
getter/setter pair
- sourceToken ↔ String?
-
Input only.
getter/setter pair
- sourceUploadUrl ↔ String?
-
The Google Cloud Storage signed URL used for source uploading, generated
by calling [google.cloud.functions.v1.GenerateUploadUrl].
getter/setter pair
- status ↔ String?
-
Status of the function deployment.
getter/setter pair
- timeout ↔ String?
-
The function execution timeout.
getter/setter pair
- updateTime ↔ String?
-
The last update timestamp of a Cloud Function.
getter/setter pair
- versionId ↔ String?
-
The version identifier of the Cloud Function.
getter/setter pair
- vpcConnector ↔ String?
-
The VPC Network Connector that this cloud function can connect to.
getter/setter pair
- vpcConnectorEgressSettings ↔ String?
-
The egress settings for the connector, controlling what traffic is
diverted through it.
Possible string values are:
getter/setter pair
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited