proto_docs/google/cloud/functions/v1/functions.rb in google-cloud-functions-v1-0.9.0 vs proto_docs/google/cloud/functions/v1/functions.rb in google-cloud-functions-v1-0.10.0

- old
+ new

@@ -20,11 +20,11 @@ module Google module Cloud module Functions module V1 # Describes a Cloud Function that contains user computation executed in - # response to an event. It encapsulate function and triggers configurations. + # response to an event. It encapsulates function and triggers configurations. # @!attribute [rw] name # @return [::String] # A user-defined name of the function. Function names must be unique # globally and match pattern `projects/*/locations/*/functions/*` # @!attribute [rw] description @@ -39,11 +39,11 @@ # **Beta Feature** # # The source repository where a function is hosted. # @!attribute [rw] source_upload_url # @return [::String] - # The Google Cloud Storage signed URL used for source uploading, generated + # 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) @@ -56,16 +56,16 @@ # @!attribute [r] status # @return [::Google::Cloud::Functions::V1::CloudFunctionStatus] # Output only. Status of the function deployment. # @!attribute [rw] entry_point # @return [::String] - # The name of the function (as defined in source code) that will be - # executed. Defaults to the resource name suffix, if not specified. For - # backward compatibility, if function with given name is not found, then the - # system will try to use function named "function". - # For Node.js this is name of a function exported by the module specified - # in `source_location`. + # The name of the function (as defined in source code) that is executed. + # Defaults to the resource name suffix, if not specified. For + # backward compatibility, if function with given name is not found, the + # system tries to use the function named "function". + # For Node.js, this is the name of a function exported by the module + # as specified in `source_location`. # @!attribute [rw] runtime # @return [::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 @@ -87,12 +87,12 @@ # @!attribute [r] update_time # @return [::Google::Protobuf::Timestamp] # Output only. The last update timestamp of a Cloud Function. # @!attribute [r] version_id # @return [::Integer] - # Output only. The version identifier of the Cloud Function. Each deployment attempt - # results in a new version of a function being created. + # Output only. The version identifier of the Cloud Function. Each deployment + # attempt results in a new version of a function being created. # @!attribute [rw] labels # @return [::Google::Protobuf::Map{::String => ::String}] # Labels associated with this Cloud Function. # @!attribute [rw] environment_variables # @return [::Google::Protobuf::Map{::String => ::String}] @@ -100,15 +100,15 @@ # @!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 - # either the fully-qualified URI, or the short name of the network resource. - # If the short network name is used, the network must belong to the same - # project. Otherwise, it must belong to a project within the same - # organization. The format of this field is either + # The Serverless VPC Access connector that this cloud function can connect + # to. It can be either the fully qualified URI, or the short name of the + # connector resource. If the connector name is used, the connector must + # belong to the same project as the function. Otherwise, it must belong to a + # project within the same organization. The format of this field is either # `projects/{project}/global/networks/{network}` or `{network}`, where # `{project}` is a project id where the network is defined, and `{network}` # is the short name of the network. # # This field is mutually exclusive with `vpc_connector` and will be replaced @@ -116,30 +116,30 @@ # # See [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for # more information on connecting Cloud projects. # @!attribute [rw] max_instances # @return [::Integer] - # The limit on the maximum number of function instances that may coexist at a + # The limit on the maximum number of function instances that can 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 + # In some cases, such as rapid traffic surges, Cloud Functions can 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 + # you might 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 + # A lower bound for the number function instances that can coexist at a # given time. # @!attribute [rw] vpc_connector # @return [::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 + # 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. @@ -213,20 +213,20 @@ # @!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. + # 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. + # the function docker image is 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. @@ -234,11 +234,11 @@ # Repository format must be 'DOCKER'. # @!attribute [rw] docker_registry # @return [::Google::Cloud::Functions::V1::CloudFunction::DockerRegistry] # Docker Registry to use for this deployment. # - # If `docker_repository` field is specified, this field will be automatically + # If `docker_repository` field is specified, this field is automatically # set as `ARTIFACT_REGISTRY`. # If unspecified, it currently defaults to `CONTAINER_REGISTRY`. # This field may be overridden by the backend for eligible deployments. class CloudFunction include ::Google::Protobuf::MessageExts @@ -271,29 +271,30 @@ 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. + # This controls what traffic is diverted through the Serverless VPC Access + # connector resource. By default, PRIVATE_RANGES_ONLY is used. module VpcConnectorEgressSettings # Unspecified. VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0 - # Use the VPC Access Connector only for private IP space from RFC1918. + # Use the Serverless 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. + # Force the use of Serverless 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. + # If unspecified, ALLOW_ALL is used. module IngressSettings # Unspecified. INGRESS_SETTINGS_UNSPECIFIED = 0 # Allow HTTP traffic from public and private sources. @@ -309,19 +310,19 @@ # 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 + # Docker images are 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. + # Docker images are stored in regional Artifact Registry repositories. + # By default, Cloud Functions creates and uses 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 by using the + # `docker_repository` field. ARTIFACT_REGISTRY = 2 end end # Describes SourceRepository, used to represent parameters related to @@ -338,11 +339,11 @@ # `https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*` # In particular, to refer to HEAD use `master` moveable alias. # To refer to a specific fixed alias (tag): # `https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*` # - # You may omit `paths/*` if you want to use the main directory. + # You can omit `paths/*` if you want to use the main directory. # @!attribute [r] deployed_url # @return [::String] # Output only. The URL pointing to the hosted repository where the function # were defined at the time of deployment. It always points to a specific # commit in the format described above. @@ -352,23 +353,23 @@ end # Describes HttpsTrigger, could be used to connect web hooks to function. # @!attribute [r] url # @return [::String] - # Output only. The deployed url for the function. + # 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. + # Available security-level settings. # # This controls the methods to enforce security (HTTPS) on a URL. # - # If unspecified, SECURE_OPTIONAL will be used. + # If unspecified, SECURE_OPTIONAL is used. module SecurityLevel # Unspecified. SECURITY_LEVEL_UNSPECIFIED = 0 # Requests for a URL that match this handler that do not use HTTPS are @@ -381,11 +382,11 @@ # which protocol was used and respond accordingly. SECURE_OPTIONAL = 2 end end - # Describes EventTrigger, used to request events be sent from another + # Describes EventTrigger, used to request that events be sent from another # service. # @!attribute [rw] event_type # @return [::String] # Required. The type of event to observe. For example: # `providers/cloud.storage/eventTypes/object.change` and @@ -398,11 +399,11 @@ # `google.firebase.analytics`. # 2. resource type: The type of resource on which event occurs. For # example, the Google Cloud Storage API includes the type `object`. # 3. action: The action that generates the event. For example, action for # a Google Cloud Storage Object is 'change'. - # These parts are lower case. + # These parts are lowercase. # @!attribute [rw] resource # @return [::String] # Required. The resource(s) from which to observe events, for example, # `projects/_/buckets/myBucket`. # @@ -416,11 +417,11 @@ # `event_type`. For example, an `EventTrigger` that has an # `event_type` of "google.pubsub.topic.publish" should have a resource # that matches Google Cloud Pub/Sub topics. # # Additionally, some services may support short names when creating an - # `EventTrigger`. These will always be returned in the normalized "long" + # `EventTrigger`. These are always returned in the normalized "long" # format. # # See each *service's* documentation for supported formats. # @!attribute [rw] service # @return [::String] @@ -436,44 +437,44 @@ include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Describes the policy in case of function's execution failure. - # If empty, then defaults to ignoring failures (i.e. not retrying them). + # If empty, then defaults to ignoring failures (i.e., not retrying them). # @!attribute [rw] retry # @return [::Google::Cloud::Functions::V1::FailurePolicy::Retry] - # If specified, then the function will be retried in case of a failure. + # If specified, the function is retried in case of a failure. class FailurePolicy include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Describes the retry policy in case of function's execution failure. - # A function execution will be retried on any failure. - # A failed execution will be retried up to 7 days with an exponential backoff + # A function execution is retried on any failure. + # A failed execution is retried up to 7 days with an exponential backoff # (capped at 10 seconds). # Retried execution is charged as any other execution. class Retry include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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 + # necessary to fetch the secret value from Secret Manager and expose it as an # environment variable. # @!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. + # ID) of the project that contains the secret. If not set, it is + # populated with the function's project, assuming that the secret exists in + # the same project as the function. # @!attribute [rw] secret # @return [::String] - # Name of the secret in secret manager (not the full resource name). + # 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 instances start. @@ -481,63 +482,63 @@ 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 + # 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. + # a part of the configuration. Every file system 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 + # setting the mount_path as `/etc/secrets` mounts the secret value files + # under the `/etc/secrets` directory. This directory is also 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. + # ID) of the project that contains the secret. If not set, it is + # populated with the function's project, assuming that the secret exists in + # the same project as the function. # @!attribute [rw] secret # @return [::String] - # Name of the secret in secret manager (not the full resource name). + # 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 + # version of the secret is 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 + # preferable 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 + # this version is fetched and made available. For example, setting the + # mount_path as '/etc/secrets' and path as `/secret_foo` mounts 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] - # Required. The project and location in which the function should be created, specified - # in the format `projects/*/locations/*` + # Required. The project and location in which the function should be created, + # specified in the format `projects/*/locations/*` # @!attribute [rw] function # @return [::Google::Cloud::Functions::V1::CloudFunction] # Required. Function to be created. class CreateFunctionRequest include ::Google::Protobuf::MessageExts