Class: Google::Cloud::Functions::V1::CloudFunction

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

Overview

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

Defined Under Namespace

Modules: IngressSettings, VpcConnectorEgressSettings Classes: EnvironmentVariablesEntry, LabelsEntry

Instance Attribute Summary collapse

Instance Attribute Details

#available_memory_mb ⇒ ::Integer

Returns The amount of memory in MB available for a function. Defaults to 256MB.

Returns:

  • (::Integer) —

    The amount of memory in MB available for a function. Defaults to 256MB.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#build_id ⇒ ::String (readonly)

Returns Output only. The Cloud Build ID of the latest successful deployment of the function.

Returns:

  • (::String) —

    Output only. The Cloud Build ID of the latest successful deployment of the function.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#description ⇒ ::String

Returns User-provided description of a function.

Returns:

  • (::String) —

    User-provided description of a function.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#entry_point ⇒ ::String

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

Returns:

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

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

Returns Environment variables that shall be available during function execution.

Returns:

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

    Environment variables that shall be available during function execution.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

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

Returns A source that fires events in response to a condition in another service.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#https_trigger ⇒ ::Google::Cloud::Functions::V1::HttpsTrigger

Returns An HTTPS endpoint type of source that can be triggered via URL.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#ingress_settings ⇒ ::Google::Cloud::Functions::V1::CloudFunction::IngressSettings

Returns The ingress settings for the function, controlling what traffic can reach it.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  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.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#max_instances ⇒ ::Integer

Returns The limit on the maximum number of function instances that may coexist at a given time.

Returns:

  • (::Integer) —

    The limit on the maximum number of function instances that may coexist at a given time.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  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/*



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#network ⇒ ::String

Returns 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/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network.

This field is mutually exclusive with vpc_connector and will be replaced by it.

See the VPC documentation for more information on connecting Cloud projects.

Returns:

  • (::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/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network.

    This field is mutually exclusive with vpc_connector and will be replaced by it.

    See the VPC documentation for more information on connecting Cloud projects.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#runtime ⇒ ::String

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

Returns:

  • (::String) —

    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.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#service_account_email ⇒ ::String

Returns The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

Returns:

  • (::String) —

    The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#source_archive_url ⇒ ::String

Returns The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

Returns:

  • (::String) —

    The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#source_repository ⇒ ::Google::Cloud::Functions::V1::SourceRepository

Returns Beta Feature

The source repository where a function is hosted.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#source_upload_url ⇒ ::String

Returns The Google Cloud Storage signed URL used for source uploading, generated by [google.cloud.functions.v1.GenerateUploadUrl][].

Returns:

  • (::String) —

    The Google Cloud Storage signed URL used for source uploading, generated by [google.cloud.functions.v1.GenerateUploadUrl][]



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#status ⇒ ::Google::Cloud::Functions::V1::CloudFunctionStatus (readonly)

Returns Output only. Status of the function deployment.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#timeout ⇒ ::Google::Protobuf::Duration

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

Returns:

  • (::Google::Protobuf::Duration) —

    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.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

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

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

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#version_id ⇒ ::Integer (readonly)

Returns Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

Returns:

  • (::Integer) —

    Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#vpc_connector ⇒ ::String

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

Returns:

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



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end

#vpc_connector_egress_settings ⇒ ::Google::Cloud::Functions::V1::CloudFunction::VpcConnectorEgressSettings

Returns The egress settings for the connector, controlling what traffic is diverted through it.

Returns:



140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 140

class CloudFunction
  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

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

  # Available egress settings.
  #
  # This controls what traffic is diverted through the VPC Access Connector
  # resource. By default PRIVATE_RANGES_ONLY will be used.
  module VpcConnectorEgressSettings
    # Unspecified.
    VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0

    # Use the VPC Access Connector only for private IP space from RFC1918.
    PRIVATE_RANGES_ONLY = 1

    # Force the use of VPC Access Connector for all egress traffic from the
    # function.
    ALL_TRAFFIC = 2
  end

  # Available ingress settings.
  #
  # This controls what traffic can reach the function.
  #
  # If unspecified, ALLOW_ALL will be used.
  module IngressSettings
    # Unspecified.
    INGRESS_SETTINGS_UNSPECIFIED = 0

    # Allow HTTP traffic from public and private sources.
    ALLOW_ALL = 1

    # Allow HTTP traffic from only private VPC sources.
    ALLOW_INTERNAL_ONLY = 2

    # Allow HTTP traffic from private VPC sources and through GCLB.
    ALLOW_INTERNAL_AND_GCLB = 3
  end
end