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

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

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

• Resource: CloudFunction
  • JSON representation
• SourceRepository
  • JSON representation
• HttpsTrigger
  • JSON representation
• SecurityLevel
• EventTrigger
  • JSON representation
• FailurePolicy
  • JSON representation
• Retry
• CloudFunctionStatus
• VpcConnectorEgressSettings
• IngressSettings
• SecretEnvVar
  • JSON representation
• SecretVolume
  • JSON representation
• SecretVersion
  • JSON representation
• DockerRegistry
• AutomaticUpdatePolicy
• OnDeployUpdatePolicy
  • JSON representation
• Methods

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

{
  "name": string,
  "description": string,
  "status": enum (CloudFunctionStatus),
  "entryPoint": string,
  "runtime": string,
  "timeout": string,
  "availableMemoryMb": integer,
  "serviceAccountEmail": string,
  "updateTime": string,
  "versionId": string,
  "labels": {
    string: string,
    ...
  },
  "environmentVariables": {
    string: string,
    ...
  },
  "buildEnvironmentVariables": {
    string: string,
    ...
  },
  "network": string,
  "maxInstances": integer,
  "minInstances": integer,
  "vpcConnector": string,
  "vpcConnectorEgressSettings": enum (VpcConnectorEgressSettings),
  "ingressSettings": enum (IngressSettings),
  "kmsKeyName": string,
  "buildWorkerPool": string,
  "buildId": string,
  "buildName": string,
  "secretEnvironmentVariables": [
    {
      object (SecretEnvVar)
    }
  ],
  "secretVolumes": [
    {
      object (SecretVolume)
    }
  ],
  "sourceToken": string,
  "dockerRepository": string,
  "dockerRegistry": enum (DockerRegistry),
  "buildServiceAccount": string,

  // Union field source_code can be only one of the following:
  "sourceArchiveUrl": string,
  "sourceRepository": {
    object (SourceRepository)
  },
  "sourceUploadUrl": string
  // End of list of possible types for union field source_code.

  // Union field trigger can be only one of the following:
  "httpsTrigger": {
    object (HttpsTrigger)
  },
  "eventTrigger": {
    object (EventTrigger)
  }
  // End of list of possible types for union field trigger.

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

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.

enum (CloudFunctionStatus)

Output only. Status of the function deployment.

string

The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix (ID of the function), if not specified.

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

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

A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

integer

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

string

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

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

string (int64 format)

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

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

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

map (key: string, value: string)

Build environment variables that shall be available during build time.

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

string

This item is deprecated!

Deprecated: use vpcConnector

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

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

string

The VPC Network Connector that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network connector resource. The format of this field is projects/*/locations/*/connectors/*

This field is mutually exclusive with network field and will eventually replace it.

See the VPC documentation for more information on connecting Cloud projects.

enum (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

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

If specified, you must also provide an artifact registry repository using the dockerRepository field that was created with the same KMS crypto key.

The following service accounts need to be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).

1. Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) - Required to protect the function's image.
2. Google Storage service account (service-{project_number}@gs-project-accounts.iam.gserviceaccount.com) - Required to protect the function's source code. If this service account does not exist, deploying a function without a KMS key or retrieving the service agent name provisions it. For more information, see https://cloud.google.com/storage/docs/projects#service-agents and https://cloud.google.com/storage/docs/getting-service-agent#gsutil.

Google Cloud Functions delegates access to service agents to protect function resources in internal projects that are not accessible by the end user.

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

string

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

string

Output only. The Cloud Build Name of the function deployment. projects/<project-number>/locations/<region>/builds/<build-id>.

object (SecretEnvVar)

Secret environment variables configuration.

object (SecretVolume)

Secret volumes configuration.

string

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

string

User-managed repository created in Artifact Registry to which the function's Docker image will be pushed after it is built by Cloud Build. May optionally be encrypted with a customer-managed encryption key (CMEK). If unspecified and dockerRegistry is not explicitly set to CONTAINER_REGISTRY, GCF will create and use a default Artifact Registry repository named 'gcf-artifacts' in the 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'.

enum (DockerRegistry)

This item is deprecated!

Docker Registry to use for this deployment. 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

A service account the user provides for use with Cloud Build. The format of this field is projects/{projectId}/serviceAccounts/{serviceAccountEmail}.

string

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

object (SourceRepository)

Beta Feature

The source repository where a function is hosted.

string

The Google Cloud Storage signed URL used for source uploading, generated by calling [google.cloud.functions.v1.GenerateUploadUrl].

The signature is validated on write methods (Create, Update) The signature is stripped from the Function object on read methods (Get, List)

object (HttpsTrigger)

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

object (EventTrigger)

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

object (AutomaticUpdatePolicy)

object (OnDeployUpdatePolicy)

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

{
  "url": string,
  "deployedUrl": string
}

string

The URL pointing to the hosted repository where the function is defined. There are supported Cloud Source Repository URLs in the following formats:

To refer to a specific commit: https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/* To refer to a moveable alias (branch): https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/* In particular, to refer to HEAD use master moveable alias. To refer to a specific fixed alias (tag): https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*

You may omit paths/* if you want to use the main directory. The function response may add an empty /paths/ to the URL.

string

Output only. The URL pointing to the hosted repository where the function were defined at the time of deployment. It always points to a specific commit in the format described above.

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

{
  "url": string,
  "securityLevel": enum (SecurityLevel)
}

string

Output only. The deployed url for the function.

enum (SecurityLevel)

The security level for the function.

Available security level settings.

This controls the methods to enforce security (HTTPS) on a URL.

If unspecified, SECURE_OPTIONAL will be used.

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

{
  "eventType": string,
  "resource": string,
  "service": string,
  "failurePolicy": {
    object (FailurePolicy)
  }
}

string

Required. The type of event to observe. For example: providers/cloud.storage/eventTypes/object.change and providers/cloud.pubsub/eventTypes/topic.publish.

Event types match pattern providers/*/eventTypes/*.*. The pattern contains:

1. namespace: For example, cloud.storage and google.firebase.analytics.
2. resource type: The type of resource on which event occurs. For example, the Google Cloud Storage API includes the type object.
3. action: The action that generates the event. For example, action for a Google Cloud Storage Object is 'change'. These parts are lower case.

string

Required. The resource(s) from which to observe events, for example, projects/_/buckets/myBucket.

Not all syntactically correct values are accepted by all services. For example:

1. The authorization model must support it. Google Cloud Functions only allows EventTriggers to be deployed that observe resources in the same project as the CloudFunction.
2. The resource type must match the pattern expected for an eventType. For example, an EventTrigger that has an eventType of "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics.

Additionally, some services may support short names when creating an EventTrigger. These will always be returned in the normalized "long" format.

See each service's documentation for supported formats.

string

The hostname of the service that should be observed.

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

object (FailurePolicy)

Specifies policy for failed executions.

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

{

  // Union field action can be only one of the following:
  "retry": {
    object (Retry)
  }
  // End of list of possible types for union field action.
}

object (Retry)

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

This type has no fields.

Describes the retry policy in case of function's execution failure. A function execution will be retried on any failure. A failed execution will be retried up to 7 days with an exponential backoff (capped at 10 seconds). Retried execution is charged as any other execution.

Describes the current stage of a deployment.

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 (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.

string

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

string

Version of the secret (version number or the string 'latest'). It is recommended to use a numeric version for secret environment variables as any updates to the secret value is not reflected until new 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. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.

{
  "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 paths: /etc/secrets Restricted mount paths: /cloudsql, /dev/log, /pod, /proc, /var/log

string

Project identifier (preferrably project number but can also be the project ID) of the project that contains the secret. If not set, it will be populated with the function's project assuming that the secret exists in the same project as of the function.

string

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

object (SecretVersion)

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

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.

Docker Registry to use for storing function Docker images.

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.

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