Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://cloud.google.com/functions/docs/reference/rest/v2beta/projects.locations.functions below:

REST Resource: projects.locations.functions | Cloud Run functions Documentation

• Resource: Function
  • JSON representation
• BuildConfig
  • JSON representation
• AutomaticUpdatePolicy
• OnDeployUpdatePolicy
  • JSON representation
• Source
  • JSON representation
• StorageSource
  • JSON representation
• RepoSource
  • JSON representation
• SourceProvenance
  • JSON representation
• DockerRegistry
• ServiceConfig
  • JSON representation
• VpcConnectorEgressSettings
• IngressSettings
• SecretEnvVar
  • JSON representation
• SecretVolume
  • JSON representation
• SecretVersion
  • JSON representation
• SecurityLevel
• EventTrigger
  • JSON representation
• EventFilter
  • JSON representation
• RetryPolicy
• State
• StateMessage
  • JSON representation
• Severity
• Environment
• Methods

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

{
  "name": string,
  "description": string,
  "buildConfig": {
    object (BuildConfig)
  },
  "serviceConfig": {
    object (ServiceConfig)
  },
  "eventTrigger": {
    object (EventTrigger)
  },
  "state": enum (State),
  "updateTime": string,
  "labels": {
    string: string,
    ...
  },
  "stateMessages": [
    {
      object (StateMessage)
    }
  ],
  "environment": enum (Environment),
  "url": string,
  "kmsKeyName": string,
  "satisfiesPzs": boolean,
  "createTime": string,
  "satisfiesPzi": boolean
}

string

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

string

User-provided description of a function.

object (BuildConfig)

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

object (ServiceConfig)

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

object (EventTrigger)

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

enum (State)

Output only. State of the function.

string (Timestamp format)

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

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

map (key: string, value: string)

Labels associated with this Cloud Function.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

object (StateMessage)

Output only. State Messages for this Cloud Function.

enum (Environment)

Describe whether the function is 1st Gen or 2nd Gen.

string

Output only. The deployed url for the function.

string

Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function resources.

It must match the pattern projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}.

boolean

Output only. Reserved for future use.

string (Timestamp format)

Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

boolean

Output only. Reserved for future use.

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

{
  "build": string,
  "runtime": string,
  "entryPoint": string,
  "source": {
    object (Source)
  },
  "sourceProvenance": {
    object (SourceProvenance)
  },
  "workerPool": string,
  "environmentVariables": {
    string: string,
    ...
  },
  "dockerRegistry": enum (DockerRegistry),
  "dockerRepository": string,
  "serviceAccount": string,
  "sourceToken": string,

  // Union field runtime_update_policy can be only one of the following:
  "automaticUpdatePolicy": {
    object (AutomaticUpdatePolicy)
  },
  "onDeployUpdatePolicy": {
    object (OnDeployUpdatePolicy)
  }
  // End of list of possible types for union field runtime_update_policy.
}

string

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

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.

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.

object (Source)

The location of the function source code.

object (SourceProvenance)

Output only. A permanent fixed identifier for source.

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.

map (key: string, value: string)

User-provided build-time environment variables for the function

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

enum (DockerRegistry)

This item is deprecated!

Docker Registry to use for this deployment. This configuration is only applicable to 1st Gen functions, 2nd Gen functions can only use Artifact Registry. Deprecated: Container Registry option will no longer be available after March 2025: https://cloud.google.com/artifact-registry/docs/transition/transition-from-gcr Please use Artifact Registry instead, which is the default choice.

If unspecified, it defaults to ARTIFACT_REGISTRY. If dockerRepository field is specified, this field should either be left unspecified or set to ARTIFACT_REGISTRY.

string

Repository in Artifact Registry to which the function docker image will be pushed after it is built by Cloud Build. If specified by user, it is created and managed by user with a customer managed encryption key. Otherwise, GCF will create and use a repository named 'gcf-artifacts' for every deployed region.

It must match the pattern projects/{project}/locations/{location}/repositories/{repository}. Repository format must be 'DOCKER'.

string

Service account to be used for building the container. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.

string

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

object (AutomaticUpdatePolicy)

object (OnDeployUpdatePolicy)

This type has no fields.

Security patches are applied automatically to the runtime without requiring the function to be redeployed.

Security patches are only applied when a function is redeployed.

{
  "runtimeVersion": string
}

string

Output only. contains the runtime version which was used during latest function deployment.

The location of the function source code.

{

  // Union field source can be only one of the following:
  "storageSource": {
    object (StorageSource)
  },
  "repoSource": {
    object (RepoSource)
  },
  "gitUri": string
  // End of list of possible types for union field source.
}

object (StorageSource)

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

object (RepoSource)

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

string

If provided, get the source from GitHub repository. This option is valid only for GCF 1st Gen function. Example: https://github.com/ / /blob/ /

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

{
  "bucket": string,
  "object": string,
  "generation": string,
  "sourceUploadUrl": string
}

string

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

string

Google Cloud Storage object containing the source.

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

string (int64 format)

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

string

When the specified storage bucket is a 1st gen function uploard url bucket, this field should be set as the generated upload url for 1st gen deployment.

Location of the source in a Google Cloud Source Repository.

{
  "projectId": string,
  "repoName": string,
  "dir": string,

  // Union field revision can be only one of the following:
  "branchName": string,
  "tagName": string,
  "commitSha": string
  // End of list of possible types for union field revision.
}

string

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

string

Name of the Cloud Source Repository.

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)

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

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

string

Explicit commit SHA to build.

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

{
  "resolvedStorageSource": {
    object (StorageSource)
  },
  "resolvedRepoSource": {
    object (RepoSource)
  },
  "gitUri": string
}

object (StorageSource)

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

object (RepoSource)

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

string

A copy of the build's source.git_uri, if exists, with any commits resolved.

Docker Registry to use for storing function Docker images.

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

{
  "service": string,
  "timeoutSeconds": integer,
  "availableMemory": string,
  "availableCpu": string,
  "environmentVariables": {
    string: string,
    ...
  },
  "maxInstanceCount": integer,
  "minInstanceCount": integer,
  "vpcConnector": string,
  "vpcConnectorEgressSettings": enum (VpcConnectorEgressSettings),
  "ingressSettings": enum (IngressSettings),
  "uri": string,
  "serviceAccountEmail": string,
  "allTrafficOnLatestRevision": boolean,
  "secretEnvironmentVariables": [
    {
      object (SecretEnvVar)
    }
  ],
  "secretVolumes": [
    {
      object (SecretVolume)
    }
  ],
  "revision": string,
  "maxInstanceRequestConcurrency": integer,
  "securityLevel": enum (SecurityLevel),
  "binaryAuthorizationPolicy": string
}

string

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

integer

The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

string

The amount of memory available for a function. Defaults to 256M. Supported units are k, M, G, Mi, Gi. If no unit is supplied the value is interpreted as bytes. See https://github.com/kubernetes/kubernetes/blob/master/staging/src/k8s.io/apimachinery/pkg/api/resource/quantity.go a full description.

string

The number of CPUs used in a single container instance. Default value is calculated from available memory. Supports the same values as Cloud Run, see https://cloud.google.com/run/docs/reference/rest/v1/Container#resourcerequirements Example: "1" indicates 1 vCPU

map (key: string, value: string)

Environment variables that shall be available during function execution.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

integer

The limit on the maximum number of function instances that may coexist at a given time.

In some cases, such as rapid traffic surges, Cloud Functions may, for a short period of time, create more instances than the specified max instances limit. If your function cannot tolerate this temporary behavior, you may want to factor in a safety margin and set a lower max instances value than your function can tolerate.

See the Max Instances Guide for more details.

integer

The limit on the minimum number of function instances that may coexist at a given time.

Function instances are kept in idle state for a short period after they finished executing the request to reduce cold start time for subsequent requests. Setting a minimum instance count will ensure that the given number of instances are kept running in idle state always. This can help with cold start times when jump in incoming request count occurs after the idle instance would have been stopped in the default case.

string

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

enum (VpcConnectorEgressSettings)

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

enum (IngressSettings)

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

string

Output only. URI of the Service deployed.

string

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

boolean

Whether 100% of traffic is routed to the latest revision. On functions.create and functions.patch, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On functions.get, true will be returned if the latest revision is serving 100% of traffic.

object (SecretEnvVar)

Secret environment variables configuration.

object (SecretVolume)

Secret volumes configuration.

string

Output only. The name of service revision.

integer

Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.

enum (SecurityLevel)

Security level configure whether the function only accepts https. This configuration is only applicable to 1st Gen functions with Http trigger. By default https is optional for 1st Gen functions; 2nd Gen functions are https ONLY.

string

Optional. The binary authorization policy to be checked when deploying the Cloud Run service.

Available egress settings.

This controls what traffic is diverted through the VPC Access Connector resource. By default PRIVATE_RANGES_ONLY will be used.

Available ingress settings.

This controls what traffic can reach the function.

If unspecified, ALLOW_ALL will be used.

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.

{
  "key": string,
  "projectId": string,
  "secret": string,
  "version": string
}

string

Name of the environment variable.

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.

string

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

string

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new instances start.

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.

{
  "mountPath": string,
  "projectId": string,
  "secret": string,
  "versions": [
    {
      object (SecretVersion)
    }
  ]
}

string

The path within the container to mount the secret volume. For example, setting the mountPath as /etc/secrets would mount the secret value files under the /etc/secrets directory. This directory will also be completely shadowed and unavailable to mount any other secrets. Recommended mount path: /etc/secrets

string

Project identifier (preferably project number but can also be the project ID) of the project that contains the secret. If not set, it is assumed that the secret is in the same project as the function.

string

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

object (SecretVersion)

List of secret versions to mount for this secret. If empty, the latest version of the secret will be made available in a file named after the secret under the mount point.

Configuration for a single version.

{
  "version": string,
  "path": string
}

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.

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 mountPath as '/etc/secrets' and path as secret_foo would mount the secret value file at /etc/secrets/secret_foo.

Available security level settings.

This enforces security protocol on function URL.

Security level is only configurable for 1st Gen functions, If unspecified, SECURE_OPTIONAL will be used. 2nd Gen functions are SECURE_ALWAYS ONLY.

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

{
  "trigger": string,
  "triggerRegion": string,
  "eventType": string,
  "eventFilters": [
    {
      object (EventFilter)
    }
  ],
  "pubsubTopic": string,
  "serviceAccountEmail": string,
  "retryPolicy": enum (RetryPolicy),
  "channel": string,
  "service": string
}

string

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

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.

string

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

object (EventFilter)

Criteria used to filter events.

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.

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.

enum (RetryPolicy)

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

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.

string

Optional. The hostname of the service that 1st Gen function should be observed.

If no string is provided, the default service implementing the API will be used. For example, storage.googleapis.com is the default for all event types in the google.storage namespace.

The field is only applicable to 1st Gen functions.

Filters events based on exact matches on the CloudEvents attributes.

{
  "attribute": string,
  "value": string,
  "operator": string
}

string

Required. The name of a CloudEvents attribute.

string

Required. The value for the attribute.

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.

Describes the retry policy in case of function's execution failure. Retried execution is charged as any other execution.

Describes the current state of the function.

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

{
  "severity": enum (Severity),
  "type": string,
  "message": string
}

enum (Severity)

Severity of the state message.

string

One-word CamelCase type of the state message.

string

The message.

Severity of the state message.

The environment the function is hosted on.

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4