Class: Google::Apis::CloudfunctionsV2alpha::Function
- Inherits:
-
Object
- Object
- Google::Apis::CloudfunctionsV2alpha::Function
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/cloudfunctions_v2alpha/classes.rb,
lib/google/apis/cloudfunctions_v2alpha/representations.rb,
lib/google/apis/cloudfunctions_v2alpha/representations.rb
Overview
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
Instance Attribute Summary collapse
-
#build_config ⇒ Google::Apis::CloudfunctionsV2alpha::BuildConfig
Describes the Build step of the function that builds a container from the given source.
-
#description ⇒ String
User-provided description of a function.
-
#environment ⇒ String
Describe whether the function is 1st Gen or 2nd Gen.
-
#event_trigger ⇒ Google::Apis::CloudfunctionsV2alpha::EventTrigger
Describes EventTrigger, used to request events to be sent from another service.
-
#kms_key_name ⇒ String
[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
-
#labels ⇒ Hash<String,String>
Labels associated with this Cloud Function.
-
#name ⇒ String
A user-defined name of the function.
-
#satisfies_pzs ⇒ Boolean
(also: #satisfies_pzs?)
Output only.
-
#service_config ⇒ Google::Apis::CloudfunctionsV2alpha::ServiceConfig
Describes the Service being deployed.
-
#state ⇒ String
Output only.
-
#state_messages ⇒ Array<Google::Apis::CloudfunctionsV2alpha::GoogleCloudFunctionsV2alphaStateMessage>
Output only.
-
#update_time ⇒ String
Output only.
-
#url ⇒ String
Output only.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Function
constructor
A new instance of Function.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Function
Returns a new instance of Function.
515 516 517 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 515 def initialize(**args) update!(**args) end |
Instance Attribute Details
#build_config ⇒ Google::Apis::CloudfunctionsV2alpha::BuildConfig
Describes the Build step of the function that builds a container from the
given source.
Corresponds to the JSON property buildConfig
448 449 450 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 448 def build_config @build_config end |
#description ⇒ String
User-provided description of a function.
Corresponds to the JSON property description
453 454 455 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 453 def description @description end |
#environment ⇒ String
Describe whether the function is 1st Gen or 2nd Gen.
Corresponds to the JSON property environment
458 459 460 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 458 def environment @environment end |
#event_trigger ⇒ Google::Apis::CloudfunctionsV2alpha::EventTrigger
Describes EventTrigger, used to request events to be sent from another service.
Corresponds to the JSON property eventTrigger
463 464 465 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 463 def event_trigger @event_trigger end |
#kms_key_name ⇒ String
[Preview] 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`.
Corresponds to the JSON property
kmsKeyName`
470 471 472 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 470 def kms_key_name @kms_key_name end |
#labels ⇒ Hash<String,String>
Labels associated with this Cloud Function.
Corresponds to the JSON property labels
475 476 477 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 475 def labels @labels 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
481 482 483 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 481 def name @name end |
#satisfies_pzs ⇒ Boolean Also known as: satisfies_pzs?
Output only. Reserved for future use.
Corresponds to the JSON property satisfiesPzs
486 487 488 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 486 def satisfies_pzs @satisfies_pzs end |
#service_config ⇒ Google::Apis::CloudfunctionsV2alpha::ServiceConfig
Describes the Service being deployed. Currently Supported : Cloud Run (fully
managed).
Corresponds to the JSON property serviceConfig
493 494 495 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 493 def service_config @service_config end |
#state ⇒ String
Output only. State of the function.
Corresponds to the JSON property state
498 499 500 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 498 def state @state end |
#state_messages ⇒ Array<Google::Apis::CloudfunctionsV2alpha::GoogleCloudFunctionsV2alphaStateMessage>
Output only. State Messages for this Cloud Function.
Corresponds to the JSON property stateMessages
503 504 505 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 503 def @state_messages end |
#update_time ⇒ String
Output only. The last update timestamp of a Cloud Function.
Corresponds to the JSON property updateTime
508 509 510 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 508 def update_time @update_time end |
#url ⇒ String
Output only. The deployed url for the function.
Corresponds to the JSON property url
513 514 515 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 513 def url @url end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 |
# File 'lib/google/apis/cloudfunctions_v2alpha/classes.rb', line 520 def update!(**args) @build_config = args[:build_config] if args.key?(:build_config) @description = args[:description] if args.key?(:description) @environment = args[:environment] if args.key?(:environment) @event_trigger = args[:event_trigger] if args.key?(:event_trigger) @kms_key_name = args[:kms_key_name] if args.key?(:kms_key_name) @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) @service_config = args[:service_config] if args.key?(:service_config) @state = args[:state] if args.key?(:state) @state_messages = args[:state_messages] if args.key?(:state_messages) @update_time = args[:update_time] if args.key?(:update_time) @url = args[:url] if args.key?(:url) end |