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:jose@example.com" ] }, { "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:aliya@example.com" ] } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com 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:jose@example.com" ] }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com 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, or principals, 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 principals in this binding. To learn which resources support conditions in their IAM policies, see the IAM documentation.

members[]

string

Specifies the principals requesting access for a Google Cloud 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * user:{emailid}: An email address that represents a specific Google account. For example, alice@example.com . * serviceAccount:{emailid}: An email address that represents a Google service account. For example, my-other-app@appspot.gserviceaccount.com. * serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]: An identifier for a Kubernetes service account. For example, my-project.svc.id.goog[my-namespace/my-kubernetes-sa]. * 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.

role

string

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

BuildConfig

Describes the Build step of the function that builds a container from the given source.
Fields
build

string

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

buildpackStack

string

Specifies one of the Google provided buildpack stacks.

dockerRegistry

enum

Optional. 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 docker_repository field is specified, this field will be automatically set as ARTIFACT_REGISTRY. If unspecified, it currently defaults to CONTAINER_REGISTRY. This field may be overridden by the backend for eligible deployments.

Enum type. Can be one of the following:
DOCKER_REGISTRY_UNSPECIFIED Unspecified.
CONTAINER_REGISTRY Docker images will be stored in multi-regional Container Registry repositories named gcf.
ARTIFACT_REGISTRY 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.
dockerRepository

string

User managed repository created in Artifact Registry optionally with a customer managed encryption key. This is the repository to which the function docker image will be pushed after it is built by Cloud Build. If unspecified, 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'.

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)

User-provided build-time environment variables for the function

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.

source

object (Source)

The location of the function source code.

sourceProvenance

object (SourceProvenance)

Output only. A permanent fixed identifier for source.

workerPool

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.

EventFilter

Filters events based on exact matches on the CloudEvents attributes.
Fields
attribute

string

Required. The name of a CloudEvents attribute.

operator

string

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.

value

string

Required. The value for the attribute.

EventTrigger

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

string

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.

eventFilters[]

object (EventFilter)

Criteria used to filter events.

eventType

string

Required. The type of event to observe. For example: google.cloud.audit.log.v1.written or google.cloud.pubsub.topic.v1.messagePublished.

pubsubTopic

string

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.

retryPolicy

enum

Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).

Enum type. Can be one of the following:
RETRY_POLICY_UNSPECIFIED Not specified.
RETRY_POLICY_DO_NOT_RETRY Do not retry.
RETRY_POLICY_RETRY Retry on any failure, retry up to 7 days with an exponential backoff (capped at 10 seconds).
serviceAccountEmail

string

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.

trigger

string

Output only. The resource name of the Eventarc trigger. The format of this field is projects/{project}/locations/{region}/triggers/{trigger}.

triggerRegion

string

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.

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.

Function

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.
Fields
buildConfig

object (BuildConfig)

Describes the Build step of the function that builds a container from the given source.

description

string

User-provided description of a function.

environment

enum

Describe whether the function is gen1 or gen2.

Enum type. Can be one of the following:
ENVIRONMENT_UNSPECIFIED Unspecified
GEN_1 Gen 1
GEN_2 Gen 2
eventTrigger

object (EventTrigger)

An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.

labels

map (key: string, value: string)

Labels associated with this Cloud Function.

name

string

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

serviceConfig

object (ServiceConfig)

Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).

state

enum

Output only. State of the function.

Enum type. Can be one of the following:
STATE_UNSPECIFIED Not specified. Invalid state.
ACTIVE Function has been successfully deployed and is serving.
FAILED Function deployment failed and the function is not serving.
DEPLOYING Function is being created or updated.
DELETING 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.
stateMessages[]

object (GoogleCloudFunctionsV2StateMessage)

Output only. State Messages for this Cloud Function.

updateTime

string (Timestamp format)

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

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
storageSource

object (StorageSource)

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.

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.

GoogleCloudFunctionsV2OperationMetadata

Represents the metadata of the long-running operation.
Fields
apiVersion

string

API version used to start the operation.

cancelRequested

boolean

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

createTime

string (Timestamp format)

The time the operation was created.

endTime

string (Timestamp format)

The time the operation finished running.

requestResource

map (key: string, value: any)

The original request that started the operation.

stages[]

object (GoogleCloudFunctionsV2Stage)

Mechanism for reporting in-progress stages

statusDetail

string

Human-readable status of the operation, if any.

target

string

Server-defined resource path for the target of the operation.

verb

string

Name of the verb executed by the operation.

GoogleCloudFunctionsV2Stage

Each Stage of the deployment process
Fields
message

string

Message describing the Stage

name

enum

Name of the Stage. This will be unique for each Stage.

Enum type. Can be one of the following:
NAME_UNSPECIFIED Not specified. Invalid name.
ARTIFACT_REGISTRY Artifact Regsitry Stage
BUILD Build Stage
SERVICE Service Stage
TRIGGER Trigger Stage
SERVICE_ROLLBACK Service Rollback Stage
TRIGGER_ROLLBACK Trigger Rollback Stage
resource

string

Resource of the Stage

resourceUri

string

Link to the current Stage resource

state

enum

Current state of the Stage

Enum type. Can be one of the following:
STATE_UNSPECIFIED Not specified. Invalid state.
NOT_STARTED Stage has not started.
IN_PROGRESS Stage is in progress.
COMPLETE Stage has completed.
stateMessages[]

object (GoogleCloudFunctionsV2StateMessage)

State messages from the current Stage.

GoogleCloudFunctionsV2StateMessage

Informational messages about the state of the Cloud Function or Operation.
Fields
message

string

The message.

severity

enum

Severity of the state message.

Enum type. Can be one of the following:
SEVERITY_UNSPECIFIED Not specified. Invalid severity.
ERROR ERROR-level severity.
WARNING WARNING-level severity.
INFO INFO-level severity.
type

string

One-word CamelCase type of the state message.

GoogleCloudFunctionsV2alphaOperationMetadata

Represents the metadata of the long-running operation.
Fields
apiVersion

string

API version used to start the operation.

cancelRequested

boolean

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

createTime

string (Timestamp format)

The time the operation was created.

endTime

string (Timestamp format)

The time the operation finished running.

requestResource

map (key: string, value: any)

The original request that started the operation.

stages[]

object (GoogleCloudFunctionsV2alphaStage)

Mechanism for reporting in-progress stages

statusDetail

string

Human-readable status of the operation, if any.

target

string

Server-defined resource path for the target of the operation.

verb

string

Name of the verb executed by the operation.

GoogleCloudFunctionsV2alphaStage

Each Stage of the deployment process
Fields
message

string

Message describing the Stage

name

enum

Name of the Stage. This will be unique for each Stage.

Enum type. Can be one of the following:
NAME_UNSPECIFIED Not specified. Invalid name.
ARTIFACT_REGISTRY Artifact Regsitry Stage
BUILD Build Stage
SERVICE Service Stage
TRIGGER Trigger Stage
SERVICE_ROLLBACK Service Rollback Stage
TRIGGER_ROLLBACK Trigger Rollback Stage
resource

string

Resource of the Stage

resourceUri

string

Link to the current Stage resource

state

enum

Current state of the Stage

Enum type. Can be one of the following:
STATE_UNSPECIFIED Not specified. Invalid state.
NOT_STARTED Stage has not started.
IN_PROGRESS Stage is in progress.
COMPLETE Stage has completed.
stateMessages[]

object (GoogleCloudFunctionsV2alphaStateMessage)

State messages from the current Stage.

GoogleCloudFunctionsV2alphaStateMessage

Informational messages about the state of the Cloud Function or Operation.
Fields
message

string

The message.

severity

enum

Severity of the state message.

Enum type. Can be one of the following:
SEVERITY_UNSPECIFIED Not specified. Invalid severity.
ERROR ERROR-level severity.
WARNING WARNING-level severity.
INFO INFO-level severity.
type

string

One-word CamelCase type of the state message.

GoogleCloudFunctionsV2betaOperationMetadata

Represents the metadata of the long-running operation.
Fields
apiVersion

string

API version used to start the operation.

cancelRequested

boolean

Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have Operation.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED.

createTime

string (Timestamp format)

The time the operation was created.

endTime

string (Timestamp format)

The time the operation finished running.

requestResource

map (key: string, value: any)

The original request that started the operation.

stages[]

object (GoogleCloudFunctionsV2betaStage)

Mechanism for reporting in-progress stages

statusDetail

string

Human-readable status of the operation, if any.

target

string

Server-defined resource path for the target of the operation.

verb

string

Name of the verb executed by the operation.

GoogleCloudFunctionsV2betaStage

Each Stage of the deployment process
Fields
message

string

Message describing the Stage

name

enum

Name of the Stage. This will be unique for each Stage.

Enum type. Can be one of the following:
NAME_UNSPECIFIED Not specified. Invalid name.
ARTIFACT_REGISTRY Artifact Regsitry Stage
BUILD Build Stage
SERVICE Service Stage
TRIGGER Trigger Stage
SERVICE_ROLLBACK Service Rollback Stage
TRIGGER_ROLLBACK Trigger Rollback Stage
resource

string

Resource of the Stage

resourceUri

string

Link to the current Stage resource

state

enum

Current state of the Stage

Enum type. Can be one of the following:
STATE_UNSPECIFIED Not specified. Invalid state.
NOT_STARTED Stage has not started.
IN_PROGRESS Stage is in progress.
COMPLETE Stage has completed.
stateMessages[]

object (GoogleCloudFunctionsV2betaStateMessage)

State messages from the current Stage.

GoogleCloudFunctionsV2betaStateMessage

Informational messages about the state of the Cloud Function or Operation.
Fields
message

string

The message.

severity

enum

Severity of the state message.

Enum type. Can be one of the following:
SEVERITY_UNSPECIFIED Not specified. Invalid severity.
ERROR ERROR-level severity.
WARNING WARNING-level severity.
INFO INFO-level severity.
type

string

One-word CamelCase type of the state message.

ListFunctionsResponse

Response for the ListFunctions method.
Fields
functions[]

object (Function)

The functions that match the request.

nextPageToken

string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages.

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.

ListRuntimesResponse

Response for the ListRuntimes method.
Fields
runtimes[]

object (Runtime)

The runtimes that match 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, or principals, to a single role. Principals 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:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "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:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com 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, or principals, with 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 principal. The bindings in a Policy can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the bindings grant 50 different roles to user:alice@example.com, and not to any other principal, then you can add another 1,450 principals to the bindings in the Policy.

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.

RepoSource

Location of the source in a Google Cloud Source Repository.
Fields
branchName

string

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

commitSha

string

Explicit commit SHA to build.

dir

string

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)

invertRegex

boolean

Only trigger a build if the revision regex does NOT match the revision regex.

projectId

string

ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.

repoName

string

Name of the Cloud Source Repository.

tagName

string

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

Runtime

Describes a runtime and any special information (e.g., deprecation status) related to it.
Fields
displayName

string

The user facing name, eg 'Go 1.13', 'Node.js 12', etc.

environment

enum

The environment for the runtime.

Enum type. Can be one of the following:
ENVIRONMENT_UNSPECIFIED Unspecified
GEN_1 Gen 1
GEN_2 Gen 2
name

string

The name of the runtime, e.g., 'go113', 'nodejs12', etc.

stage

enum

The stage of life this runtime is in, e.g., BETA, GA, etc.

Enum type. Can be one of the following:
RUNTIME_STAGE_UNSPECIFIED Not specified.
DEVELOPMENT The runtime is in development.
ALPHA The runtime is in the Alpha stage.
BETA The runtime is in the Beta stage.
GA The runtime is generally available.
DEPRECATED The runtime is deprecated.
DECOMMISSIONED The runtime is no longer supported.
warnings[]

string

Warning messages, e.g., a deprecation warning.

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

string

Name of the environment variable.

projectId

string

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.

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 instances 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 preferable 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.
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 path: /etc/secrets

projectId

string

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.

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.

ServiceConfig

Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).
Fields
allTrafficOnLatestRevision

boolean

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.

availableMemory

string

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.

environmentVariables

map (key: string, value: string)

Environment variables that shall be available during function execution.

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

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.

minInstanceCount

integer (int32 format)

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.

revision

string

Output only. The name of service revision.

secretEnvironmentVariables[]

object (SecretEnvVar)

Secret environment variables configuration.

secretVolumes[]

object (SecretVolume)

Secret volumes configuration.

securityLevel

enum

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

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

string

Output only. Name of the service associated with a Function. The format of this field is projects/{project}/locations/{region}/services/{service}

serviceAccountEmail

string

The email of the service's service account. If empty, defaults to {project_number}-compute@developer.gserviceaccount.com.

timeoutSeconds

integer (int32 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.

uri

string

Output only. URI of the Service deployed.

vpcConnector

string

The Serverless VPC Access connector that this cloud function can connect to. The format of this field is projects/*/locations/*/connectors/*.

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.

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 Google Cloud 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"

Source

The location of the function source code.
Fields
repoSource

object (RepoSource)

If provided, get the source from this location in a Cloud Source Repository.

storageSource

object (StorageSource)

If provided, get the source from this location in Google Cloud Storage.

SourceProvenance

Provenance of the source. Ways to find the original source, or verify that some source was used for this build.
Fields
resolvedRepoSource

object (RepoSource)

A copy of the build's source.repo_source, if exists, with any revisions resolved.

resolvedStorageSource

object (StorageSource)

A copy of the build's source.storage_source, if exists, with any generations resolved.

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.

StorageSource

Location of the source in an archive file in Google Cloud Storage.
Fields
bucket

string

Google Cloud Storage bucket containing the source (see Bucket Name Requirements).

generation

string (int64 format)

Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.

object

string

Google Cloud Storage object containing the source. This object must be a gzipped archive file (.tar.gz) containing source to build.

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.