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. Next tag: 36

Defined Under Namespace

Modules: IngressSettings, VpcConnectorEgressSettings Classes: BuildEnvironmentVariablesEntry, 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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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_environment_variables ⇒ ::Google::Protobuf::Map{::String => ::String}

Returns Build environment variables that shall be available during build time.

Returns:

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

    Build environment variables that shall be available during build time.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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_name ⇒ ::String (readonly)

Returns Output only. The Cloud Build Name of the function deployment. projects/<project-number>/locations/<region>/builds/<build-id>.

Returns:

  • (::String) —

    Output only. The Cloud Build Name of the function deployment. projects/<project-number>/locations/<region>/builds/<build-id>.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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_worker_pool ⇒ ::String

Returns Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.

If the project id is not the same as the function, then the Cloud Functions Service Agent (service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

Returns:

  • (::String) —

    Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is projects/{project}/locations/{region}/workerPools/{workerPool} where {project} and {region} are the project id and region respectively where the worker pool is defined and {workerPool} is the short name of the worker pool.

    If the project id is not the same as the function, then the Cloud Functions Service Agent (service-<project_number>@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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

#docker_repository ⇒ ::String

Returns User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build.

It must match the pattern projects/{project}/locations/{location}/repositories/{repository}.

Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.

Returns:

  • (::String) —

    User managed repository created in Artifact Registry optionally with a customer managed encryption key. If specified, deployments will use Artifact Registry. If unspecified and the deployment is eligible to use Artifact Registry, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. This is the repository to which the function docker image will be pushed after it is built by Cloud Build.

    It must match the pattern projects/{project}/locations/{location}/repositories/{repository}.

    Cross-project repositories are not supported. Cross-location repositories are not supported. Repository format must be 'DOCKER'.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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

#kms_key_name ⇒ ::String

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

If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key.

The following service accounts need to be granted Cloud KMS crypto key encrypter/decrypter roles on the key.

  1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
  2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil.

Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

Returns:

  • (::String) —

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

    If specified, you must also provide an artifact registry repository using the docker_repository field that was created with the same KMS crypto key.

    The following service accounts need to be granted Cloud KMS crypto key encrypter/decrypter roles on the key.

    1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
    2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil.

    Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.

In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate.

See the Max Instances Guide for more details.

Returns:

  • (::Integer) —

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

    In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate.

    See the Max Instances Guide for more details.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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

#min_instances ⇒ ::Integer

Returns A lower bound for the number function instances that may coexist at a given time.

Returns:

  • (::Integer) —

    A lower bound for the number function instances that may coexist at a given time.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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/*



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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

#secret_environment_variables ⇒ ::Array<::Google::Cloud::Functions::V1::SecretEnvVar>

Returns Secret environment variables configuration.

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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

#secret_volumes ⇒ ::Array<::Google::Cloud::Functions::V1::SecretVolume>

Returns Secret volumes configuration.

Returns:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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_token ⇒ ::String

Returns Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.

Returns:

  • (::String) —

    Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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 calling [google.cloud.functions.v1.GenerateUploadUrl].

The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List).

Returns:

  • (::String) —

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

    The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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.



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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:



235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
 
# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 235

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

  # @!attribute [rw] key
  #   @return [::String]
  # @!attribute [rw] value
  #   @return [::String]
  class BuildEnvironmentVariablesEntry
    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