/

Console

• English
• Deutsch
• Español – América Latina
• Français
• Português – Brasil
• 中文 – 简体
• 日本語
• 한국어

Sign in

• Workflows

Start free

Types overview

AuditConfig

object (AuditLogConfig)

The configuration for logging of each type of permission.

string

Specifies a service that will be enabled for audit logging. For example, storage.googleapis.com, cloudsql.googleapis.com. allServices is a special value that covers all services.

AuditLogConfig

string

Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.

enum

The log type that this config enables.

Binding

object (Expr)

The condition that is associated with this binding. If the condition evaluates to true, then this binding applies to the current request. If the condition evaluates to false, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding. To learn which resources support conditions in their IAM policies, see the IAM documentation.

string

Specifies the identities requesting access for a Cloud Platform resource. members can have the following values: * allUsers: A special identifier that represents anyone who is on the internet; with or without a Google account. * allAuthenticatedUsers: A special identifier that represents anyone who is authenticated with a Google account or a service account. * user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . * serviceAccount:{emailid}: An email address that represents a service account. For example, my-other-app@appspot.gserviceaccount.com. * group:{emailid}: An email address that represents a Google group. For example, admins@example.com. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, alice@example.com?uid=123456789012345678901. If the user is recovered, this value reverts to user:{emailid} and the recovered user retains the role in the binding. * deleted:serviceAccount:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901. If the service account is undeleted, this value reverts to serviceAccount:{emailid} and the undeleted service account retains the role in the binding. * deleted:group:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, admins@example.com?uid=123456789012345678901. If the group is recovered, this value reverts to group:{emailid} and the recovered group retains the role in the binding. * domain:{domain}: The G Suite domain (primary) that represents all the users of that domain. For example, google.com or example.com.

string

Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

CallFunctionRequest

string

Required. Input to be passed to the function.

CallFunctionResponse

string

Either system or user-function generated error. Set if execution was not successful.

string

Execution id of function invocation.

string

Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context.

CloudFunction

integer (int32 format)

The amount of memory in MB available for a function. Defaults to 256MB.

map (key: string, value: string)

Build environment variables that shall be available during build time.

string

Output only. The Cloud Build ID of the latest successful deployment of the function.

string

Output only. The Cloud Build Name of the function deployment. projects//locations//builds/.

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-@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.

string

User-provided description of a function.

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.

map (key: string, value: string)

Environment variables that shall be available during function execution.

object (EventTrigger)

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

object (HttpsTrigger)

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

enum

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

map (key: string, value: string)

Labels associated with this Cloud Function.

integer (int32 format)

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.

integer (int32 format)

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

string

A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*

string

The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either projects/{project}/global/networks/{network} or {network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive with vpc_connector and will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.

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.

object (SecretEnvVar)

Secret environment variables configuration.

object (SecretVolume)

Secret volumes configuration.

string

The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.

string

The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.

object (SourceRepository)

Beta Feature The source repository where a function is hosted.

string

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

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)

enum

Output only. Status of the function deployment.

string (Duration format)

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 (Timestamp format)

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

string (int64 format)

Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.

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.

enum

The egress settings for the connector, controlling what traffic is diverted through it.

EventTrigger

string

Required. The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish. Event types match pattern providers/*/eventTypes/*.*. The pattern contains: 1. namespace: For example, cloud.storage and 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.

object (FailurePolicy)

Specifies policy for failed executions.

string

Required. The resource(s) from which to observe events, for example, projects/_/buckets/myBucket. Not all syntactically correct values are accepted by all services. For example: 1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction. 2. The resource type must match the pattern expected for an 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" format. See each service's documentation for supported formats.

string

The hostname of the service that 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.

Expr

string

Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.

string

Textual representation of an expression in Common Expression Language syntax.

string

Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.

string

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.

FailurePolicy

object (Retry)

If specified, then the function will be retried in case of a failure.

GenerateDownloadUrlRequest

string (uint64 format)

The optional version of function. If not set, default, current version is used.

GenerateDownloadUrlResponse

string

The generated Google Cloud Storage signed URL that should be used for function source code download.

GenerateUploadUrlResponse

string

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.

HttpsTrigger

enum

The security level for the function.

string

Output only. The deployed url for the function.

ListFunctionsResponse

object (CloudFunction)

The functions that match the request.

string

If not empty, indicates that there may be more functions that match the request; this value should be passed in a new google.cloud.functions.v1.ListFunctionsRequest to get more functions.

string

Locations that could not be reached. The response does not include any functions from these locations.

ListLocationsResponse

object (Location)

A list of locations that matches the specified filter in the request.

string

The standard List next-page token.

ListOperationsResponse

string

The standard List next-page token.

object (Operation)

A list of operations that matches the specified filter in the request.

Location

string

The friendly name for this location, typically a nearby city name. For example, "Tokyo".

map (key: string, value: string)

Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}

string

The canonical id for this location. For example: "us-east1".

map (key: string, value: any)

Service-specific metadata. For example the available capacity at the given location.

string

Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

Operation

boolean

If the value is false, it means the operation is still in progress. If true, the operation is completed, and either error or response is available.

object (Status)

The error result of the operation in case of failure or cancellation.

map (key: string, value: any)

Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

string

The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the name should be a resource name ending with operations/{unique_id}.

map (key: string, value: any)

The normal response of the operation in case of success. If the original method returns no data on success, such as Delete, the response is google.protobuf.Empty. If the original method is standard Get/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, where Xxx is the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type is TakeSnapshotResponse.

OperationMetadataV1

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.

string

The Cloud Build Name of the function deployment. This field is only populated for Create and Update operations. projects//locations//builds/.

map (key: string, value: any)

The original request that started the operation.

string

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

string

Target of the operation - for example projects/project-1/locations/region-1/functions/function-1

enum

Type of operation.

string (Timestamp format)

The last update timestamp of the operation.

string (int64 format)

Version id of the function created or updated by an API call. This field is only populated for Create and Update operations.

Policy

object (AuditConfig)

Specifies cloud audit logging configuration for this policy.

object (Binding)

Associates a list of members to a role. Optionally, may specify a condition that determines how and when the bindings are applied. Each of the bindings must contain at least one member.

string (bytes format)

etag is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the etag in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An etag is returned in the response to getIamPolicy, and systems are expected to put that etag in the request to setIamPolicy to ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost.

integer (int32 format)

Specifies the format of the policy. Valid values are 0, 1, and 3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version 3. This requirement applies to the following operations: * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions Important: If you use IAM Conditions, you must include the etag field whenever you call setIamPolicy. If you omit this field, then IAM allows you to overwrite a version 3 policy with a version 1 policy, and all of the conditions in the version 3 policy are lost. If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.

SecretEnvVar

string

Name of the environment variable.

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.

string

Name of the secret in secret manager (not the full resource name).

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.

SecretVersion

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.

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.

SecretVolume

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

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.

string

Name of the secret in secret manager (not the full resource name).

object (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.

SetIamPolicyRequest

object (Policy)

REQUIRED: The complete policy to be applied to the resource. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.

string (FieldMask format)

OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only the fields in the mask will be modified. If no mask is provided, the following default mask is used: paths: "bindings, etag"

SourceRepository

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.

string

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats: To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): 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.

Status

integer (int32 format)

The status code, which should be an enum value of google.rpc.Code.

object

A list of messages that carry the error details. There is a common set of message types for APIs to use.

string

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

TestIamPermissionsRequest

string

The set of permissions to check for the resource. Permissions with wildcards (such as '' or 'storage.') are not allowed. For more information see IAM Overview.

TestIamPermissionsResponse

string

A subset of TestPermissionsRequest.permissions that the caller is allowed.