Class: Google::Apis::CloudfunctionsV1::CloudFunction

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/cloudfunctions_v1/classes.rb,
lib/google/apis/cloudfunctions_v1/representations.rb,
lib/google/apis/cloudfunctions_v1/representations.rb

Overview

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ CloudFunction

Returns a new instance of CloudFunction.



517
518
519
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 517

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#automatic_update_policy ⇒ Google::Apis::CloudfunctionsV1::AutomaticUpdatePolicy

Security patches are applied automatically to the runtime without requiring the function to be redeployed. Corresponds to the JSON property automaticUpdatePolicy

Returns:



272
273
274
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 272

def automatic_update_policy
  @automatic_update_policy
end

#available_memory_mb ⇒ Fixnum

The amount of memory in MB available for a function. Defaults to 256MB. Corresponds to the JSON property availableMemoryMb

Returns:

  • (Fixnum) 


277
278
279
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 277

def available_memory_mb
  @available_memory_mb
end

#build_environment_variables ⇒ Hash<String,String>

Build environment variables that shall be available during build time. Corresponds to the JSON property buildEnvironmentVariables

Returns:

  • (Hash<String,String>) 


282
283
284
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 282

def build_environment_variables
  @build_environment_variables
end

#build_id ⇒ String

Output only. The Cloud Build ID of the latest successful deployment of the function. Corresponds to the JSON property buildId

Returns:

  • (String) 


288
289
290
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 288

def build_id
  @build_id
end

#build_name ⇒ String

Output only. The Cloud Build Name of the function deployment. projects// locations//builds/. Corresponds to the JSON property buildName

Returns:

  • (String) 


294
295
296
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 294

def build_name
  @build_name
end

#build_service_account ⇒ String

A service account the user provides for use with Cloud Build. The format of this field is projects/projectId/serviceAccounts/serviceAccountEmail`. Corresponds to the JSON propertybuildServiceAccount`

Returns:

  • (String) 


300
301
302
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 300

def 
  @build_service_account
end

#build_worker_pool ⇒ 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/workerPoolwhereprojectandregionare the project id and region respectively where the worker pool is defined andworkerPool`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 propertybuildWorkerPool`

Returns:

  • (String) 


312
313
314
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 312

def build_worker_pool
  @build_worker_pool
end

#description ⇒ String

User-provided description of a function. Corresponds to the JSON property description

Returns:

  • (String) 


317
318
319
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 317

def description
  @description
end

#docker_registry ⇒ String

Docker Registry to use for this deployment. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/ artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice. If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY. Corresponds to the JSON property dockerRegistry

Returns:

  • (String) 


327
328
329
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 327

def docker_registry
  @docker_registry
end

#docker_repository ⇒ String

User-managed repository created in Artifact Registry to which the function's Docker image will be pushed after it is built by Cloud Build. May optionally be encrypted with a customer-managed encryption key (CMEK). If unspecified and docker_registry is not explicitly set to CONTAINER_REGISTRY, GCF will create and use a default Artifact Registry repository named 'gcf-artifacts' in the region. 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 propertydockerRepository`

Returns:

  • (String) 


340
341
342
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 340

def docker_repository
  @docker_repository
end

#entry_point ⇒ 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. Corresponds to the JSON property entryPoint

Returns:

  • (String) 


346
347
348
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 346

def entry_point
  @entry_point
end

#environment_variables ⇒ Hash<String,String>

Environment variables that shall be available during function execution. Corresponds to the JSON property environmentVariables

Returns:

  • (Hash<String,String>) 


351
352
353
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 351

def environment_variables
  @environment_variables
end

#event_trigger ⇒ Google::Apis::CloudfunctionsV1::EventTrigger

Describes EventTrigger, used to request events be sent from another service. Corresponds to the JSON property eventTrigger

Returns:



356
357
358
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 356

def event_trigger
  @event_trigger
end

#https_trigger ⇒ Google::Apis::CloudfunctionsV1::HttpsTrigger

Describes HttpsTrigger, could be used to connect web hooks to function. Corresponds to the JSON property httpsTrigger

Returns:



361
362
363
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 361

def https_trigger
  @https_trigger
end

#ingress_settings ⇒ String

The ingress settings for the function, controlling what traffic can reach it. Corresponds to the JSON property ingressSettings

Returns:

  • (String) 


366
367
368
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 366

def ingress_settings
  @ingress_settings
end

#kms_key_name ⇒ 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_repositoryfield 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. Corresponds to the JSON propertykmsKeyName`

Returns:

  • (String) 


388
389
390
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 388

def kms_key_name
  @kms_key_name
end

#labels ⇒ Hash<String,String>

Labels associated with this Cloud Function. Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


393
394
395
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 393

def labels
  @labels
end

#max_instances ⇒ Fixnum

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. Corresponds to the JSON property maxInstances

Returns:

  • (Fixnum) 


404
405
406
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 404

def max_instances
  @max_instances
end

#min_instances ⇒ Fixnum

A lower bound for the number function instances that may coexist at a given time. Corresponds to the JSON property minInstances

Returns:

  • (Fixnum) 


410
411
412
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 410

def min_instances
  @min_instances
end

#name ⇒ String

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

Returns:

  • (String) 


416
417
418
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 416

def name
  @name
end

#network ⇒ String

Deprecated: use vpc_connector Corresponds to the JSON property network

Returns:

  • (String) 


421
422
423
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 421

def network
  @network
end

#on_deploy_update_policy ⇒ Google::Apis::CloudfunctionsV1::OnDeployUpdatePolicy

Security patches are only applied when a function is redeployed. Corresponds to the JSON property onDeployUpdatePolicy

Returns:



426
427
428
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 426

def on_deploy_update_policy
  @on_deploy_update_policy
end

#runtime ⇒ 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. Corresponds to the JSON property runtime

Returns:

  • (String) 


434
435
436
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 434

def runtime
  @runtime
end

#secret_environment_variables ⇒ Array<Google::Apis::CloudfunctionsV1::SecretEnvVar>

Secret environment variables configuration. Corresponds to the JSON property secretEnvironmentVariables

Returns:



439
440
441
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 439

def secret_environment_variables
  @secret_environment_variables
end

#secret_volumes ⇒ Array<Google::Apis::CloudfunctionsV1::SecretVolume>

Secret volumes configuration. Corresponds to the JSON property secretVolumes

Returns:



444
445
446
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 444

def secret_volumes
  @secret_volumes
end

#service_account_email ⇒ String

The email of the function's service account. If empty, defaults to ` project_id@appspot.gserviceaccount.com. Corresponds to the JSON propertyserviceAccountEmail`

Returns:

  • (String) 


450
451
452
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 450

def 
  @service_account_email
end

#source_archive_url ⇒ String

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

Returns:

  • (String) 


456
457
458
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 456

def source_archive_url
  @source_archive_url
end

#source_repository ⇒ Google::Apis::CloudfunctionsV1::SourceRepository

Describes SourceRepository, used to represent parameters related to source repository where a function is hosted. Corresponds to the JSON property sourceRepository

Returns:



462
463
464
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 462

def source_repository
  @source_repository
end

#source_token ⇒ String

Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments. Corresponds to the JSON property sourceToken

Returns:

  • (String) 


468
469
470
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 468

def source_token
  @source_token
end

#source_upload_url ⇒ 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) Corresponds to the JSON property sourceUploadUrl

Returns:

  • (String) 


476
477
478
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 476

def source_upload_url
  @source_upload_url
end

#status ⇒ String

Output only. Status of the function deployment. Corresponds to the JSON property status

Returns:

  • (String) 


481
482
483
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 481

def status
  @status
end

#timeout ⇒ 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. Corresponds to the JSON property timeout

Returns:

  • (String) 


488
489
490
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 488

def timeout
  @timeout
end

#update_time ⇒ String

Output only. The last update timestamp of a Cloud Function. Corresponds to the JSON property updateTime

Returns:

  • (String) 


493
494
495
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 493

def update_time
  @update_time
end

#version_id ⇒ Fixnum

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

Returns:

  • (Fixnum) 


499
500
501
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 499

def version_id
  @version_id
end

#vpc_connector ⇒ 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. Corresponds to the JSON property vpcConnector

Returns:

  • (String) 


509
510
511
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 509

def vpc_connector
  @vpc_connector
end

#vpc_connector_egress_settings ⇒ String

The egress settings for the connector, controlling what traffic is diverted through it. Corresponds to the JSON property vpcConnectorEgressSettings

Returns:

  • (String) 


515
516
517
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 515

def vpc_connector_egress_settings
  @vpc_connector_egress_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 522

def update!(**args)
  @automatic_update_policy = args[:automatic_update_policy] if args.key?(:automatic_update_policy)
  @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_service_account = args[:build_service_account] if args.key?(:build_service_account)
  @build_worker_pool = args[:build_worker_pool] if args.key?(:build_worker_pool)
  @description = args[:description] if args.key?(:description)
  @docker_registry = args[:docker_registry] if args.key?(:docker_registry)
  @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)
  @on_deploy_update_policy = args[:on_deploy_update_policy] if args.key?(:on_deploy_update_policy)
  @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