Module googleapis.cloudfunctions
ballerinax/googleapis.cloudfunctions Ballerina library
1.5.2
Overview
The Google Cloud Functions REST API v1 connector(https://cloud.google.com/functions/docs/reference/rest) OpenAPI specification. The Google Cloud Functions API provides the capability to manage lightweight user-provided functions executed in response to events.
Key Features
- Programmatic access to create and manage resources via REST API
- Manage user accounts and profiles
- Support for webhooks and event-driven workflows
- Secure authentication with API key or OAuth support
Prerequisites
Before using this connector in your Ballerina application, complete the following:
- Create a Google account
- Obtain tokens - Follow this guide
Clients
googleapis.cloudfunctions: Client
Isolated
This is a generated connector for Google Cloud Functions REST API v1 OpenAPI specification. The Google Cloud Functions API provides the capability to manage lightweight user-provided functions executed in response to events.
Constructor
Gets invoked to initialize the connector.
The connector initialization requires setting the API credentials.
Create a Google account and obtain tokens by following this guide.
init (ConnectionConfig config, string serviceUrl)- config ConnectionConfig - The configurations to be used when initializing the
connector
- serviceUrl string "https://cloudfunctions.googleapis.com/" - URL of the target service
listOperations
Isolated FunctionRemote Function
function listOperations(string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, string? name, int? pageSize, string? pageToken) returns ListOperationsResponse|errorLists operations that match the specified filter in the request. If the server doesn't support this method, it returns UNIMPLEMENTED. NOTE: the name binding allows API services to override the binding to use different resource name schemes, such as users/*/operations. To override the binding, API services can add a binding such as "/v1/{name=users/*}/operations" to their service configuration. For backwards compatibility, the default name includes the operations collection id, however overriding users must ensure the name binding is the parent resource, without the operations collection id.
Parameters
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- filter string? (default ()) - Required. A filter for matching the requested operations. The supported formats of filter are: To query for a specific function: project:,location:,function:* To query for all of the latest operations for a project: project:*,latest:true
- name string? (default ()) - Must not be set.
- pageSize int? (default ()) - The maximum number of records that should be returned. Requested page size cannot exceed 100. If not set, the default page size is 100. Pagination is only supported when querying for a specific function.
- pageToken string? (default ()) - Token identifying which result to start with, which is returned by a previous list call. Pagination is only supported when querying for a specific function.
Return Type
- ListOperationsResponse|error - Successful response
createFunction
Isolated FunctionRemote Function
function createFunction(string location, CloudFunction payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Operation|errorCreates a new function. If a function with the given name already exists in the specified project, the long running operation will return ALREADY_EXISTS error.
Parameters
- location string - Required. The project and location in which the function should be created, specified in the format
projects/*/locations/*
- payload CloudFunction - Cloud function to be created
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
getFunction
Isolated FunctionRemote Function
function getFunction(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CloudFunction|errorReturns a function with the given name from the requested project.
Parameters
- name string - Required. The name of the function which details should be obtained.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- CloudFunction|error - Successful response
deleteFunction
Isolated FunctionRemote Function
function deleteFunction(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Operation|errorDeletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.
Parameters
- name string - Required. The name of the function which should be deleted.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
updateFunction
Isolated FunctionRemote Function
function updateFunction(string name, CloudFunction payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? updateMask) returns Operation|errorUpdates existing function.
Parameters
- name string - A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
- payload CloudFunction - Cloud function to be updated
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- updateMask string? (default ()) - Required list of fields to be updated in this request.
listLocations
Isolated FunctionRemote Function
function listLocations(string name, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, string? filter, int? pageSize, string? pageToken) returns ListLocationsResponse|errorLists information about the supported locations for this service.
Parameters
- name string - The resource that owns the locations collection, if applicable.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - The maximum number of results to return. If not set, the service selects a default.
- pageToken string? (default ()) - A page token received from the
next_page_tokenfield in the response. Send that page token to receive the subsequent page.
Return Type
- ListLocationsResponse|error - Successful response
callFunction
Isolated FunctionRemote Function
function callFunction(string name, CallFunctionRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns CallFunctionResponse|errorSynchronously invokes a deployed Cloud Function. To be used for testing purposes as very limited traffic is allowed. For more information on the actual limits, refer to Rate Limits.
Parameters
- name string - Required. The name of the function to be called.
- payload CallFunctionRequest - Cloud function to be called
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- CallFunctionResponse|error - Successful response
generateFunctionDownloadUrl
Isolated FunctionRemote Function
function generateFunctionDownloadUrl(string name, GenerateDownloadUrlRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns GenerateDownloadUrlResponse|errorReturns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within minutes after generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls
Parameters
- name string - The name of function for which source code Google Cloud Storage signed URL should be generated.
- payload GenerateDownloadUrlRequest - Download URL request payload
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- GenerateDownloadUrlResponse|error - Successful response
listFunctions
Isolated FunctionRemote Function
function listFunctions(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? pageSize, string? pageToken) returns ListFunctionsResponse|errorReturns a list of functions that belong to the requested project.
Parameters
- parent string - The project and location from which the function should be listed, specified in the format
projects/*/locations/*If you want to list functions in all locations, use "-" in place of a location. When listing functions in all locations, if one or more location(s) are unreachable, the response will contain functions from all reachable locations along with the names of any unreachable locations.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- pageSize int? (default ()) - Maximum number of functions to return per call.
- pageToken string? (default ()) - The value returned by the last
ListFunctionsResponse; indicates that this is a continuation of a priorListFunctionscall, and that the system should return the next page of data.
Return Type
- ListFunctionsResponse|error - Successful response
generateFunctionUploadUrl
Isolated FunctionRemote Function
function generateFunctionUploadUrl(string parent, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns GenerateUploadUrlResponse|errorReturns a signed URL for uploading a function source code. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls. Once the function source code upload is complete, the used signed URL should be provided in CreateFunction or UpdateFunction request as a reference to the function source code. When uploading source code to the generated signed URL, please follow these restrictions: * Source file type should be a zip file. * Source file size should not exceed 100MB limit. * No credentials should be attached - the signed URLs provide access to the target bucket using internal service identity; if credentials were attached, the identity from the credentials would be used, but that identity does not have permissions to upload files to the URL. When making a HTTP PUT request, these two headers need to be specified: * content-type: application/zip * x-goog-content-length-range: 0,104857600 And this header SHOULD NOT be specified: * Authorization: Bearer YOUR_TOKEN
Parameters
- parent string - The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format
projects/*/locations/*.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- GenerateUploadUrlResponse|error - Successful response
getFunctionIAMPolicy
Isolated FunctionRemote Function
function getFunctionIAMPolicy(string 'resource, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType, int? optionsRequestedpolicyversion) returns Policy|errorGets the IAM access control policy for a function. Returns an empty policy if the function exists and does not have a policy set.
Parameters
- 'resource string - REQUIRED: The resource for which the policy is being requested. See the operation documentation for the appropriate value for this field.
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
- optionsRequestedpolicyversion int? (default ()) - Optional. The policy format version to be returned. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional bindings must specify version 3. Policies without any conditional bindings may specify any valid value or leave the field unset. To learn which resources support conditions in their IAM policies, see the IAM documentation.
setFunctionIAMPolicy
Isolated FunctionRemote Function
function setFunctionIAMPolicy(string 'resource, SetIamPolicyRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns Policy|errorSets the IAM access control policy on the specified function. Replaces any existing policy.
Parameters
- 'resource string - REQUIRED: The resource for which the policy is being specified. See the operation documentation for the appropriate value for this field.
- payload SetIamPolicyRequest - IAM policy to be set
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
testIAMPermissions
Isolated FunctionRemote Function
function testIAMPermissions(string 'resource, TestIamPermissionsRequest payload, string? xgafv, string? alt, string? callback, string? fields, string? quotaUser, string? uploadProtocol, string? uploadType) returns TestIamPermissionsResponse|errorTests the specified permissions against the IAM access control policy for a function. If the function does not exist, this will return an empty set of permissions, not a NOT_FOUND error.
Parameters
- 'resource string - REQUIRED: The resource for which the policy detail is being requested. See the operation documentation for the appropriate value for this field.
- payload TestIamPermissionsRequest - Permission to be tested
- xgafv string? (default ()) - V1 error format.
- alt string? (default ()) - Data format for response.
- callback string? (default ()) - JSONP
- fields string? (default ()) - Selector specifying which fields to include in a partial response.
- quotaUser string? (default ()) - Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
- uploadProtocol string? (default ()) - Upload protocol for media (e.g. "raw", "multipart").
- uploadType string? (default ()) - Legacy upload protocol for media (e.g. "media", "multipart").
Return Type
- TestIamPermissionsResponse|error - Successful response
Records
googleapis.cloudfunctions: 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? 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.allServicesis a special value that covers all services.
googleapis.cloudfunctions: 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? string - The log type that this config enables.
googleapis.cloudfunctions: Binding
Associates members with a role.
Fields
- condition? 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.
- members? string[] - Specifies the identities requesting access for a Cloud Platform resource.
memberscan 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. *user:{emailid}: An email address that represents a specific Google account. For example,alice@example.com. *serviceAccount:{emailid}: An email address that represents a service account. For example,my-other-app@appspot.gserviceaccount.com. *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 touser:{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 toserviceAccount:{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 togroup:{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.comorexample.com.
- role? string - Role that is assigned to
members. For example,roles/viewer,roles/editor, orroles/owner.
googleapis.cloudfunctions: CallFunctionRequest
Request for the CallFunction method.
Fields
- data? string - Required. Input to be passed to the function.
googleapis.cloudfunctions: CallFunctionResponse
Response of CallFunction method.
Fields
- 'error? string - Either system or user-function generated error. Set if execution was not successful.
- executionId? string - Execution id of function invocation.
- result? string - Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context.
googleapis.cloudfunctions: ClientHttp1Settings
Closed record
Provides settings related to HTTP/1.x protocol.
Fields
- keepAlive KeepAlive(default http:KEEPALIVE_AUTO) - Specifies whether to reuse a connection for multiple requests
- chunking Chunking(default http:CHUNKING_AUTO) - The chunking behaviour of the request
- proxy? ProxyConfig - Proxy server related options
googleapis.cloudfunctions: CloudFunction
Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations. Next tag: 35
Fields
- availableMemoryMb? int - The amount of memory in MB available for a function. Defaults to 256MB.
- buildEnvironmentVariables? record {} - Build environment variables that shall be available during build time.
- buildId? string - Output only. The Cloud Build ID of the latest successful deployment of the function.
- buildWorkerPool? 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.
- description? string - User-provided description of a function.
- 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? record {} - Environment variables that shall be available during function execution.
- eventTrigger? EventTrigger - Describes EventTrigger, used to request events be sent from another service.
- httpsTrigger? HttpsTrigger - Describes HttpsTrigger, could be used to connect web hooks to function.
- ingressSettings? string - The ingress settings for the function, controlling what traffic can reach it.
- labels? record {} - Labels associated with this Cloud Function.
- maxInstances? int - 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.
- name? string - A user-defined name of the function. Function names must be unique globally and match pattern
projects/*/locations/*/functions/*
- network? string - The VPC Network that this cloud function can connect to. It can be either the fully-qualified URI, or the short name of the network resource. If the short network name is used, the network must belong to the same project. Otherwise, it must belong to a project within the same organization. The format of this field is either
projects/{project}/global/networks/{network}or{network}, where {project} is a project id where the network is defined, and {network} is the short name of the network. This field is mutually exclusive withvpc_connectorand will be replaced by it. See the VPC documentation for more information on connecting Cloud projects.
- 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
gcloudcommand reference.
- secretEnvironmentVariables? SecretEnvVar[] - Secret environment variables configuration.
- secretVolumes? SecretVolume[] - Secret volumes configuration.
- serviceAccountEmail? string - The email of the function's service account. If empty, defaults to
{project_id}@appspot.gserviceaccount.com.
- sourceArchiveUrl? string - The Google Cloud Storage URL, starting with gs://, pointing to the zip archive which contains the function.
- sourceRepository? SourceRepository - Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.
- sourceToken? string - Input only. An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.
- sourceUploadUrl? string - The Google Cloud Storage signed URL used for source uploading, generated by google.cloud.functions.v1.GenerateUploadUrl
- status? string - Output only. Status of the function deployment.
- timeout? string - 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.
- updateTime? string - Output only. The last update timestamp of a Cloud Function.
- versionId? string - Output only. The version identifier of the Cloud Function. Each deployment attempt results in a new version of a function being created.
- vpcConnector? 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 withnetworkfield and will eventually replace it. See the VPC documentation for more information on connecting Cloud projects.
- vpcConnectorEgressSettings? string - The egress settings for the connector, controlling what traffic is diverted through it.
googleapis.cloudfunctions: ConnectionConfig
Closed record
Provides a set of configurations for controlling the behaviours when communicating with a remote HTTP endpoint.
Fields
- auth BearerTokenConfig|OAuth2RefreshTokenGrantConfig - Configurations related to client authentication
- httpVersion HttpVersion(default http:HTTP_2_0) - The HTTP version understood by the client
- http1Settings? ClientHttp1Settings - Configurations related to HTTP/1.x protocol
- http2Settings? ClientHttp2Settings - Configurations related to HTTP/2 protocol
- timeout decimal(default 60) - The maximum time to wait (in seconds) for a response before closing the connection
- forwarded string(default "disable") - The choice of setting
forwarded/x-forwardedheader
- poolConfig? PoolConfiguration - Configurations associated with request pooling
- cache? CacheConfig - HTTP caching related configurations
- compression Compression(default http:COMPRESSION_AUTO) - Specifies the way of handling compression (
accept-encoding) header
- circuitBreaker? CircuitBreakerConfig - Configurations associated with the behaviour of the Circuit Breaker
- retryConfig? RetryConfig - Configurations associated with retrying
- responseLimits? ResponseLimitConfigs - Configurations associated with inbound response size limits
- secureSocket? ClientSecureSocket - SSL/TLS-related options
- proxy? ProxyConfig - Proxy server related options
- validation boolean(default true) - Enables the inbound payload validation functionality which provided by the constraint package. Enabled by default
googleapis.cloudfunctions: EventTrigger
Describes EventTrigger, used to request events be sent from another service.
Fields
- eventType? string - Required. The type of event to observe. For example:
providers/cloud.storage/eventTypes/object.changeandproviders/cloud.pubsub/eventTypes/topic.publish. Event types match patternproviders/*/eventTypes/*.*. The pattern contains: 1. namespace: For example,cloud.storageandgoogle.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.
- failurePolicy? FailurePolicy - Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).
- 'resource? 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 theCloudFunction. 2. The resource type must match the pattern expected for anevent_type. For example, anEventTriggerthat has anevent_typeof "google.pubsub.topic.publish" should have a resource that matches Google Cloud Pub/Sub topics. Additionally, some services may support short names when creating anEventTrigger. These will always be returned in the normalized "long" format. See each service's documentation for supported formats.
- 'service? 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.comis the default for all event types in thegoogle.storagenamespace.
googleapis.cloudfunctions: 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.
googleapis.cloudfunctions: FailurePolicy
Describes the policy in case of function's execution failure. If empty, then defaults to ignoring failures (i.e. not retrying them).
Fields
- 'retry? Retry - 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.
googleapis.cloudfunctions: GenerateDownloadUrlRequest
Request of GenerateDownloadUrl method.
Fields
- versionId? string - The optional version of function. If not set, default, current version is used.
googleapis.cloudfunctions: GenerateDownloadUrlResponse
Response of GenerateDownloadUrl method.
Fields
- downloadUrl? string - The generated Google Cloud Storage signed URL that should be used for function source code download.
googleapis.cloudfunctions: GenerateUploadUrlResponse
Response of GenerateSourceUploadUrl method.
Fields
- 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.
googleapis.cloudfunctions: HttpsTrigger
Describes HttpsTrigger, could be used to connect web hooks to function.
Fields
- securityLevel? string - The security level for the function.
- url? string - Output only. The deployed url for the function.
googleapis.cloudfunctions: ListFunctionsResponse
Response for the ListFunctions method.
Fields
- functions? CloudFunction[] - The functions that match the request.
- nextPageToken? string - If not empty, indicates that there may be more functions that match the request; this value should be passed in a new google.cloud.functions.v1.ListFunctionsRequest to get more functions.
- unreachable? string[] - Locations that could not be reached. The response does not include any functions from these locations.
googleapis.cloudfunctions: ListLocationsResponse
The response message for Locations.ListLocations.
Fields
- locations? Location[] - A list of locations that matches the specified filter in the request.
- nextPageToken? string - The standard List next-page token.
googleapis.cloudfunctions: ListOperationsResponse
The response message for Operations.ListOperations.
Fields
- nextPageToken? string - The standard List next-page token.
- operations? Operation[] - A list of operations that matches the specified filter in the request.
googleapis.cloudfunctions: 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? record {} - 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? record {} - 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"
googleapis.cloudfunctions: OAuth2RefreshTokenGrantConfig
Closed record
OAuth2 Refresh Token Grant Configs
Fields
- Fields Included from *OAuth2RefreshTokenGrantConfig
- refreshUrl string(default "https://accounts.google.com/o/oauth2/token") - Refresh URL
googleapis.cloudfunctions: 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. Iftrue, the operation is completed, and eithererrororresponseis available.
- 'error? Status - The
Statustype defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. EachStatusmessage 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.
- metadata? record {} - 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
nameshould be a resource name ending withoperations/{unique_id}.
- response? record {} - The normal response of the operation in case of success. If the original method returns no data on success, such as
Delete, the response isgoogle.protobuf.Empty. If the original method is standardGet/Create/Update, the response should be the resource. For other methods, the response should have the type XxxResponse, whereXxxis the original method name. For example, if the original method name is TakeSnapshot(), the inferred response type isTakeSnapshotResponse.
googleapis.cloudfunctions: 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? record {} - 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? string - Type of operation.
- updateTime? string - The last update timestamp of the operation.
- versionId? string - Version id of the function created or updated by an API call. This field is only populated for Create and Update operations.
googleapis.cloudfunctions: 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 to a single role. Members 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? AuditConfig[] - Specifies cloud audit logging configuration for this policy.
- bindings? Binding[] - Associates a list of
membersto arole. Optionally, may specify aconditionthat determines how and when thebindingsare applied. Each of thebindingsmust contain at least one member.
- etag? string -
etagis 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 theetagin the read-modify-write cycle to perform policy updates in order to avoid race conditions: Anetagis returned in the response togetIamPolicy, and systems are expected to put that etag in the request tosetIamPolicyto ensure that their change will be applied to the same version of the policy. Important: If you use IAM Conditions, you must include theetagfield whenever you callsetIamPolicy. If you omit this field, then IAM allows you to overwrite a version3policy with a version1policy, and all of the conditions in the version3policy are lost.
- 'version? int - Specifies the format of the policy. Valid values are
0,1, and3. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version3. 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 theetagfield whenever you callsetIamPolicy. If you omit this field, then IAM allows you to overwrite a version3policy with a version1policy, and all of the conditions in the version3policy 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.
googleapis.cloudfunctions: ProxyConfig
Closed record
Proxy server configurations to be used with the HTTP client endpoint.
Fields
- host string(default "") - Host name of the proxy server
- port int(default 0) - Proxy server port
- userName string(default "") - Proxy server username
- password string(default "") - Proxy server password
googleapis.cloudfunctions: Retry
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.
googleapis.cloudfunctions: 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. Secret value is not a part of the configuration. Secret values are only fetched when a new clone starts.
Fields
- 'key? string - Name of the environment variable.
- projectId? 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.
- 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 clones start.
googleapis.cloudfunctions: 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_foowould mount the secret value file at/etc/secrets/secret_foo.
- 'version? string - Version of the secret (version number or the string 'latest'). It is preferrable to use
latestversion with secret volumes as secret value changes are reflected immediately.
googleapis.cloudfunctions: 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. Secret value is not a part of the configuration. Every filesystem read operation performs a lookup in secret manager to retrieve the secret value.
Fields
- mountPath? string - The path within the container to mount the secret volume. For example, setting the mount_path as
/etc/secretswould mount the secret value files under the/etc/secretsdirectory. 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
- projectId? 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.
- secret? string - Name of the secret in secret manager (not the full resource name).
- versions? SecretVersion[] - List of secret versions to mount for this secret. If empty, the
latestversion of the secret will be made available in a file named after the secret under the mount point.
googleapis.cloudfunctions: SetIamPolicyRequest
Request message for SetIamPolicy method.
Fields
- policy? Policy - An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. A
Policyis a collection ofbindings. Abindingbinds one or moremembersto a singlerole. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). Aroleis a named list of permissions; eachrolecan be an IAM predefined role or a user-created custom role. For some types of Google Cloud resources, abindingcan also specify acondition, which is a logical expression that allows access to a resource only if the expression evaluates totrue. 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.
- updateMask? string - 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"
googleapis.cloudfunctions: SourceRepository
Describes SourceRepository, used to represent parameters related to source repository where a function is hosted.
Fields
- deployedUrl? 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.
- url? 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 usemastermoveable alias. To refer to a specific fixed alias (tag):https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*You may omitpaths/*if you want to use the main directory.
googleapis.cloudfunctions: 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? int - The status code, which should be an enum value of google.rpc.Code.
- details? record {}[] - 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.
googleapis.cloudfunctions: 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.
googleapis.cloudfunctions: TestIamPermissionsResponse
Response message for TestIamPermissions method.
Fields
- permissions? string[] - A subset of
TestPermissionsRequest.permissionsthat the caller is allowed.