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.



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

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_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/workerPool`whereprojectandregionare the project id and region respectively where the worker pool is defined andworkerPoolis 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) 


250
251
252
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 250

def build_worker_pool
  @build_worker_pool
end

#description ⇒ String

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

Returns:

  • (String) 


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

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


264
265
266
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 264

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


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

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:



274
275
276
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 274

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:



279
280
281
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 279

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) 


284
285
286
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 284

def ingress_settings
  @ingress_settings
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


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

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) 


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

def max_instances
  @max_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) 


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

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


320
321
322
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 320

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) 


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

def runtime
  @runtime
end

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

Secret environment variables configuration. Corresponds to the JSON property secretEnvironmentVariables

Returns:



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

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:



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

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) 


344
345
346
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 344

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) 


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

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:



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

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) 


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

def source_token
  @source_token
end

#source_upload_url ⇒ String

The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl Corresponds to the JSON property sourceUploadUrl

Returns:

  • (String) 


368
369
370
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 368

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) 


373
374
375
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 373

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) 


380
381
382
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 380

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) 


385
386
387
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 385

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) 


391
392
393
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 391

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) 


401
402
403
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 401

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) 


407
408
409
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 407

def vpc_connector_egress_settings
  @vpc_connector_egress_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/google/apis/cloudfunctions_v1/classes.rb', line 414

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_worker_pool = args[:build_worker_pool] if args.key?(:build_worker_pool)
  @description = args[:description] if args.key?(:description)
  @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)
  @labels = args[:labels] if args.key?(:labels)
  @max_instances = args[:max_instances] if args.key?(:max_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