google-cloud-functions-v1 0.3.1 → 0.5.0

data/proto_docs/google/cloud/functions/v1/functions.rb

@@ -23,6 +23,7 @@ module Google
       module V1
         # Describes a Cloud Function that contains user computation executed in
         # response to an event. It encapsulate function and triggers configurations.
+        # Next tag: 36
         # @!attribute [rw] name
         #   @return [::String]
         #     A user-defined name of the function. Function names must be unique
@@ -32,7 +33,7 @@ module Google
         #     User-provided description of a function.
         # @!attribute [rw] source_archive_url
         #   @return [::String]
-        #     The Google Cloud Storage URL, starting with gs://, pointing to the zip
+        #     The Google Cloud Storage URL, starting with `gs://`, pointing to the zip
         #     archive which contains the function.
         # @!attribute [rw] source_repository
         #   @return [::Google::Cloud::Functions::V1::SourceRepository]
@@ -42,7 +43,11 @@ module Google
         # @!attribute [rw] source_upload_url
         #   @return [::String]
         #     The Google Cloud Storage signed URL used for source uploading, generated
-        #     by [google.cloud.functions.v1.GenerateUploadUrl][]
+        #     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)
         # @!attribute [rw] https_trigger
         #   @return [::Google::Cloud::Functions::V1::HttpsTrigger]
         #     An HTTPS endpoint type of source that can be triggered via URL.
@@ -66,7 +71,7 @@ module Google
         #     function, optional when updating an existing function. For a complete
         #     list of possible choices, see the
         #     [`gcloud` command
-        #     reference](/sdk/gcloud/reference/functions/deploy#--runtime).
+        #     reference](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
         # @!attribute [rw] timeout
         #   @return [::Google::Protobuf::Duration]
         #     The function execution timeout. Execution is considered failed and
@@ -93,6 +98,9 @@ module Google
         # @!attribute [rw] environment_variables
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     Environment variables that shall be available during function execution.
+        # @!attribute [rw] build_environment_variables
+        #   @return [::Google::Protobuf::Map{::String => ::String}]
+        #     Build environment variables that shall be available during build time.
         # @!attribute [rw] network
         #   @return [::String]
         #     The VPC Network that this cloud function can connect to. It can be
@@ -101,8 +109,8 @@ module Google
         #     project. Otherwise, it must belong to a project within the same
         #     organization. The format of this field is either
         #     `projects/{project}/global/networks/{network}` or `{network}`, where
-        #     \\{project} is a project id where the network is defined, and \\{network} is
-        #     the short name of the network.
+        #     `{project}` is a project id where the network is defined, and `{network}`
+        #     is the short name of the network.
         #
         #     This field is mutually exclusive with `vpc_connector` and will be replaced
         #     by it.
@@ -113,6 +121,20 @@ module Google
         #   @return [::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](https://cloud.google.com/functions/docs/max-instances) Guide for
+        #     more details.
+        # @!attribute [rw] min_instances
+        #   @return [::Integer]
+        #     A lower bound for the number function instances that may coexist at a
+        #     given time.
         # @!attribute [rw] vpc_connector
         #   @return [::String]
         #     The VPC Network Connector that this cloud function can connect to. It can
@@ -133,10 +155,83 @@ module Google
         #   @return [::Google::Cloud::Functions::V1::CloudFunction::IngressSettings]
         #     The ingress settings for the function, controlling what traffic can reach
         #     it.
+        # @!attribute [rw] kms_key_name
+        #   @return [::String]
+        #     Resource name of a KMS crypto key (managed by the user) used to
+        #     encrypt/decrypt function resources.
+        #
+        #     It must match the pattern
+        #     `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`.
+        #
+        #     If specified, you must also provide an artifact registry repository using
+        #     the `docker_repository` field that was created with the same KMS crypto
+        #     key.
+        #
+        #     The following service accounts need to be granted Cloud KMS crypto key
+        #     encrypter/decrypter roles on the key.
+        #
+        #     1. Google Cloud Functions service account
+        #        (service-\\{project_number}@gcf-admin-robot.iam.gserviceaccount.com) -
+        #        Required to protect the function's image.
+        #     2. Google Storage service account
+        #        (service-\\{project_number}@gs-project-accounts.iam.gserviceaccount.com) -
+        #        Required to protect the function's source code.
+        #        If this service account does not exist, deploying a function without a
+        #        KMS key or retrieving the service agent name provisions it. For more
+        #        information, see
+        #        https://cloud.google.com/storage/docs/projects#service-agents and
+        #        https://cloud.google.com/storage/docs/getting-service-agent#gsutil.
+        #
+        #     Google Cloud Functions delegates access to service agents to protect
+        #     function resources in internal projects that are not accessible by the
+        #     end user.
+        # @!attribute [rw] build_worker_pool
+        #   @return [::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.
         # @!attribute [r] build_id
         #   @return [::String]
         #     Output only. The Cloud Build ID of the latest successful deployment of the
         #     function.
+        # @!attribute [r] build_name
+        #   @return [::String]
+        #     Output only. The Cloud Build Name of the function deployment.
+        #     `projects/<project-number>/locations/<region>/builds/<build-id>`.
+        # @!attribute [rw] secret_environment_variables
+        #   @return [::Array<::Google::Cloud::Functions::V1::SecretEnvVar>]
+        #     Secret environment variables configuration.
+        # @!attribute [rw] secret_volumes
+        #   @return [::Array<::Google::Cloud::Functions::V1::SecretVolume>]
+        #     Secret volumes configuration.
+        # @!attribute [rw] source_token
+        #   @return [::String]
+        #     Input only. An identifier for Firebase function sources. Disclaimer: This field is only
+        #     supported for Firebase function deployments.
+        # @!attribute [rw] docker_repository
+        #   @return [::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'.
         class CloudFunction
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -159,6 +254,15 @@ module Google
             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
@@ -226,9 +330,32 @@ module Google
         # @!attribute [r] url
         #   @return [::String]
         #     Output only. The deployed url for the function.
+        # @!attribute [rw] security_level
+        #   @return [::Google::Cloud::Functions::V1::HttpsTrigger::SecurityLevel]
+        #     The security level for the function.
         class HttpsTrigger
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Available security level settings.
+          #
+          # This controls the methods to enforce security (HTTPS) on a URL.
+          #
+          # If unspecified, SECURE_OPTIONAL will be used.
+          module SecurityLevel
+            # Unspecified.
+            SECURITY_LEVEL_UNSPECIFIED = 0
+
+            # Requests for a URL that match this handler that do not use HTTPS are
+            # automatically redirected to the HTTPS URL with the same path. Query
+            # parameters are reserved for the redirect.
+            SECURE_ALWAYS = 1
+
+            # Both HTTP and HTTPS requests with URLs that match the handler succeed
+            # without redirects. The application can examine the request to determine
+            # which protocol was used and respond accordingly.
+            SECURE_OPTIONAL = 2
+          end
         end
 
         # Describes EventTrigger, used to request events be sent from another
@@ -305,6 +432,82 @@ module Google
           end
         end
 
+        # Configuration for a secret environment variable. It has the information
+        # necessary to fetch the secret value from secret manager and expose it as an
+        # environment variable. Secret value is not a part of the configuration. Secret
+        # values are only fetched when a new clone starts.
+        # @!attribute [rw] key
+        #   @return [::String]
+        #     Name of the environment variable.
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Project identifier (preferrably project number but can also be the project
+        #     ID) of the project that contains the secret. If not set, it will be
+        #     populated with the function's project assuming that the secret exists in
+        #     the same project as of the function.
+        # @!attribute [rw] secret
+        #   @return [::String]
+        #     Name of the secret in secret manager (not the full resource name).
+        # @!attribute [rw] version
+        #   @return [::String]
+        #     Version of the secret (version number or the string 'latest'). It is
+        #     recommended to use a numeric version for secret environment variables as
+        #     any updates to the secret value is not reflected until new clones start.
+        class SecretEnvVar
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Configuration for a secret volume. It has the information necessary to fetch
+        # the secret value from secret manager and make it available as files mounted
+        # at the requested paths within the application container. Secret value is not
+        # a part of the configuration. Every filesystem read operation performs a
+        # lookup in secret manager to retrieve the secret value.
+        # @!attribute [rw] mount_path
+        #   @return [::String]
+        #     The path within the container to mount the secret volume. For example,
+        #     setting the mount_path as `/etc/secrets` would mount the secret value files
+        #     under the `/etc/secrets` directory. This directory will also be completely
+        #     shadowed and unavailable to mount any other secrets.
+        #
+        #     Recommended mount paths: /etc/secrets
+        #     Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log
+        # @!attribute [rw] project_id
+        #   @return [::String]
+        #     Project identifier (preferrably project number but can also be the project
+        #     ID) of the project that contains the secret. If not set, it will be
+        #     populated with the function's project assuming that the secret exists in
+        #     the same project as of the function.
+        # @!attribute [rw] secret
+        #   @return [::String]
+        #     Name of the secret in secret manager (not the full resource name).
+        # @!attribute [rw] versions
+        #   @return [::Array<::Google::Cloud::Functions::V1::SecretVolume::SecretVersion>]
+        #     List of secret versions to mount for this secret. If empty, the `latest`
+        #     version of the secret will be made available in a file named after the
+        #     secret under the mount point.
+        class SecretVolume
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Configuration for a single version.
+          # @!attribute [rw] version
+          #   @return [::String]
+          #     Version of the secret (version number or the string 'latest'). It is
+          #     preferrable to use `latest` version with secret volumes as secret value
+          #     changes are reflected immediately.
+          # @!attribute [rw] path
+          #   @return [::String]
+          #     Relative path of the file under the mount path where the secret value for
+          #     this version will be fetched and made available. For example, setting the
+          #     mount_path as '/etc/secrets' and path as `/secret_foo` would mount the
+          #     secret value file at `/etc/secrets/secret_foo`.
+          class SecretVersion
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Request for the `CreateFunction` method.
         # @!attribute [rw] location
         #   @return [::String]

data/proto_docs/google/cloud/functions/v1/operations.rb

@@ -25,7 +25,7 @@ module Google
         # @!attribute [rw] target
         #   @return [::String]
         #     Target of the operation - for example
-        #     projects/project-1/locations/region-1/functions/function-1
+        #     `projects/project-1/locations/region-1/functions/function-1`
         # @!attribute [rw] type
         #   @return [::Google::Cloud::Functions::V1::OperationType]
         #     Type of operation.
@@ -43,6 +43,15 @@ module Google
         #   @return [::String]
         #     The Cloud Build ID of the function created or updated by an API call.
         #     This field is only populated for Create and Update operations.
+        # @!attribute [rw] source_token
+        #   @return [::String]
+        #     An identifier for Firebase function sources. Disclaimer: This field is only
+        #     supported for Firebase function deployments.
+        # @!attribute [rw] build_name
+        #   @return [::String]
+        #     The Cloud Build Name of the function deployment.
+        #     This field is only populated for Create and Update operations.
+        #     `projects/<project-number>/locations/<region>/builds/<build-id>`.
         class OperationMetadataV1
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods

data/proto_docs/google/type/expr.rb

@@ -19,30 +19,53 @@
 
 module Google
   module Type
-    # Represents an expression text. Example:
+    # Represents a textual expression in the Common Expression Language (CEL)
+    # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
+    # are documented at https://github.com/google/cel-spec.
     #
-    #     title: "User account presence"
-    #     description: "Determines whether the request has a user account"
-    #     expression: "size(request.user) > 0"
+    # Example (Comparison):
+    #
+    #     title: "Summary size limit"
+    #     description: "Determines if a summary is less than 100 chars"
+    #     expression: "document.summary.size() < 100"
+    #
+    # Example (Equality):
+    #
+    #     title: "Requestor is owner"
+    #     description: "Determines if requestor is the document owner"
+    #     expression: "document.owner == request.auth.claims.email"
+    #
+    # Example (Logic):
+    #
+    #     title: "Public documents"
+    #     description: "Determine whether the document should be publicly visible"
+    #     expression: "document.type != 'private' && document.type != 'internal'"
+    #
+    # Example (Data Manipulation):
+    #
+    #     title: "Notification string"
+    #     description: "Create a notification string with a timestamp."
+    #     expression: "'New message received at ' + string(document.create_time)"
+    #
+    # The exact variables and functions that may be referenced within an expression
+    # are determined by the service that evaluates it. See the service
+    # documentation for additional information.
     # @!attribute [rw] expression
     #   @return [::String]
-    #     Textual representation of an expression in
-    #     Common Expression Language syntax.
-    #
-    #     The application context of the containing message determines which
-    #     well-known feature set of CEL is supported.
+    #     Textual representation of an expression in Common Expression Language
+    #     syntax.
     # @!attribute [rw] title
     #   @return [::String]
-    #     An optional title for the expression, i.e. a short string describing
+    #     Optional. Title for the expression, i.e. a short string describing
     #     its purpose. This can be used e.g. in UIs which allow to enter the
     #     expression.
     # @!attribute [rw] description
     #   @return [::String]
-    #     An optional description of the expression. This is a longer text which
+    #     Optional. Description of the expression. This is a longer text which
     #     describes the expression, e.g. when hovered over it in a UI.
     # @!attribute [rw] location
     #   @return [::String]
-    #     An optional string indicating the location of the expression for error
+    #     Optional. String indicating the location of the expression for error
     #     reporting, e.g. a file name and a position in the file.
     class Expr
       include ::Google::Protobuf::MessageExts

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-functions-v1
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-17 00:00:00.000000000 Z
+date: 2021-11-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.7'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a