package google.cloud.functions.v2alpha
Get desktop application:
View/edit binary Protocol Buffers messages
Google Cloud Functions is used to deploy functions that are executed by Google in response to various events. Data connected with that event is passed to a function as the input data. A **function** is a resource which describes a function that should be executed and how it is triggered.
rpc GetFunction (, )
functions.proto:84Returns a function with the given name from the requested project.
message
functions.proto:874Request for the `GetFunction` method.
string name = 1
Required. The name of the function which details should be obtained.
string revision = 2
Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function.
rpc ListFunctions (, )
functions.proto:92Returns a list of functions that belong to the requested project.
message
functions.proto:893Request for the `ListFunctions` method.
string parent = 1
Required. The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.
int32 page_size = 2
Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters.
string page_token = 3
The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.
string filter = 4
The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
string order_by = 5
The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting oder is ascending. See https://google.aip.dev/132#ordering.
message
functions.proto:930Response for the `ListFunctions` method.
repeated functions = 1
The functions that match the request.
string next_page_token = 2
A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
repeated string unreachable = 3
Locations that could not be reached. The response does not include any functions from these locations.
rpc CreateFunction (, )
functions.proto:102Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.
message
functions.proto:944Request for the `CreateFunction` method.
string parent = 1
Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`
optional function = 2
Required. Function to be created.
string function_id = 3
The ID to use for the function, which will become the final component of the function's resource name. This value should be 4-63 characters, and valid characters are /[a-z][0-9]-/.
rpc UpdateFunction (, )
functions.proto:116Updates existing function.
message
functions.proto:966Request for the `UpdateFunction` method.
optional function = 1
Required. New version of the function.
optional update_mask = 2
The list of fields to be updated. If no field mask is provided, all fields will be updated.
rpc DeleteFunction (, )
functions.proto:132Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.
message
functions.proto:976Request for the `DeleteFunction` method.
string name = 1
Required. The name of the function which should be deleted.
rpc GenerateUploadUrl (, )
functions.proto:167Returns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, specify this header: * `content-type: application/zip` Do not specify this header: * `Authorization: Bearer YOUR_TOKEN`
message
functions.proto:987Request of `GenerateSourceUploadUrl` method.
string parent = 1
Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/*/locations/*`.
string kms_key_name = 2
[Preview] Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).
Environment environment = 3
The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated.
message
functions.proto:1024Response of `GenerateSourceUploadUrl` method.
string upload_url = 1
The generated Google Cloud Storage signed URL that should be used for a function source code upload. The uploaded file should be a zip archive which contains a function.
optional storage_source = 2
The location of the source code in the upload bucket. Once the archive is uploaded using the `upload_url` use this field to set the `function.build_config.source.storage_source` during CreateFunction and UpdateFunction. Generation defaults to 0, as Cloud Storage provides a new generation only upon uploading a new object or version of an object.
Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls
message
functions.proto:1042Request of `GenerateDownloadUrl` method.
string name = 1
Required. The name of function for which source code Google Cloud Storage signed URL should be generated.
message
functions.proto:1054Response of `GenerateDownloadUrl` method.
string download_url = 1
The generated Google Cloud Storage signed URL that should be used for function source code download.
rpc ListRuntimes (, )
functions.proto:189Returns a list of runtimes that are supported for the requested project.
message
functions.proto:1061Request for the `ListRuntimes` method.
string parent = 1
Required. The project and location from which the runtimes should be listed, specified in the format `projects/*/locations/*`
string filter = 2
The filter for Runtimes that match the filter expression, following the syntax outlined in https://google.aip.dev/160.
message
functions.proto:1077Response for the `ListRuntimes` method.
repeated runtimes = 1
The runtimes that match the request.
message
functions.proto:1133Security patches are applied automatically to the runtime without requiring the function to be redeployed.
Used in:
(message has no fields)
message
functions.proto:440Describes the Build step of the function that builds a container from the given source.
Used in:
oneof runtime_update_policy
This controls when security patches are applied to the runtime environment.
automatic_update_policy = 40
on_deploy_update_policy = 41
string build = 1
Output only. The Cloud Build name of the latest successful deployment of the function.
string runtime = 2
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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).
string entry_point = 3
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`.
optional source = 4
The location of the function source code.
optional source_provenance = 8
Output only. A permanent fixed identifier for source.
string worker_pool = 5
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.
map<string, string> environment_variables = 6
User-provided build-time environment variables for the function
BuildConfig.DockerRegistry docker_registry = 10
Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. 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`.
string docker_repository = 7
Repository in Artifact Registry to which the function docker image will be pushed after it is built by Cloud Build. If specified by user, it is created and managed by user with a customer managed encryption key. Otherwise, GCF will create and use a repository named 'gcf-artifacts' for every deployed region. 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'.
string service_account = 27
Service account to be used for building the container. The format of this field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.
Docker Registry to use for storing function Docker images.
Used in:
DOCKER_REGISTRY_UNSPECIFIED = 0
Unspecified.
CONTAINER_REGISTRY = 1
Docker images will be stored in multi-regional Container Registry repositories named `gcf`.
ARTIFACT_REGISTRY = 2
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.
The environment the function is hosted on.
Used in: , , ,
ENVIRONMENT_UNSPECIFIED = 0
Unspecified
GEN_1 = 1
Gen 1
GEN_2 = 2
Gen 2
message
functions.proto:859Filters events based on exact matches on the CloudEvents attributes.
Used in:
string attribute = 1
Required. The name of a CloudEvents attribute.
string value = 2
Required. The value for the attribute.
string operator = 3
Optional. The operator used for matching the events with the value of the filter. If not specified, only events that have an exact key-value pair specified in the filter are matched. The only allowed value is `match-path-pattern`.
message
functions.proto:776Describes EventTrigger, used to request events to be sent from another service.
Used in:
string trigger = 1
Output only. The resource name of the Eventarc trigger. The format of this field is `projects/{project}/locations/{region}/triggers/{trigger}`.
string trigger_region = 2
The region that the trigger will be in. The trigger will only receive events originating in this region. It can be the same region as the function, a different region or multi-region, or the global region. If not provided, defaults to the same region as the function.
string event_type = 3
Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.
repeated event_filters = 4
Criteria used to filter events.
string pubsub_topic = 5
Optional. The name of a Pub/Sub topic in the same project that will be used as the transport topic for the event delivery. Format: `projects/{project}/topics/{topic}`. This is only valid for events of type `google.cloud.pubsub.topic.v1.messagePublished`. The topic provided here will not be deleted at function deletion.
string service_account_email = 6
Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is `run.routes.invoke`. If empty, defaults to the Compute Engine default service account: `{project_number}-compute@developer.gserviceaccount.com`.
EventTrigger.RetryPolicy retry_policy = 7
Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).
string channel = 8
Optional. The name of the channel associated with the trigger in `projects/{project}/locations/{location}/channels/{channel}` format. You must provide a channel to receive events from Eventarc SaaS partners.
string service = 9
Optional. The hostname of the service that 1st Gen function should be observed. If no string is provided, the default service implementing the API will be used. For example, `storage.googleapis.com` is the default for all event types in the `google.storage` namespace. The field is only applicable to 1st Gen functions.
Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution.
Used in:
RETRY_POLICY_UNSPECIFIED = 0
Not specified.
RETRY_POLICY_DO_NOT_RETRY = 1
Do not retry.
RETRY_POLICY_RETRY = 2
Retry on any failure, retry up to 7 days with an exponential backoff (capped at 10 seconds).
message
functions.proto:226Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
Used as response type in: FunctionService.GetFunction
Used as field type in: , ,
string name = 1
A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`
string description = 2
User-provided description of a function.
optional build_config = 3
Describes the Build step of the function that builds a container from the given source.
optional service_config = 4
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
optional event_trigger = 5
An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
Function.State state = 6
Output only. State of the function.
optional update_time = 7
Output only. The last update timestamp of a Cloud Function.
map<string, string> labels = 8
Labels associated with this Cloud Function.
repeated state_messages = 9
Output only. State Messages for this Cloud Function.
Environment environment = 10
Describe whether the function is 1st Gen or 2nd Gen.
string url = 14
Output only. The deployed url for the function.
string kms_key_name = 25
[Preview] 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}`.
bool satisfies_pzs = 27
Output only. Reserved for future use.
optional create_time = 28
Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.
Describes the current state of the function.
Used in:
STATE_UNSPECIFIED = 0
Not specified. Invalid state.
ACTIVE = 1
Function has been successfully deployed and is serving.
FAILED = 2
Function deployment failed and the function is not serving.
DEPLOYING = 3
Function is being created or updated.
DELETING = 4
Function is being deleted.
UNKNOWN = 5
Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.
message
functions.proto:1080Describes a runtime and any special information (e.g., deprecation status) related to it.
Used in:
string name = 1
The name of the runtime, e.g., 'go113', 'nodejs12', etc.
string display_name = 5
The user facing name, eg 'Go 1.13', 'Node.js 12', etc.
RuntimeStage stage = 2
The stage of life this runtime is in, e.g., BETA, GA, etc.
repeated string warnings = 3
Warning messages, e.g., a deprecation warning.
Environment environment = 4
The environment for the runtime.
optional deprecation_date = 6
Deprecation date for the runtime.
optional decommission_date = 7
Decommission date for the runtime.
The various stages that a runtime can be in.
Used in:
RUNTIME_STAGE_UNSPECIFIED = 0
Not specified.
DEVELOPMENT = 1
The runtime is in development.
ALPHA = 2
The runtime is in the Alpha stage.
BETA = 3
The runtime is in the Beta stage.
GA = 4
The runtime is generally available.
DEPRECATED = 5
The runtime is deprecated.
DECOMMISSIONED = 6
The runtime is no longer supported.
message
functions.proto:1184Extra GCF specific location information.
repeated Environment environments = 1
The Cloud Function environments this location supports.
message
functions.proto:1136Security patches are only applied when a function is redeployed.
Used in:
string runtime_version = 1
Output only. contains the runtime version which was used during latest function deployment.
message
functions.proto:1143Represents the metadata of the long-running operation.
optional create_time = 1
The time the operation was created.
optional end_time = 2
The time the operation finished running.
string target = 3
Server-defined resource path for the target of the operation.
string verb = 4
Name of the verb executed by the operation.
string status_detail = 5
Human-readable status of the operation, if any.
bool cancel_requested = 6
Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have [google.longrunning.Operation.error][google.longrunning.Operation.error] value with a [google.rpc.Status.code][google.rpc.Status.code] of 1, corresponding to `Code.CANCELLED`.
string api_version = 7
API version used to start the operation.
optional request_resource = 8
The original request that started the operation.
repeated stages = 9
Mechanism for reporting in-progress stages
string build_name = 13
The build name of the function for create and update operations.
OperationType operation_type = 11
The operation type.
The type of the long running operation.
Used in:
OPERATIONTYPE_UNSPECIFIED = 0
Unspecified
CREATE_FUNCTION = 1
CreateFunction
UPDATE_FUNCTION = 2
UpdateFunction
DELETE_FUNCTION = 3
DeleteFunction
message
functions.proto:364Location of the source in a Google Cloud Source Repository.
Used in: ,
oneof revision
A revision within the Cloud Source Repository must be specified in one of these ways.
string branch_name = 3
Regex matching branches to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
string tag_name = 4
Regex matching tags to build. The syntax of the regular expressions accepted is the syntax accepted by RE2 and described at https://github.com/google/re2/wiki/Syntax
string commit_sha = 5
Explicit commit SHA to build.
string project_id = 1
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
string repo_name = 2
Name of the Cloud Source Repository.
string dir = 6
Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's `dir` is specified and is an absolute path, this value is ignored for that step's execution. eg. helloworld (no leading slash allowed)
bool invert_regex = 7
Only trigger a build if the revision regex does NOT match the revision regex.
message
functions.proto:716Configuration 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.
Used in:
string key = 1
Name of the environment variable.
string project_id = 2
Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
string secret = 3
Name of the secret in secret manager (not the full resource name).
string version = 4
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.
message
functions.proto:738Configuration 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.
Used in:
string mount_path = 1
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 path: /etc/secrets
string project_id = 2
Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.
string secret = 3
Name of the secret in secret manager (not the full resource name).
repeated versions = 4
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.
message
functions.proto:740Configuration for a single version.
Used in:
string version = 1
Version of the secret (version number or the string 'latest'). It is preferable to use `latest` version with secret volumes as secret value changes are reflected immediately.
string path = 2
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`.
message
functions.proto:547Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
Used in:
string service = 1
Output only. Name of the service associated with a Function. The format of this field is `projects/{project}/locations/{region}/services/{service}`
int32 timeout_seconds = 2
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.
string available_memory = 13
The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.
string available_cpu = 22
The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU
map<string, string> environment_variables = 4
Environment variables that shall be available during function execution.
int32 max_instance_count = 5
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.
int32 min_instance_count = 12
The limit on the minimum number of function instances that may coexist at a given time. Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.
string vpc_connector = 6
The Serverless VPC Access connector that this cloud function can connect to. The format of this field is `projects/*/locations/*/connectors/*`.
ServiceConfig.VpcConnectorEgressSettings vpc_connector_egress_settings = 7
The egress settings for the connector, controlling what traffic is diverted through it.
ServiceConfig.IngressSettings ingress_settings = 8
The ingress settings for the function, controlling what traffic can reach it.
string uri = 9
Output only. URI of the Service deployed.
string service_account_email = 10
The email of the service's service account. If empty, defaults to `{project_number}-compute@developer.gserviceaccount.com`.
bool all_traffic_on_latest_revision = 16
Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.
repeated secret_environment_variables = 17
Secret environment variables configuration.
repeated secret_volumes = 19
Secret volumes configuration.
string revision = 18
Output only. The name of service revision.
int32 max_instance_request_concurrency = 20
Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.
ServiceConfig.SecurityLevel security_level = 21
Security level configure whether the function only accepts https. This configuration is only applicable to 1st Gen functions with Http trigger. By default https is optional for 1st Gen functions; 2nd Gen functions are https ONLY.
string binary_authorization_policy = 23
Optional. The binary authorization policy to be checked when deploying the Cloud Run service.
Available ingress settings. This controls what traffic can reach the function. If unspecified, ALLOW_ALL will be used.
Used in:
INGRESS_SETTINGS_UNSPECIFIED = 0
Unspecified.
ALLOW_ALL = 1
Allow HTTP traffic from public and private sources.
ALLOW_INTERNAL_ONLY = 2
Allow HTTP traffic from only private VPC sources.
ALLOW_INTERNAL_AND_GCLB = 3
Allow HTTP traffic from private VPC sources and through GCLB.
Available security level settings. This enforces security protocol on function URL. Security level is only configurable for 1st Gen functions, If unspecified, SECURE_OPTIONAL will be used. 2nd Gen functions are SECURE_ALWAYS ONLY.
Used in:
SECURITY_LEVEL_UNSPECIFIED = 0
Unspecified.
SECURE_ALWAYS = 1
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_OPTIONAL = 2
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.
Available egress settings. This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_RANGES_ONLY will be used.
Used in:
VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED = 0
Unspecified.
PRIVATE_RANGES_ONLY = 1
Use the VPC Access Connector only for private IP space from RFC1918.
ALL_TRAFFIC = 2
Force the use of VPC Access Connector for all egress traffic from the function.
message
functions.proto:404The location of the function source code.
Used in:
oneof source
Location of the source. At least one source needs to be provided for the deployment to succeed.
storage_source = 1
If provided, get the source from this location in Google Cloud Storage.
repo_source = 2
If provided, get the source from this location in a Cloud Source Repository.
string git_uri = 3
If provided, get the source from GitHub repository. This option is valid only for GCF 1st Gen function. Example: https://github.com/<user>/<repo>/blob/<commit>/<path-to-code>
message
functions.proto:424Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
Used in:
optional resolved_storage_source = 1
A copy of the build's `source.storage_source`, if exists, with any generations resolved.
optional resolved_repo_source = 2
A copy of the build's `source.repo_source`, if exists, with any revisions resolved.
string git_uri = 3
A copy of the build's `source.git_uri`, if exists, with any commits resolved.
message
functions.proto:1190Each Stage of the deployment process
Used in:
Stage.Name name = 1
Name of the Stage. This will be unique for each Stage.
string message = 2
Message describing the Stage
Stage.State state = 3
Current state of the Stage
string resource = 4
Resource of the Stage
string resource_uri = 5
Link to the current Stage resource
repeated state_messages = 6
State messages from the current Stage.
Possible names for a Stage
Used in:
NAME_UNSPECIFIED = 0
Not specified. Invalid name.
ARTIFACT_REGISTRY = 1
Artifact Regsitry Stage
BUILD = 2
Build Stage
SERVICE = 3
Service Stage
TRIGGER = 4
Trigger Stage
SERVICE_ROLLBACK = 5
Service Rollback Stage
TRIGGER_ROLLBACK = 6
Trigger Rollback Stage
Possible states for a Stage
Used in:
STATE_UNSPECIFIED = 0
Not specified. Invalid state.
NOT_STARTED = 1
Stage has not started.
IN_PROGRESS = 2
Stage is in progress.
COMPLETE = 3
Stage has completed.
message
functions.proto:314Informational messages about the state of the Cloud Function or Operation.
Used in: ,
StateMessage.Severity severity = 1
Severity of the state message.
string type = 2
One-word CamelCase type of the state message.
string message = 3
The message.
Severity of the state message.
Used in:
SEVERITY_UNSPECIFIED = 0
Not specified. Invalid severity.
ERROR = 1
ERROR-level severity.
WARNING = 2
WARNING-level severity.
INFO = 3
INFO-level severity.
message
functions.proto:341Location of the source in an archive file in Google Cloud Storage.
Used in: , ,
string bucket = 1
Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).
string object = 2
Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.
int64 generation = 3
Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
string source_upload_url = 4
When the specified storage bucket is a 1st gen function uploard url bucket, this field should be set as the generated upload url for 1st gen deployment.