Cloud Functions V2 API - Class Google::Cloud::Functions::V2::Function (v0.5.0)

Reference documentation and code samples for the Cloud Functions V2 API class Google::Cloud::Functions::V2::Function.

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#build_config

def build_config() -> ::Google::Cloud::Functions::V2::BuildConfig
Returns

#build_config=

def build_config=(value) -> ::Google::Cloud::Functions::V2::BuildConfig
Parameter
Returns

#description

def description() -> ::String
Returns
  • (::String) — User-provided description of a function.

#description=

def description=(value) -> ::String
Parameter
  • value (::String) — User-provided description of a function.
Returns
  • (::String) — User-provided description of a function.

#environment

def environment() -> ::Google::Cloud::Functions::V2::Environment
Returns

#environment=

def environment=(value) -> ::Google::Cloud::Functions::V2::Environment
Parameter
Returns

#event_trigger

def event_trigger() -> ::Google::Cloud::Functions::V2::EventTrigger
Returns

#event_trigger=

def event_trigger=(value) -> ::Google::Cloud::Functions::V2::EventTrigger
Parameter
Returns

#kms_key_name

def kms_key_name() -> ::String
Returns
  • (::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}.

#kms_key_name=

def kms_key_name=(value) -> ::String
Parameter
  • value (::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}.

Returns
  • (::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}.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this Cloud Function.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this Cloud Function.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — Labels associated with this Cloud Function.

#name

def name() -> ::String
Returns
  • (::String) — A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*
Returns
  • (::String) — A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

#service_config

def service_config() -> ::Google::Cloud::Functions::V2::ServiceConfig
Returns

#service_config=

def service_config=(value) -> ::Google::Cloud::Functions::V2::ServiceConfig
Parameter
Returns

#state

def state() -> ::Google::Cloud::Functions::V2::Function::State
Returns

#state_messages

def state_messages() -> ::Array<::Google::Cloud::Functions::V2::StateMessage>
Returns

#update_time

def update_time() -> ::Google::Protobuf::Timestamp
Returns

#url

def url() -> ::String
Returns
  • (::String) — Output only. The deployed url for the function.