FunctionArgs class

The set of arguments for Function. The set of arguments for Function.

Constructors

FunctionArgs({Input<int>? availableMemoryMb, Input<Map<String, String>>? buildEnvironmentVariables, Input<String>? buildWorkerPool, Input<String>? description, Input<FunctionDockerRegistry>? dockerRegistry, Input<String>? dockerRepository, Input<String>? entryPoint, Input<Map<String, String>>? environmentVariables, Input<EventTrigger>? eventTrigger, Input<HttpsTrigger>? httpsTrigger, Input<FunctionIngressSettings>? ingressSettings, Input<String>? kmsKeyName, Input<Map<String, String>>? labels, Input<String>? location, Input<int>? maxInstances, Input<int>? minInstances, Input<String>? name, Input<String>? network, Input<String>? project, Input<String>? runtime, Input<List<SecretEnvVar>>? secretEnvironmentVariables, Input<List<SecretVolume>>? secretVolumes, Input<String>? serviceAccountEmail, Input<String>? sourceArchiveUrl, Input<SourceRepository>? sourceRepository, Input<String>? sourceToken, Input<String>? sourceUploadUrl, Input<String>? timeout, Input<String>? vpcConnector, Input<FunctionVpcConnectorEgressSettings>? vpcConnectorEgressSettings})
Creates a new FunctionArgs. availableMemoryMb The amount of memory in MB available for a function. Defaults to 256MB. buildEnvironmentVariables Build environment variables that shall be available during build time. buildWorkerPool Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project. description User-provided description of a function. dockerRegistry Docker Registry to use for this deployment. If docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments. dockerRepository User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'. entryPoint The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified. environmentVariables Environment variables that shall be available during function execution. eventTrigger A source that fires events in response to a condition in another service. httpsTrigger An HTTPS endpoint type of source that can be triggered via URL. ingressSettings The ingress settings for the function, controlling what traffic can reach it. kmsKeyName 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}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user. labels Labels associated with this Cloud Function. location Optional. maxInstances The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details. minInstances A lower bound for the number function instances that may coexist at a given time. name A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/* network Deprecated: use vpc_connector project Optional. runtime The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference. secretEnvironmentVariables Secret environment variables configuration. secretVolumes Secret volumes configuration. serviceAccountEmail The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com. sourceArchiveUrl The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function. sourceRepository Beta Feature The source repository where a function is hosted. sourceToken Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. sourceUploadUrl The Google Cloud Storage signed URL used for source uploading, generated by calling google.cloud.functions.v1.GenerateUploadUrl. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List) timeout The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds. vpcConnector The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects. vpcConnectorEgressSettings The egress settings for the connector, controlling what traffic is diverted through it.
const
FunctionArgs.fromMap(Map<String, dynamic> map)
factory

Properties

availableMemoryMb → Input<int>?
The amount of memory in MB available for a function. Defaults to 256MB.
final
buildEnvironmentVariables → Input<Map<String, String>>?
Build environment variables that shall be available during build time.
final
buildWorkerPool → Input<String>?
Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool. If the project id is not the same as the function, then the Cloud Functions Service Agent (service-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
final
description → Input<String>?
User-provided description of a function.
final
dockerRegistry → Input<FunctionDockerRegistry>?
Docker Registry to use for this deployment. If docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.
final
dockerRepository → Input<String>?
User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.
final
entryPoint → Input<String>?
The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.
final
environmentVariables → Input<Map<String, String>>?
Environment variables that shall be available during function execution.
final
eventTrigger → Input<EventTrigger>?
A source that fires events in response to a condition in another service.
final
hashCode → int
The hash code for this object.
no setterinherited
httpsTrigger → Input<HttpsTrigger>?
An HTTPS endpoint type of source that can be triggered via URL.
final
ingressSettings → Input<FunctionIngressSettings>?
The ingress settings for the function, controlling what traffic can reach it.
final
kmsKeyName → Input<String>?
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}. If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key. The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred). 1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image. 2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil. Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.
final
labels → Input<Map<String, String>>?
Labels associated with this Cloud Function.
final
location → Input<String>?
final
maxInstances → Input<int>?
The limit on the maximum number of function instances that may coexist at a given time. In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate. See the Max Instances Guide for more details.
final
minInstances → Input<int>?
A lower bound for the number function instances that may coexist at a given time.
final
name → Input<String>?
A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*
final
network → Input<String>?
Deprecated: use vpc_connector
final
project → Input<String>?
final
runtime → Input<String>?
The runtime in which to run the function. Required when deploying a new function, optional when updating an existing function. For a complete list of possible choices, see the gcloud command reference.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
secretEnvironmentVariables → Input<List<SecretEnvVar>>?
Secret environment variables configuration.
final
secretVolumes → Input<List<SecretVolume>>?
Secret volumes configuration.
final
serviceAccountEmail → Input<String>?
The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.
final
sourceArchiveUrl → Input<String>?
The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.
final
sourceRepository → Input<SourceRepository>?
Beta Feature The source repository where a function is hosted.
final
sourceToken → Input<String>?
Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
final
sourceUploadUrl → Input<String>?
The Google Cloud Storage signed URL used for source uploading, generated by calling google.cloud.functions.v1.GenerateUploadUrl. The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)
final
timeout → Input<String>?
The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.
final
vpcConnector → Input<String>?
The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/* This field is mutually exclusive with network field and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.
final
vpcConnectorEgressSettings → Input<FunctionVpcConnectorEgressSettings>?
The egress settings for the connector, controlling what traffic is diverted through it.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited