Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Usage

import * as mod from "https://googleapis.deno.dev/v1/cloudfunctions:v2.ts";

§Classes

CloudFunctions

Manages lightweight user-provided functions executed in response to events.

GoogleAuth

§Variables

auth

§Interfaces

AbortFunctionUpgradeRequest

Request for the AbortFunctionUpgrade method.

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.

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.

AutomaticUpdatePolicy

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

Binding

Associates members, or principals, with a role.

BuildConfig

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

CommitFunctionUpgradeRequest

Request for the CommitFunctionUpgrade method.

CredentialsClient

Defines the root interface for all clients that generate credentials for calling Google APIs. All clients should implement this interface.

Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type.TimeOfDay * google.type.DateTime * google.protobuf.Timestamp

EventFilter

Filters events based on exact matches on the CloudEvents attributes.

EventTrigger

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

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.

Function

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

GenerateDownloadUrlRequest

Request of GenerateDownloadUrl method.

GenerateDownloadUrlResponse

Response of GenerateDownloadUrl method.

GenerateUploadUrlRequest

Request of GenerateSourceUploadUrl method.

GenerateUploadUrlResponse

Response of GenerateSourceUploadUrl method.

GoogleCloudFunctionsV2alphaLocationMetadata

Extra GCF specific location information.

GoogleCloudFunctionsV2alphaOperationMetadata

Represents the metadata of the long-running operation.

GoogleCloudFunctionsV2alphaStage

Each Stage of the deployment process

GoogleCloudFunctionsV2alphaStateMessage

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

GoogleCloudFunctionsV2betaLocationMetadata

Extra GCF specific location information.

GoogleCloudFunctionsV2betaOperationMetadata

Represents the metadata of the long-running operation.

GoogleCloudFunctionsV2betaStage

Each Stage of the deployment process

GoogleCloudFunctionsV2betaStateMessage

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

GoogleCloudFunctionsV2LocationMetadata

Extra GCF specific location information.

GoogleCloudFunctionsV2OperationMetadata

Represents the metadata of the long-running operation.

GoogleCloudFunctionsV2Stage

Each Stage of the deployment process

GoogleCloudFunctionsV2StateMessage

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

ListFunctionsResponse

Response for the ListFunctions method.

ListLocationsResponse

The response message for Locations.ListLocations.

ListOperationsResponse

The response message for Operations.ListOperations.

ListRuntimesResponse

Response for the ListRuntimes method.

Location

A resource that represents a Google Cloud location.

OnDeployUpdatePolicy

Security patches are only applied when a function is redeployed.

Operation

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

OperationMetadataV1

Metadata describing an Operation

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:

ProjectsLocationsFunctionsCreateOptions

Additional options for CloudFunctions#projectsLocationsFunctionsCreate.

ProjectsLocationsFunctionsGetIamPolicyOptions

Additional options for CloudFunctions#projectsLocationsFunctionsGetIamPolicy.

ProjectsLocationsFunctionsGetOptions

Additional options for CloudFunctions#projectsLocationsFunctionsGet.

ProjectsLocationsFunctionsListOptions

Additional options for CloudFunctions#projectsLocationsFunctionsList.

ProjectsLocationsFunctionsPatchOptions

Additional options for CloudFunctions#projectsLocationsFunctionsPatch.

ProjectsLocationsListOptions

Additional options for CloudFunctions#projectsLocationsList.

ProjectsLocationsOperationsListOptions

Additional options for CloudFunctions#projectsLocationsOperationsList.

ProjectsLocationsRuntimesListOptions

Additional options for CloudFunctions#projectsLocationsRuntimesList.

RedirectFunctionUpgradeTrafficRequest

Request for the RedirectFunctionUpgradeTraffic method.

RepoSource

Location of the source in a Google Cloud Source Repository.

RollbackFunctionUpgradeTrafficRequest

Request for the RollbackFunctionUpgradeTraffic method.

Runtime

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

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.

SecretVersion

Configuration for a single version.

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.

ServiceConfig

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

SetIamPolicyRequest

Request message for SetIamPolicy method.

SetupFunctionUpgradeConfigRequest

Request for the SetupFunctionUpgradeConfig method.

Source

The location of the function source code.

SourceProvenance

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

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.

StorageSource

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

TestIamPermissionsRequest

Request message for TestIamPermissions method.

TestIamPermissionsResponse

Response message for TestIamPermissions method.

UpgradeInfo

Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration * Current state of migration for function undergoing migration.