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.


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

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

Instance Attribute Details

#available_memory_mbFixnum

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 'generated/google/apis/cloudfunctions_v1/classes.rb', line 227

def available_memory_mb
  @available_memory_mb
end

#build_idString

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

Returns:

  • (String)

233
234
235
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 233

def build_id
  @build_id
end

#descriptionString

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

Returns:

  • (String)

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

def description
  @description
end

#entry_pointString

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)

247
248
249
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 247

def entry_point
  @entry_point
end

#environment_variablesHash<String,String>

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

Returns:

  • (Hash<String,String>)

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

def environment_variables
  @environment_variables
end

#event_triggerGoogle::Apis::CloudfunctionsV1::EventTrigger

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


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

def event_trigger
  @event_trigger
end

#https_triggerGoogle::Apis::CloudfunctionsV1::HttpsTrigger

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


262
263
264
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 262

def https_trigger
  @https_trigger
end

#ingress_settingsString

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

Returns:

  • (String)

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

def ingress_settings
  @ingress_settings
end

#labelsHash<String,String>

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

Returns:

  • (Hash<String,String>)

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

def labels
  @labels
end

#max_instancesFixnum

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

Returns:

  • (Fixnum)

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

def max_instances
  @max_instances
end

#nameString

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)

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

def name
  @name
end

#networkString

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)

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

def network
  @network
end

#runtimeString

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)

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

def runtime
  @runtime
end

#service_account_emailString

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

Returns:

  • (String)

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

def 
  @service_account_email
end

#source_archive_urlString

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)

318
319
320
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 318

def source_archive_url
  @source_archive_url
end

#source_repositoryGoogle::Apis::CloudfunctionsV1::SourceRepository

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


324
325
326
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 324

def source_repository
  @source_repository
end

#source_upload_urlString

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)

330
331
332
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 330

def source_upload_url
  @source_upload_url
end

#statusString

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

Returns:

  • (String)

335
336
337
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 335

def status
  @status
end

#timeoutString

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)

342
343
344
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 342

def timeout
  @timeout
end

#update_timeString

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

Returns:

  • (String)

347
348
349
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 347

def update_time
  @update_time
end

#version_idFixnum

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)

353
354
355
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 353

def version_id
  @version_id
end

#vpc_connectorString

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)

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

def vpc_connector
  @vpc_connector
end

#vpc_connector_egress_settingsString

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

Returns:

  • (String)

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

def vpc_connector_egress_settings
  @vpc_connector_egress_settings
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
# File 'generated/google/apis/cloudfunctions_v1/classes.rb', line 376

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