Class: Google::Cloud::Functions::V2::Function

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/functions/v2/functions.rb

Overview

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

Defined Under Namespace

Modules: State Classes: LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#build_config ⇒ ::Google::Cloud::Functions::V2::BuildConfig

Returns Describes the Build step of the function that builds a container from the given source.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#create_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#description ⇒ ::String

Returns User-provided description of a function.

Returns:

  • (::String) —

    User-provided description of a function.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#environment ⇒ ::Google::Cloud::Functions::V2::Environment

Returns Describe whether the function is 1st Gen or 2nd Gen.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#event_trigger ⇒ ::Google::Cloud::Functions::V2::EventTrigger

Returns An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#kms_key_name ⇒ ::String

Returns [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}.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#labels ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Labels associated with this Cloud Function.

Returns:

  • (::Google::Protobuf::Map{::String => ::String}) —

    Labels associated with this Cloud Function.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#name ⇒ ::String

Returns 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/*



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#satisfies_pzs ⇒ ::Boolean (readonly)

Returns Output only. Reserved for future use.

Returns:

  • (::Boolean) —

    Output only. Reserved for future use.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#service_config ⇒ ::Google::Cloud::Functions::V2::ServiceConfig

Returns Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#state ⇒ ::Google::Cloud::Functions::V2::Function::State (readonly)

Returns Output only. State of the function.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#state_messages ⇒ ::Array<::Google::Cloud::Functions::V2::StateMessage> (readonly)

Returns Output only. State Messages for this Cloud Function.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#update_time ⇒ ::Google::Protobuf::Timestamp (readonly)

Returns Output only. The last update timestamp of a Cloud Function.

Returns:



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end

#url ⇒ ::String (readonly)

Returns Output only. The deployed url for the function.

Returns:

  • (::String) —

    Output only. The deployed url for the function.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
 
# File 'proto_docs/google/cloud/functions/v2/functions.rb', line 77

class Function
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class LabelsEntry
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Describes the current state of the function.
  module State
    # Not specified. Invalid state.
    STATE_UNSPECIFIED = 0

    # Function has been successfully deployed and is serving.
    ACTIVE = 1

    # Function deployment failed and the function is not serving.
    FAILED = 2

    # Function is being created or updated.
    DEPLOYING = 3

    # Function is being deleted.
    DELETING = 4

    # Function deployment failed and the function serving state is undefined.
    # The function should be updated or deleted to move it out of this state.
    UNKNOWN = 5
  end
end