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. LINT.IfChange

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



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

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) 


251
252
253
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 251

def available_memory_mb
  @available_memory_mb
end

#description ⇒ String

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

Returns:

  • (String) 


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

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) 


266
267
268
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 266

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


271
272
273
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 271

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:



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

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:



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

def https_trigger
  @https_trigger
end

#labels ⇒ Hash<String,String>

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

Returns:

  • (Hash<String,String>) 


287
288
289
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 287

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) 


293
294
295
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 293

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) 


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

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. This feature is currently in alpha, available only for whitelisted users. Corresponds to the JSON propertynetwork`

Returns:

  • (String) 


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

def network
  @network
end

#runtime ⇒ String

Required. The runtime in which the function is going to run. Choices:

  • nodejs6: Node.js 6
  • nodejs8: Node.js 8
  • nodejs10: Node.js 10
  • python37: Python 3.7
  • go111: Go 1.11 Corresponds to the JSON property runtime

Returns:

  • (String) 


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

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 property serviceAccountEmail

Returns:

  • (String) 


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

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) 


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

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:



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

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) 


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

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) 


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

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) 


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

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) 


367
368
369
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 367

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) 


374
375
376
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 374

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. This feature is currently in alpha, available only for whitelisted users. Corresponds to the JSON property vpcConnector

Returns:

  • (String) 


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

def vpc_connector
  @vpc_connector
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
 
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 394

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