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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/cloudfunctions_v1/classes.rb,
generated/google/apis/cloudfunctions_v1/representations.rb,
generated/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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ CloudFunction

Returns a new instance of CloudFunction.



432
433
434
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 432

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) 


285
286
287
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 285

def available_memory_mb
  @available_memory_mb
end

#description ⇒ String

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

Returns:

  • (String) 


290
291
292
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 290

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) 


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

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


305
306
307
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 305

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:



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

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:



316
317
318
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 316

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) 


322
323
324
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 322

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


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

def labels
  @labels
end

#max_instances ⇒ Fixnum

The limit on the maximum number of function instances that may coexist at a given time. Corresponds to the JSON property maxInstances

Returns:

  • (Fixnum) 


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

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) 


339
340
341
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 339

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`, where projectis a project id where the network is defined, andnetworkis the short name of the network. This field is mutually exclusive withvpc_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) 


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

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) 


364
365
366
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 364

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


370
371
372
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 370

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) 


376
377
378
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 376

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:



382
383
384
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 382

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


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

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) 


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

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) 


400
401
402
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 400

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) 


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

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) 


412
413
414
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 412

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) 


424
425
426
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 424

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) 


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

def vpc_connector_egress_settings
  @vpc_connector_egress_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 437

def update!(**args)
  @available_memory_mb = args[:available_memory_mb] if args.key?(:available_memory_mb)
  @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)
  @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_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