class Google::Apis::CloudfunctionsV1::CloudFunction

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

Attributes

available_memory_mb[RW]

The amount of memory in MB available for a function. Defaults to 256MB. Corresponds to the JSON property `availableMemoryMb` @return [Fixnum]

build_environment_variables[RW]

Build environment variables that shall be available during build time. Corresponds to the JSON property `buildEnvironmentVariables` @return [Hash<String,String>]

build_id[RW]

Output only. The Cloud Build ID of the latest successful deployment of the function. Corresponds to the JSON property `buildId` @return [String]

build_name[RW]

Output only. The Cloud Build Name of the function deployment. `projects// locations//builds/`. Corresponds to the JSON property `buildName` @return [String]

build_worker_pool[RW]

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. Corresponds to the JSON property `buildWorkerPool` @return [String]

description[RW]

User-provided description of a function. Corresponds to the JSON property `description` @return [String]

docker_repository[RW]

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'. Corresponds to the JSON property `dockerRepository` @return [String]

entry_point[RW]

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`. Corresponds to the JSON property `entryPoint` @return [String]

environment_variables[RW]

Environment variables that shall be available during function execution. Corresponds to the JSON property `environmentVariables` @return [Hash<String,String>]

event_trigger[RW]

Describes EventTrigger, used to request events be sent from another service. Corresponds to the JSON property `eventTrigger` @return [Google::Apis::CloudfunctionsV1::EventTrigger]

https_trigger[RW]

Describes HttpsTrigger, could be used to connect web hooks to function. Corresponds to the JSON property `httpsTrigger` @return [Google::Apis::CloudfunctionsV1::HttpsTrigger]

ingress_settings[RW]

The ingress settings for the function, controlling what traffic can reach it. Corresponds to the JSON property `ingressSettings` @return [String]

kms_key_name[RW]

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 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. Corresponds to the JSON property `kmsKeyName` @return [String]

labels[RW]

Labels associated with this Cloud Function. Corresponds to the JSON property `labels` @return [Hash<String,String>]

max_instances[RW]

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](cloud.google.com/ functions/docs/max-instances) Guide for more details. Corresponds to the JSON property `maxInstances` @return [Fixnum]

min_instances[RW]

A lower bound for the number function instances that may coexist at a given time. Corresponds to the JSON property `minInstances` @return [Fixnum]

name[RW]

A user-defined name of the function. Function names must be unique globally and match pattern `projects//locations//functions/*` Corresponds to the JSON property `name` @return [String]

network[RW]

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](https:// cloud.google.com/compute/docs/vpc) for more information on connecting Cloud projects. Corresponds to the JSON property `network` @return [String]

runtime[RW]

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](cloud.google. com/sdk/gcloud/reference/functions/deploy#–runtime). Corresponds to the JSON property `runtime` @return [String]

secret_environment_variables[RW]

Secret environment variables configuration. Corresponds to the JSON property `secretEnvironmentVariables` @return [Array<Google::Apis::CloudfunctionsV1::SecretEnvVar>]

secret_volumes[RW]

Secret volumes configuration. Corresponds to the JSON property `secretVolumes` @return [Array<Google::Apis::CloudfunctionsV1::SecretVolume>]

service_account_email[RW]

The email of the function's service account. If empty, defaults to “ project_id`@appspot.gserviceaccount.com`. Corresponds to the JSON property `serviceAccountEmail` @return [String]

source_archive_url[RW]

The Google Cloud Storage URL, starting with `gs://`, pointing to the zip archive which contains the function. Corresponds to the JSON property `sourceArchiveUrl` @return [String]

source_repository[RW]

Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. Corresponds to the JSON property `sourceRepository` @return [Google::Apis::CloudfunctionsV1::SourceRepository]

source_token[RW]

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. Corresponds to the JSON property `sourceToken` @return [String]

source_upload_url[RW]

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) Corresponds to the JSON property `sourceUploadUrl` @return [String]

status[RW]

Output only. Status of the function deployment. Corresponds to the JSON property `status` @return [String]

timeout[RW]

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. Corresponds to the JSON property `timeout` @return [String]

update_time[RW]

Output only. The last update timestamp of a Cloud Function. Corresponds to the JSON property `updateTime` @return [String]

version_id[RW]

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created. Corresponds to the JSON property `versionId` @return [Fixnum]

vpc_connector[RW]

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](cloud.google.com/compute/docs/ vpc) for more information on connecting Cloud projects. Corresponds to the JSON property `vpcConnector` @return [String]

vpc_connector_egress_settings[RW]

The egress settings for the connector, controlling what traffic is diverted through it. Corresponds to the JSON property `vpcConnectorEgressSettings` @return [String]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/cloudfunctions_v1/classes.rb, line 458
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/cloudfunctions_v1/classes.rb, line 463
def update!(**args)
  @available_memory_mb = args[:available_memory_mb] if args.key?(:available_memory_mb)
  @build_environment_variables = args[:build_environment_variables] if args.key?(:build_environment_variables)
  @build_id = args[:build_id] if args.key?(:build_id)
  @build_name = args[:build_name] if args.key?(:build_name)
  @build_worker_pool = args[:build_worker_pool] if args.key?(:build_worker_pool)
  @description = args[:description] if args.key?(:description)
  @docker_repository = args[:docker_repository] if args.key?(:docker_repository)
  @entry_point = args[:entry_point] if args.key?(:entry_point)
  @environment_variables = args[:environment_variables] if args.key?(:environment_variables)
  @event_trigger = args[:event_trigger] if args.key?(:event_trigger)
  @https_trigger = args[:https_trigger] if args.key?(:https_trigger)
  @ingress_settings = args[:ingress_settings] if args.key?(:ingress_settings)
  @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name)
  @labels = args[:labels] if args.key?(:labels)
  @max_instances = args[:max_instances] if args.key?(:max_instances)
  @min_instances = args[:min_instances] if args.key?(:min_instances)
  @name = args[:name] if args.key?(:name)
  @network = args[:network] if args.key?(:network)
  @runtime = args[:runtime] if args.key?(:runtime)
  @secret_environment_variables = args[:secret_environment_variables] if args.key?(:secret_environment_variables)
  @secret_volumes = args[:secret_volumes] if args.key?(:secret_volumes)
  @service_account_email = args[:service_account_email] if args.key?(:service_account_email)
  @source_archive_url = args[:source_archive_url] if args.key?(:source_archive_url)
  @source_repository = args[:source_repository] if args.key?(:source_repository)
  @source_token = args[:source_token] if args.key?(:source_token)
  @source_upload_url = args[:source_upload_url] if args.key?(:source_upload_url)
  @status = args[:status] if args.key?(:status)
  @timeout = args[:timeout] if args.key?(:timeout)
  @update_time = args[:update_time] if args.key?(:update_time)
  @version_id = args[:version_id] if args.key?(:version_id)
  @vpc_connector = args[:vpc_connector] if args.key?(:vpc_connector)
  @vpc_connector_egress_settings = args[:vpc_connector_egress_settings] if args.key?(:vpc_connector_egress_settings)
end