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.



466
467
468
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 466

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

Instance Attribute Details

#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) 


227
228
229
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 227

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>) 


232
233
234
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 232

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) 


238
239
240
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 238

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) 


244
245
246
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 244

def build_name
  @build_name
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) 


256
257
258
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 256

def build_worker_pool
  @build_worker_pool
end

#description ⇒ String

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

Returns:

  • (String) 


261
262
263
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 261

def description
  @description
end

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

Returns:

  • (String) 


269
270
271
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 269

def docker_registry
  @docker_registry
end

#docker_repository ⇒ 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'. Corresponds to the JSON propertydockerRepository`

Returns:

  • (String) 


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

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, 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

Returns:

  • (String) 


291
292
293
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 291

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>) 


296
297
298
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 296

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:



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

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:



306
307
308
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 306

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) 


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

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) 


333
334
335
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 333

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>) 


338
339
340
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 338

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) 


349
350
351
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 349

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) 


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

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) 


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

def name
  @name
end

#network ⇒ 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/networkornetwork, whereprojectis a project id where the network is defined, andnetwork` is the short name of the network. This field is mutually exclusive with vpc_connectorand 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 propertynetwork`

Returns:

  • (String) 


375
376
377
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 375

def network
  @network
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) 


383
384
385
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 383

def runtime
  @runtime
end

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

Secret environment variables configuration. Corresponds to the JSON property secretEnvironmentVariables

Returns:



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

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:



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

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) 


399
400
401
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 399

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) 


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

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:



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

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) 


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

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) 


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

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) 


430
431
432
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 430

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) 


437
438
439
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 437

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) 


442
443
444
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 442

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) 


448
449
450
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 448

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) 


458
459
460
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 458

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) 


464
465
466
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 464

def vpc_connector_egress_settings
  @vpc_connector_egress_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 471

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_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)
  @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