Types overview

AuditConfig

Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[e-mail]" ] }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:[e-mail]" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts [e-mail] from DATA_READ logging, and [e-mail] from DATA_WRITE logging.

Fields
auditLogConfigs[]	object (AuditLogConfig) The configuration for logging of each type of permission.
service	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

Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:[e-mail]" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting [e-mail] from DATA_READ logging.

Fields
exemptedMembers[]	string Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
logType	enum The log type that this config enables.
Enum type. Can be one of the following:
LOG_TYPE_UNSPECIFIED	Default case. Should never be this.
ADMIN_READ	Admin reads. Example: CloudIAM getIamPolicy
DATA_WRITE	Data writes. Example: CloudSQL Users create
DATA_READ	Data reads. Example: CloudSQL Users list

Binding

Associates members with a role.

Fields
condition	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.
members[]	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, [e-mail] . * serviceAccount:{emailid}: An email address that represents a service account. For example, [e-mail]. * group:{emailid}: An email address that represents a Google group. For example, [e-mail]. * deleted:user:{emailid}?uid={uniqueid}: An email address (plus unique identifier) representing a user that has been recently deleted. For example, [e-mail]?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, [e-mail]?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, [e-mail]?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.
role	string Role that is assigned to members. For example, roles/viewer, roles/editor, or roles/owner.

CallFunctionRequest

Request for the CallFunction method.

Fields
data	string Required. Input to be passed to the function.

CallFunctionResponse

Response of CallFunction method.

Fields
error	string Either system or user-function generated error. Set if execution was not successful.
executionId	string Execution id of function invocation.
result	string Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context.

CloudFunction

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. Next tag: 35

Fields
availableMemoryMb	integer (int32 format) The amount of memory in MB available for a function. Defaults to 256MB.
buildEnvironmentVariables	map (key: string, value: string) Build environment variables that shall be available during build time.
buildId	string Output only. The Cloud Build ID of the latest successful deployment of the function.
buildName	string Output only. The Cloud Build Name of the function deployment. projects//locations//builds/.
buildWorkerPool	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 ([e-mail]) must be granted the role Cloud Build Custom Workers Builder (roles/cloudbuild.customworkers.builder) in the project.
description	string User-provided description of a function.
entryPoint	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.
environmentVariables	map (key: string, value: string) Environment variables that shall be available during function execution.
eventTrigger	object (EventTrigger) A source that fires events in response to a condition in another service.
httpsTrigger	object (HttpsTrigger) An HTTPS endpoint type of source that can be triggered via URL.
ingressSettings	enum The ingress settings for the function, controlling what traffic can reach it.
Enum type. Can be one of the following:
INGRESS_SETTINGS_UNSPECIFIED	Unspecified.
ALLOW_ALL	Allow HTTP traffic from public and private sources.
ALLOW_INTERNAL_ONLY	Allow HTTP traffic from only private VPC sources.
ALLOW_INTERNAL_AND_GCLB	Allow HTTP traffic from private VPC sources and through GCLB.
labels	map (key: string, value: string) Labels associated with this Cloud Function.
maxInstances	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.
minInstances	integer (int32 format) A lower bound for the number function instances that may coexist at a given time.
name	string A user-defined name of the function. Function names must be unique globally and match pattern projects/*/locations/*/functions/*
network	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.
runtime	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.
secretEnvironmentVariables[]	object (SecretEnvVar) Secret environment variables configuration.
secretVolumes[]	object (SecretVolume) Secret volumes configuration.
serviceAccountEmail	string The email of the function's service account. If empty, defaults to {project_id}@appspot.gserviceaccount.com.
sourceArchiveUrl	string The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.
sourceRepository	object (SourceRepository) Beta Feature The source repository where a function is hosted.
sourceToken	string Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
sourceUploadUrl	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)
status	enum Output only. Status of the function deployment.
Enum type. Can be one of the following:
CLOUD_FUNCTION_STATUS_UNSPECIFIED	Not specified. Invalid state.
ACTIVE	Function has been successfully deployed and is serving.
OFFLINE	Function deployment failed and the function isn’t serving.
DEPLOY_IN_PROGRESS	Function is being created or updated.
DELETE_IN_PROGRESS	Function is being deleted.
UNKNOWN	Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.
timeout	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.
updateTime	string (Timestamp format) Output only. The last update timestamp of a Cloud Function.
versionId	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.
vpcConnector	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.
vpcConnectorEgressSettings	enum The egress settings for the connector, controlling what traffic is diverted through it.
Enum type. Can be one of the following:
VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED	Unspecified.
PRIVATE_RANGES_ONLY	Use the VPC Access Connector only for private IP space from RFC1918.
ALL_TRAFFIC	Force the use of VPC Access Connector for all egress traffic from the function.

EventTrigger

Describes EventTrigger, used to request events be sent from another service.

Fields
eventType	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.
failurePolicy	object (FailurePolicy) Specifies policy for failed executions.
resource	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.
service	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

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

Fields
description	string Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
expression	string Textual representation of an expression in Common Expression Language syntax.
location	string Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
title	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

Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).

Fields
retry	object (Retry) If specified, then the function will be retried in case of a failure.

GenerateDownloadUrlRequest

Request of GenerateDownloadUrl method.

Fields
versionId	string (uint64 format) The optional version of function. If not set, default, current version is used.

GenerateDownloadUrlResponse

Response of GenerateDownloadUrl method.

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

GenerateUploadUrlResponse

Response of GenerateSourceUploadUrl method.

Fields
uploadUrl	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

Describes HttpsTrigger, could be used to connect web hooks to function.

Fields
securityLevel	enum The security level for the function.
Enum type. Can be one of the following:
SECURITY_LEVEL_UNSPECIFIED	Unspecified.
SECURE_ALWAYS	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	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.
url	string Output only. The deployed url for the function.

ListFunctionsResponse

Response for the ListFunctions method.

Fields
functions[]	object (CloudFunction) The functions that match the request.
nextPageToken	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.
unreachable[]	string Locations that could not be reached. The response does not include any functions from these locations.

ListLocationsResponse

The response message for Locations.ListLocations.

Fields
locations[]	object (Location) A list of locations that matches the specified filter in the request.
nextPageToken	string The standard List next-page token.

ListOperationsResponse

The response message for Operations.ListOperations.

Fields
nextPageToken	string The standard List next-page token.
operations[]	object (Operation) A list of operations that matches the specified filter in the request.

Location

A resource that represents Google Cloud Platform location.

Fields
displayName	string The friendly name for this location, typically a nearby city name. For example, "Tokyo".
labels	map (key: string, value: string) Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
locationId	string The canonical id for this location. For example: "us-east1".
metadata	map (key: string, value: any) Service-specific metadata. For example the available capacity at the given location.
name	string Resource name for the location, which may vary between implementations. For example: "projects/example-project/locations/us-east1"

Operation

This resource represents a long-running operation that is the result of a network API call.

Fields
done	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.
error	object (Status) The error result of the operation in case of failure or cancellation.
metadata	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.
name	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}.
response	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

Metadata describing an Operation

Fields
buildId	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.
buildName	string The Cloud Build Name of the function deployment. This field is only populated for Create and Update operations. projects//locations//builds/.
request	map (key: string, value: any) The original request that started the operation.
sourceToken	string An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
target	string Target of the operation - for example projects/project-1/locations/region-1/functions/function-1
type	enum Type of operation.
Enum type. Can be one of the following:
OPERATION_UNSPECIFIED	Unknown operation type.
CREATE_FUNCTION	Triggered by CreateFunction call
UPDATE_FUNCTION	Triggered by UpdateFunction call
DELETE_FUNCTION	Triggered by DeleteFunction call.
updateTime	string (Timestamp format) The last update timestamp of the operation.
versionId	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

An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A Policy is a collection of bindings. A binding binds one or more members to a single role. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A role is a named list of permissions; each role can be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, a binding can also specify a condition, which is a logical expression that allows access to a resource only if the expression evaluates to true. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the IAM documentation. JSON example: { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:[e-mail]", "group:[e-mail]", "domain:google.com", "serviceAccount:[e-mail]" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:[e-mail]" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 } YAML example: bindings: - members: - user:[e-mail] - group:[e-mail] - domain:google.com - serviceAccount:[e-mail] role: roles/resourcemanager.organizationAdmin - members: - user:[e-mail] role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') etag: BwWWja0YfJA= version: 3 For a description of IAM and its features, see the IAM documentation.

Fields
auditConfigs[]	object (AuditConfig) Specifies cloud audit logging configuration for this policy.
bindings[]	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.
etag	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.
version	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

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.

Fields
key	string Name of the environment variable.
projectId	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.
secret	string Name of the secret in secret manager (not the full resource name).
version	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

Configuration for a single version.

Fields
path	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.
version	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

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.

Fields
mountPath	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
projectId	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.
secret	string Name of the secret in secret manager (not the full resource name).
versions[]	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

Request message for SetIamPolicy method.

Fields
policy	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.
updateMask	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

Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.

Fields
deployedUrl	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.
url	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

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

Fields
code	integer (int32 format) The status code, which should be an enum value of google.rpc.Code.
details[]	object A list of messages that carry the error details. There is a common set of message types for APIs to use.
message	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

Request message for TestIamPermissions method.

Fields
permissions[]	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

Response message for TestIamPermissions method.

Fields
permissions[]	string A subset of TestPermissionsRequest.permissions that the caller is allowed.