Struct google_cloudfunctions1::api::CloudFunction

pub struct CloudFunction {

    pub available_memory_mb: Option<i32>,
    pub build_environment_variables: Option<HashMap<String, String>>,
    pub build_id: Option<String>,
    pub build_name: Option<String>,
    pub build_worker_pool: Option<String>,
    pub description: Option<String>,
    pub docker_registry: Option<String>,
    pub docker_repository: Option<String>,
    pub entry_point: Option<String>,
    pub environment_variables: Option<HashMap<String, String>>,
    pub event_trigger: Option<EventTrigger>,
    pub https_trigger: Option<HttpsTrigger>,
    pub ingress_settings: Option<String>,
    pub kms_key_name: Option<String>,
    pub labels: Option<HashMap<String, String>>,
    pub max_instances: Option<i32>,
    pub min_instances: Option<i32>,
    pub name: Option<String>,
    pub network: Option<String>,
    pub runtime: Option<String>,
    pub secret_environment_variables: Option<Vec<SecretEnvVar>>,
    pub secret_volumes: Option<Vec<SecretVolume>>,
    pub service_account_email: Option<String>,
    pub source_archive_url: Option<String>,
    pub source_repository: Option<SourceRepository>,
    pub source_token: Option<String>,
    pub source_upload_url: Option<String>,
    pub status: Option<String>,
    pub timeout: Option<String>,
    pub update_time: Option<String>,
    pub version_id: Option<String>,
    pub vpc_connector: Option<String>,
    pub vpc_connector_egress_settings: Option<String>,
}

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.

Activities

This type is used in activities, which are methods you may call on this type or where this type is involved in. The list links the activity name, along with information about where it is used (one of request and response).

• locations functions create projects (request)
• locations functions get projects (response)
• locations functions patch projects (request)

Fields

available_memory_mb: Option<i32>

The amount of memory in MB available for a function. Defaults to 256MB.

build_environment_variables: Option<HashMap<String, String>>

Build environment variables that shall be available during build time.

build_id: Option<String>

Output only. The Cloud Build ID of the latest successful deployment of the function.

build_name: Option<String>

Output only. The Cloud Build Name of the function deployment. projects//locations//builds/.

build_worker_pool: Option<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.

description: Option<String>

User-provided description of a function.

docker_registry: Option<String>

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.

docker_repository: Option<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’.

entry_point: Option<String>

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named “function”. For Node.js this is name of a function exported by the module specified in source_location.

environment_variables: Option<HashMap<String, String>>

Environment variables that shall be available during function execution.

event_trigger: Option<EventTrigger>

A source that fires events in response to a condition in another service.

https_trigger: Option<HttpsTrigger>

An HTTPS endpoint type of source that can be triggered via URL.

ingress_settings: Option<String>

The ingress settings for the function, controlling what traffic can reach it.

kms_key_name: Option<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.

labels: Option<HashMap<String, String>>

Labels associated with this Cloud Function.

max_instances: Option<i32>

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.

min_instances: Option<i32>

A lower bound for the number function instances that may coexist at a given time.

name: Option<String>

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

network: Option<String>

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with vpc_connector and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.

runtime: Option<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.

secret_environment_variables: Option<Vec<SecretEnvVar>>

Secret environment variables configuration.

secret_volumes: Option<Vec<SecretVolume>>

Secret volumes configuration.

service_account_email: Option<String>

The email of the function’s service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

source_archive_url: Option<String>

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

source_repository: Option<SourceRepository>

Beta Feature The source repository where a function is hosted.

source_token: Option<String>

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

source_upload_url: Option<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)

status: Option<String>

Output only. Status of the function deployment.

timeout: Option<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.

update_time: Option<String>

Output only. The last update timestamp of a Cloud Function.

version_id: Option<String>

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

vpc_connector: Option<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.

vpc_connector_egress_settings: Option<String>

The egress settings for the connector, controlling what traffic is diverted through it.

Trait Implementations

impl Clone for CloudFunction

fn clone(&self) -> CloudFunction

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CloudFunction

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CloudFunction

fn default() -> CloudFunction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CloudFunction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CloudFunction

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl RequestValue for CloudFunction

impl ResponseResult for CloudFunction