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

Inherits:

Object

Object
Google::Cloud::Functions::V1::CloudFunction

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: DockerRegistry, IngressSettings, VpcConnectorEgressSettings Classes: AutomaticUpdatePolicy, BuildEnvironmentVariablesEntry, EnvironmentVariablesEntry, LabelsEntry, OnDeployUpdatePolicy

Instance Attribute Summary collapse

#automatic_update_policy ⇒ ::Google::Cloud::Functions::V1::CloudFunction::AutomaticUpdatePolicy
See the comment next to this message for more details.
#available_memory_mb ⇒ ::Integer
The amount of memory in MB available for a function.
#build_environment_variables ⇒ ::Google::Protobuf::Map{::String => ::String}
Build environment variables that shall be available during build time.
#build_id ⇒ ::String readonly
Output only.
#build_name ⇒ ::String readonly
Output only.
#build_worker_pool ⇒ ::String
Name of the Cloud Build Custom Worker Pool that should be used to build the function.
#description ⇒ ::String
User-provided description of a function.
#docker_registry ⇒ ::Google::Cloud::Functions::V1::CloudFunction::DockerRegistry
Docker Registry to use for this deployment.
#docker_repository ⇒ ::String
User managed repository created in Artifact Registry optionally with a customer managed encryption key.
#entry_point ⇒ ::String
The name of the function (as defined in source code) that will be executed.
#environment_variables ⇒ ::Google::Protobuf::Map{::String => ::String}
Environment variables that shall be available during function execution.
#event_trigger ⇒ ::Google::Cloud::Functions::V1::EventTrigger
A source that fires events in response to a condition in another service.
#https_trigger ⇒ ::Google::Cloud::Functions::V1::HttpsTrigger
An HTTPS endpoint type of source that can be triggered via URL.
#ingress_settings ⇒ ::Google::Cloud::Functions::V1::CloudFunction::IngressSettings
The ingress settings for the function, controlling what traffic can reach it.
#kms_key_name ⇒ ::String
Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.
#labels ⇒ ::Google::Protobuf::Map{::String => ::String}
Labels associated with this Cloud Function.
#max_instances ⇒ ::Integer
The limit on the maximum number of function instances that may coexist at a given time.
#min_instances ⇒ ::Integer
A lower bound for the number function instances that may coexist at a given time.
#name ⇒ ::String
A user-defined name of the function.
#network ⇒ ::String deprecated Deprecated.
This field is deprecated and may be removed in the next major version update.
#on_deploy_update_policy ⇒ ::Google::Cloud::Functions::V1::CloudFunction::OnDeployUpdatePolicy
See the comment next to this message for more details.
#runtime ⇒ ::String
The runtime in which to run the function.
#secret_environment_variables ⇒ ::Array<::Google::Cloud::Functions::V1::SecretEnvVar>
Secret environment variables configuration.
#secret_volumes ⇒ ::Array<::Google::Cloud::Functions::V1::SecretVolume>
Secret volumes configuration.
#service_account_email ⇒ ::String
The email of the function's service account.
#source_archive_url ⇒ ::String
The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.
#source_repository ⇒ ::Google::Cloud::Functions::V1::SourceRepository
Beta Feature.
#source_token ⇒ ::String
Input only.
#source_upload_url ⇒ ::String
The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].
#status ⇒ ::Google::Cloud::Functions::V1::CloudFunctionStatus readonly
Output only.
#timeout ⇒ ::Google::Protobuf::Duration
The function execution timeout.
#update_time ⇒ ::Google::Protobuf::Timestamp readonly
Output only.
#version_id ⇒ ::Integer readonly
Output only.
#vpc_connector ⇒ ::String
The VPC Network Connector that this cloud function can connect to.
#vpc_connector_egress_settings ⇒ ::Google::Cloud::Functions::V1::CloudFunction::VpcConnectorEgressSettings
The egress settings for the connector, controlling what traffic is diverted through it.

Instance Attribute Details

#automatic_update_policy ⇒ `::Google::Cloud::Functions::V1::CloudFunction::AutomaticUpdatePolicy`

Returns See the comment next to this message for more details.

Returns:

(::Google::Cloud::Functions::V1::CloudFunction::AutomaticUpdatePolicy) —
See the comment next to this message for more details.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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>.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

#description ⇒ `::String`

Returns User-provided description of a function.

Returns:

(::String) —
User-provided description of a function.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

#docker_registry ⇒ `::Google::Cloud::Functions::V1::CloudFunction::DockerRegistry`

Returns Docker Registry to use for this deployment.

If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.

Returns:

(::Google::Cloud::Functions::V1::CloudFunction::DockerRegistry) —
Docker Registry to use for this deployment.

If unspecified, it defaults to ARTIFACT_REGISTRY. If docker_repository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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'.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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 (ID of the function), if not specified.

Returns:

(::String) —
The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

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

Returns:

(::Google::Cloud::Functions::V1::EventTrigger) —
A source that fires events in response to a condition in another service.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

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

Returns:

(::Google::Cloud::Functions::V1::HttpsTrigger) —
An HTTPS endpoint type of source that can be triggered via URL.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

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

Returns:

(::Google::Cloud::Functions::V1::CloudFunction::IngressSettings) —
The ingress settings for the function, controlling what traffic can reach it.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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 the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
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 the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).
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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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/*

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

#network ⇒ `::String`

Deprecated.

This field is deprecated and may be removed in the next major version update.

Returns Deprecated: use vpc_connector.

Returns:

(::String) —
Deprecated: use vpc_connector

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

#on_deploy_update_policy ⇒ `::Google::Cloud::Functions::V1::CloudFunction::OnDeployUpdatePolicy`

Returns See the comment next to this message for more details.

Returns:

(::Google::Cloud::Functions::V1::CloudFunction::OnDeployUpdatePolicy) —
See the comment next to this message for more details.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

Returns Secret environment variables configuration.

Returns:

(::Array<::Google::Cloud::Functions::V1::SecretEnvVar>) —
Secret environment variables configuration.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

Returns Secret volumes configuration.

Returns:

(::Array<::Google::Cloud::Functions::V1::SecretVolume>) —
Secret volumes configuration.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

Returns Beta Feature

The source repository where a function is hosted.

Returns:

(::Google::Cloud::Functions::V1::SourceRepository) —
Beta Feature

The source repository where a function is hosted.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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)

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

Returns Output only. Status of the function deployment.

Returns:

(::Google::Cloud::Functions::V1::CloudFunctionStatus) —
Output only. Status of the function deployment.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

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

Returns:

(::Google::Protobuf::Timestamp) —
Output only. The last update timestamp of a Cloud Function.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  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:

(::Google::Cloud::Functions::V1::CloudFunction::VpcConnectorEgressSettings) —
The egress settings for the connector, controlling what traffic is diverted through it.

# File 'proto_docs/google/cloud/functions/v1/functions.rb', line 233

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

  # Security patches are applied automatically to the runtime without requiring
  # the function to be redeployed.
  class AutomaticUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Security patches are only applied when a function is redeployed.
  # @!attribute [r] runtime_version
  #   @return [::String]
  #     Output only. contains the runtime version which was used during latest
  #     function deployment.
  class OnDeployUpdatePolicy
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # @!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

  # Docker Registry to use for storing function Docker images.
  module DockerRegistry
    # Unspecified.
    DOCKER_REGISTRY_UNSPECIFIED = 0

    # Docker images will be stored in multi-regional Container Registry
    # repositories named `gcf`.
    CONTAINER_REGISTRY = 1

    # Docker images will be stored in regional Artifact Registry repositories.
    # By default, GCF will create and use repositories named `gcf-artifacts`
    # in every region in which a function is deployed. But the repository to
    # use can also be specified by the user using the `docker_repository`
    # field.
    ARTIFACT_REGISTRY = 2
  end
end

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

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#automatic_update_policy ⇒ ::Google::Cloud::Functions::V1::CloudFunction::AutomaticUpdatePolicy

#available_memory_mb ⇒ ::Integer

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

#build_id ⇒ ::String (readonly)

#build_name ⇒ ::String (readonly)

#build_worker_pool ⇒ ::String

#description ⇒ ::String

#docker_registry ⇒ ::Google::Cloud::Functions::V1::CloudFunction::DockerRegistry

#docker_repository ⇒ ::String

#entry_point ⇒ ::String

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

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

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

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

#kms_key_name ⇒ ::String

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

#max_instances ⇒ ::Integer

#min_instances ⇒ ::Integer

#name ⇒ ::String

#network ⇒ ::String

#on_deploy_update_policy ⇒ ::Google::Cloud::Functions::V1::CloudFunction::OnDeployUpdatePolicy

#runtime ⇒ ::String

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

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

#service_account_email ⇒ ::String

#source_archive_url ⇒ ::String

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

#source_token ⇒ ::String

#source_upload_url ⇒ ::String

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

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

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

#version_id ⇒ ::Integer (readonly)

#vpc_connector ⇒ ::String

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

#automatic_update_policy ⇒ `::Google::Cloud::Functions::V1::CloudFunction::AutomaticUpdatePolicy`

#available_memory_mb ⇒ `::Integer`

#build_environment_variables ⇒ `::Google::Protobuf::Map{::String => ::String}`

#build_id ⇒ `::String` (readonly)

#build_name ⇒ `::String` (readonly)

#build_worker_pool ⇒ `::String`

#description ⇒ `::String`

#docker_registry ⇒ `::Google::Cloud::Functions::V1::CloudFunction::DockerRegistry`

#docker_repository ⇒ `::String`

#entry_point ⇒ `::String`

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

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

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

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

#kms_key_name ⇒ `::String`

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

#max_instances ⇒ `::Integer`

#min_instances ⇒ `::Integer`

#name ⇒ `::String`

#network ⇒ `::String`

#on_deploy_update_policy ⇒ `::Google::Cloud::Functions::V1::CloudFunction::OnDeployUpdatePolicy`

#runtime ⇒ `::String`

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

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

#service_account_email ⇒ `::String`

#source_archive_url ⇒ `::String`

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

#source_token ⇒ `::String`

#source_upload_url ⇒ `::String`

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

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

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

#version_id ⇒ `::Integer` (readonly)

#vpc_connector ⇒ `::String`

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