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 bothallServices
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[] |
The configuration for logging of each type of permission.
|
service |
Specifies a service that will be enabled for audit logging. For example,
|
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[] |
Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.
|
logType |
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
Associatesmembers
, or principals, with a role
.
Fields | |
---|---|
condition |
The condition that is associated with this binding. If the condition evaluates to
|
members[] |
Specifies the principals requesting access for a Google Cloud resource.
|
role |
Role that is assigned to the list of
|
BuildConfig
Describes the Build step of the function that builds a container from the given source.Fields | |
---|---|
build |
Output only. The Cloud Build name of the latest successful deployment of the function.
|
buildpackStack |
Specifies one of the Google provided buildpack stacks.
|
dockerRegistry |
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
|
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 |
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
|
entryPoint |
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
|
environmentVariables |
User-provided build-time environment variables for the function
|
runtime |
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
|
source |
The location of the function source code.
|
sourceProvenance |
Output only. A permanent fixed identifier for source.
|
workerPool |
Name of the Cloud Build Custom Worker Pool that should be used to build the function. The format of this field is
|
EventFilter
Filters events based on exact matches on the CloudEvents attributes.Fields | |
---|---|
attribute |
Required. The name of a CloudEvents attribute.
|
operator |
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
|
value |
Required. The value for the attribute.
|
EventTrigger
Describes EventTrigger, used to request events to be sent from another service.Fields | |
---|---|
channel |
Optional. The name of the channel associated with the trigger in
|
eventFilters[] |
Criteria used to filter events.
|
eventType |
Required. The type of event to observe. For example:
|
pubsubTopic |
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:
|
retryPolicy |
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 |
Optional. The email of the trigger's service account. The service account must have permission to invoke Cloud Run services, the permission is
|
trigger |
Output only. The resource name of the Eventarc trigger. The format of this field is
|
triggerRegion |
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 |
Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
|
expression |
Textual representation of an expression in Common Expression Language syntax.
|
location |
Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
|
title |
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 |
Describes the Build step of the function that builds a container from the given source.
|
description |
User-provided description of a function.
|
environment |
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 |
An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service.
|
labels |
Labels associated with this Cloud Function.
|
name |
A user-defined name of the function. Function names must be unique globally and match pattern
|
serviceConfig |
Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed).
|
state |
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[] |
Output only. State Messages for this Cloud Function.
|
updateTime |
Output only. The last update timestamp of a Cloud Function.
|
GenerateDownloadUrlResponse
Response ofGenerateDownloadUrl
method.
Fields | |
---|---|
downloadUrl |
The generated Google Cloud Storage signed URL that should be used for function source code download.
|
GenerateUploadUrlResponse
Response ofGenerateSourceUploadUrl
method.
Fields | |
---|---|
storageSource |
The location of the source code in the upload bucket. Once the archive is uploaded using the
|
uploadUrl |
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 |
API version used to start the operation.
|
cancelRequested |
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
|
createTime |
The time the operation was created.
|
endTime |
The time the operation finished running.
|
requestResource |
The original request that started the operation.
|
stages[] |
Mechanism for reporting in-progress stages
|
statusDetail |
Human-readable status of the operation, if any.
|
target |
Server-defined resource path for the target of the operation.
|
verb |
Name of the verb executed by the operation.
|
GoogleCloudFunctionsV2Stage
Each Stage of the deployment processFields | |
---|---|
message |
Message describing the Stage
|
name |
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 |
Resource of the Stage
|
resourceUri |
Link to the current Stage resource
|
state |
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[] |
State messages from the current Stage.
|
GoogleCloudFunctionsV2StateMessage
Informational messages about the state of the Cloud Function or Operation.Fields | |
---|---|
message |
The message.
|
severity |
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 |
One-word CamelCase type of the state message.
|
GoogleCloudFunctionsV2alphaOperationMetadata
Represents the metadata of the long-running operation.Fields | |
---|---|
apiVersion |
API version used to start the operation.
|
cancelRequested |
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
|
createTime |
The time the operation was created.
|
endTime |
The time the operation finished running.
|
requestResource |
The original request that started the operation.
|
stages[] |
Mechanism for reporting in-progress stages
|
statusDetail |
Human-readable status of the operation, if any.
|
target |
Server-defined resource path for the target of the operation.
|
verb |
Name of the verb executed by the operation.
|
GoogleCloudFunctionsV2alphaStage
Each Stage of the deployment processFields | |
---|---|
message |
Message describing the Stage
|
name |
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 |
Resource of the Stage
|
resourceUri |
Link to the current Stage resource
|
state |
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[] |
State messages from the current Stage.
|
GoogleCloudFunctionsV2alphaStateMessage
Informational messages about the state of the Cloud Function or Operation.Fields | |
---|---|
message |
The message.
|
severity |
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 |
One-word CamelCase type of the state message.
|
GoogleCloudFunctionsV2betaOperationMetadata
Represents the metadata of the long-running operation.Fields | |
---|---|
apiVersion |
API version used to start the operation.
|
cancelRequested |
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
|
createTime |
The time the operation was created.
|
endTime |
The time the operation finished running.
|
requestResource |
The original request that started the operation.
|
stages[] |
Mechanism for reporting in-progress stages
|
statusDetail |
Human-readable status of the operation, if any.
|
target |
Server-defined resource path for the target of the operation.
|
verb |
Name of the verb executed by the operation.
|
GoogleCloudFunctionsV2betaStage
Each Stage of the deployment processFields | |
---|---|
message |
Message describing the Stage
|
name |
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 |
Resource of the Stage
|
resourceUri |
Link to the current Stage resource
|
state |
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[] |
State messages from the current Stage.
|
GoogleCloudFunctionsV2betaStateMessage
Informational messages about the state of the Cloud Function or Operation.Fields | |
---|---|
message |
The message.
|
severity |
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 |
One-word CamelCase type of the state message.
|
ListFunctionsResponse
Response for theListFunctions
method.
Fields | |
---|---|
functions[] |
The functions that match the request.
|
nextPageToken |
A token, which can be sent as
|
unreachable[] |
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[] |
A list of locations that matches the specified filter in the request.
|
nextPageToken |
The standard List next-page token.
|
ListOperationsResponse
The response message for Operations.ListOperations.Fields | |
---|---|
nextPageToken |
The standard List next-page token.
|
operations[] |
A list of operations that matches the specified filter in the request.
|
ListRuntimesResponse
Response for theListRuntimes
method.
Fields | |
---|---|
runtimes[] |
The runtimes that match the request.
|
Location
A resource that represents Google Cloud Platform location.Fields | |
---|---|
displayName |
The friendly name for this location, typically a nearby city name. For example, "Tokyo".
|
labels |
Cross-service attributes for the location. For example {"cloud.googleapis.com/region": "us-east1"}
|
locationId |
The canonical id for this location. For example:
|
metadata |
Service-specific metadata. For example the available capacity at the given location.
|
name |
Resource name for the location, which may vary between implementations. For example:
|
Operation
This resource represents a long-running operation that is the result of a network API call.Fields | |
---|---|
done |
If the value is
|
error |
The error result of the operation in case of failure or cancellation.
|
metadata |
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 |
The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the
|
response |
The normal response of the operation in case of success. If the original method returns no data on success, such as
|
OperationMetadataV1
Metadata describing an OperationFields | |
---|---|
buildId |
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 |
The Cloud Build Name of the function deployment. This field is only populated for Create and Update operations.
|
request |
The original request that started the operation.
|
sourceToken |
An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
|
target |
Target of the operation - for example
|
type |
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 |
The last update timestamp of the operation.
|
versionId |
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. APolicy
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[] |
Specifies cloud audit logging configuration for this policy.
|
bindings[] |
Associates a list of
|
etag |
|
version |
Specifies the format of the policy. Valid values are
|
RepoSource
Location of the source in a Google Cloud Source Repository.Fields | |
---|---|
branchName |
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 |
Explicit commit SHA to build.
|
dir |
Directory, relative to the source root, in which to run the build. This must be a relative path. If a step's
|
invertRegex |
Only trigger a build if the revision regex does NOT match the revision regex.
|
projectId |
ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.
|
repoName |
Name of the Cloud Source Repository.
|
tagName |
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 |
The user facing name, eg 'Go 1.13', 'Node.js 12', etc.
|
environment |
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 |
The name of the runtime, e.g., 'go113', 'nodejs12', etc.
|
stage |
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[] |
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 |
Name of the environment variable.
|
projectId |
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 |
Name of the secret in secret manager (not the full resource name).
|
version |
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 |
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
|
version |
Version of the secret (version number or the string 'latest'). It is preferable to use
|
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 |
The path within the container to mount the secret volume. For example, setting the mount_path as
|
projectId |
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 |
Name of the secret in secret manager (not the full resource name).
|
versions[] |
List of secret versions to mount for this secret. If empty, the
|
ServiceConfig
Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).Fields | |
---|---|
allTrafficOnLatestRevision |
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 |
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 |
Environment variables that shall be available during function execution.
|
ingressSettings |
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 |
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 |
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 |
Output only. The name of service revision.
|
secretEnvironmentVariables[] |
Secret environment variables configuration.
|
secretVolumes[] |
Secret volumes configuration.
|
securityLevel |
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 |
Output only. Name of the service associated with a Function. The format of this field is
|
serviceAccountEmail |
The email of the service's service account. If empty, defaults to
|
timeoutSeconds |
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 |
Output only. URI of the Service deployed.
|
vpcConnector |
The Serverless VPC Access connector that this cloud function can connect to. The format of this field is
|
vpcConnectorEgressSettings |
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 forSetIamPolicy
method.
Fields | |
---|---|
policy |
REQUIRED: The complete policy to be applied to the
|
updateMask |
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:
|
Source
The location of the function source code.Fields | |
---|---|
repoSource |
If provided, get the source from this location in a Cloud Source Repository.
|
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 |
A copy of the build's
|
resolvedStorageSource |
A copy of the build's
|
Status
TheStatus
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 |
The status code, which should be an enum value of google.rpc.Code.
|
details[] |
A list of messages that carry the error details. There is a common set of message types for APIs to use.
|
message |
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 |
Google Cloud Storage bucket containing the source (see Bucket Name Requirements).
|
generation |
Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.
|
object |
Google Cloud Storage object containing the source. This object must be a gzipped archive file (
|
TestIamPermissionsRequest
Request message forTestIamPermissions
method.
Fields | |
---|---|
permissions[] |
The set of permissions to check for the
|
TestIamPermissionsResponse
Response message forTestIamPermissions
method.
Fields | |
---|---|
permissions[] |
A subset of
|