{
"auth": {
"oauth2": {
"scopes": {
"https://www.googleapis.com/auth/cloud-platform": {
"description": "See, edit, configure, and delete your Google Cloud data and see the email address for your Google Account."
}
}
}
},
"basePath": "",
"baseUrl": "https://cloudfunctions.googleapis.com/",
"batchPath": "batch",
"canonicalName": "Cloud Functions",
"description": "Manages lightweight user-provided functions executed in response to events.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/functions",
"fullyEncodeReservedExpansion": true,
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"id": "cloudfunctions:v2alpha",
"kind": "discovery#restDescription",
"mtlsRootUrl": "https://cloudfunctions.mtls.googleapis.com/",
"name": "cloudfunctions",
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
"$.xgafv": {
"description": "V1 error format.",
"enum": [
"1",
"2"
],
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"type": "string"
},
"access_token": {
"description": "OAuth access token.",
"location": "query",
"type": "string"
},
"alt": {
"default": "json",
"description": "Data format for response.",
"enum": [
"json",
"media",
"proto"
],
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"type": "string"
},
"callback": {
"description": "JSONP",
"location": "query",
"type": "string"
},
"fields": {
"description": "Selector specifying which fields to include in a partial response.",
"location": "query",
"type": "string"
},
"key": {
"description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
"location": "query",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"location": "query",
"type": "string"
},
"prettyPrint": {
"default": "true",
"description": "Returns response with indentations and line breaks.",
"location": "query",
"type": "boolean"
},
"quotaUser": {
"description": "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.",
"location": "query",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"location": "query",
"type": "string"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"location": "query",
"type": "string"
}
},
"protocol": "rest",
"resources": {
"projects": {
"resources": {
"locations": {
"methods": {
"list": {
"description": "Lists information about the supported locations for this service. This method can be called in two ways: * **List all public locations:** Use the path `GET /v1/locations`. * **List project-visible locations:** Use the path `GET /v1/projects/{project_id}/locations`. This may include public locations as well as private or other locations specifically visible to the project.",
"flatPath": "v2alpha/projects/{projectsId}/locations",
"httpMethod": "GET",
"id": "cloudfunctions.projects.locations.list",
"parameterOrder": [
"name"
],
"parameters": {
"extraLocationTypes": {
"description": "Optional. Do not use this field. It is unsupported and is ignored unless explicitly documented otherwise. This is primarily for internal usage.",
"location": "query",
"repeated": true,
"type": "string"
},
"filter": {
"description": "A filter to narrow down results to a preferred subset. The filtering language accepts strings like `\"displayName=tokyo\"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).",
"location": "query",
"type": "string"
},
"name": {
"description": "The resource that owns the locations collection, if applicable.",
"location": "path",
"pattern": "^projects/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The maximum number of results to return. If not set, the service selects a default.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "A page token received from the `next_page_token` field in the response. Send that page token to receive the subsequent page.",
"location": "query",
"type": "string"
}
},
"path": "v2alpha/{+name}/locations",
"response": {
"$ref": "ListLocationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
},
"resources": {
"functions": {
"methods": {
"abortFunctionUpgrade": {
"description": "Aborts generation upgrade process for a function with the given name from the specified project. Deletes all 2nd Gen copy related configuration and resources which were created during the upgrade process.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:abortFunctionUpgrade",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.abortFunctionUpgrade",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function for which upgrade should be aborted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}:abortFunctionUpgrade",
"request": {
"$ref": "AbortFunctionUpgradeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"commitFunctionUpgrade": {
"description": "Finalizes the upgrade after which function upgrade can not be rolled back. This is the last step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Deletes all original 1st Gen related configuration and resources.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:commitFunctionUpgrade",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.commitFunctionUpgrade",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function for which upgrade should be finalized.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}:commitFunctionUpgrade",
"request": {
"$ref": "CommitFunctionUpgradeRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"commitFunctionUpgradeAsGen2": {
"description": "Commits a function upgrade from GCF Gen1 to GCF Gen2. This action deletes the Gen1 function, leaving the Gen2 function active and manageable by the GCFv2 API.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:commitFunctionUpgradeAsGen2",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.commitFunctionUpgradeAsGen2",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function for which upgrade should be committed to Gen2.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}:commitFunctionUpgradeAsGen2",
"request": {
"$ref": "CommitFunctionUpgradeAsGen2Request"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"create": {
"description": "Creates 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.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.create",
"parameterOrder": [
"parent"
],
"parameters": {
"functionId": {
"description": "The ID to use for the function, which will become the final component of the function's resource name. This value should be 4-63 characters, and valid characters are /a-z-/.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The project and location in which the function should be created, specified in the format `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+parent}/functions",
"request": {
"$ref": "Function"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"delete": {
"description": "Deletes 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.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
"httpMethod": "DELETE",
"id": "cloudfunctions.projects.locations.functions.delete",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function which should be deleted.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"detachFunction": {
"description": "Detaches 2nd Gen function to Cloud Run function.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:detachFunction",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.detachFunction",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function for which should be detached.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}:detachFunction",
"request": {
"$ref": "DetachFunctionRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"generateDownloadUrl": {
"description": "Returns a signed URL for downloading deployed function source code. The URL is only valid for a limited period and should be used within 30 minutes of generation. For more information about the signed URL usage see: https://cloud.google.com/storage/docs/access-control/signed-urls",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.generateDownloadUrl",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of function for which source code Google Cloud Storage signed URL should be generated.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}:generateDownloadUrl",
"request": {
"$ref": "GenerateDownloadUrlRequest"
},
"response": {
"$ref": "GenerateDownloadUrlResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"generateUploadUrl": {
"description": "Returns 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. * 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, specify this header: * `content-type: application/zip` Do not specify this header: * `Authorization: Bearer YOUR_TOKEN`",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.generateUploadUrl",
"parameterOrder": [
"parent"
],
"parameters": {
"parent": {
"description": "Required. The project and location in which the Google Cloud Storage signed URL should be generated, specified in the format `projects/*/locations/*`.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+parent}/functions:generateUploadUrl",
"request": {
"$ref": "GenerateUploadUrlRequest"
},
"response": {
"$ref": "GenerateUploadUrlResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"get": {
"description": "Returns a function with the given name from the requested project.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
"httpMethod": "GET",
"id": "cloudfunctions.projects.locations.functions.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function which details should be obtained.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
},
"revision": {
"description": "Optional. The optional version of the 1st gen function whose details should be obtained. The version of a 1st gen function is an integer that starts from 1 and gets incremented on redeployments. GCF may keep historical configs for old versions of 1st gen function. This field can be specified to fetch the historical configs. This field is valid only for GCF 1st gen function.",
"location": "query",
"type": "string"
}
},
"path": "v2alpha/{+name}",
"response": {
"$ref": "Function"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"getIamPolicy": {
"description": "Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:getIamPolicy",
"httpMethod": "GET",
"id": "cloudfunctions.projects.locations.functions.getIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"options.requestedPolicyVersion": {
"description": "Optional. The maximum policy version that will be used to format the policy. Valid values are 0, 1, and 3. Requests specifying an invalid value will be rejected. Requests for policies with any conditional role bindings must specify version 3. Policies with no conditional role bindings may specify any valid value or leave the field unset. The policy in the response might use the policy version that you specified, or it might use a lower policy version. For example, if you specify version 3, but the policy has no conditional role bindings, the response uses version 1. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"location": "query",
"type": "integer"
},
"resource": {
"description": "REQUIRED: The resource for which the policy is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+resource}:getIamPolicy",
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Returns a list of functions that belong to the requested project.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions",
"httpMethod": "GET",
"id": "cloudfunctions.projects.locations.functions.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter for Functions that match the filter expression, following the syntax outlined in https://google.aip.dev/160.",
"location": "query",
"type": "string"
},
"orderBy": {
"description": "The sorting order of the resources returned. Value should be a comma separated list of fields. The default sorting order is ascending. See https://google.aip.dev/132#ordering.",
"location": "query",
"type": "string"
},
"pageSize": {
"description": "Maximum number of functions to return per call. The largest allowed page_size is 1,000, if the page_size is omitted or specified as greater than 1,000 then it will be replaced as 1,000. The size of the list response can be less than specified when used with filters.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. 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.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+parent}/functions",
"response": {
"$ref": "ListFunctionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"patch": {
"description": "Updates existing function.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}",
"httpMethod": "PATCH",
"id": "cloudfunctions.projects.locations.functions.patch",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
},
"updateMask": {
"description": "The list of fields to be updated. If no field mask is provided, all fields will be updated.",
"format": "google-fieldmask",
"location": "query",
"type": "string"
}
},
"path": "v2alpha/{+name}",
"request": {
"$ref": "Function"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"redirectFunctionUpgradeTraffic": {
"description": "Changes the traffic target of a function from the original 1st Gen function to the 2nd Gen copy. This is the second step of the multi step process to upgrade 1st Gen functions to 2nd Gen. After this operation, all new traffic will be served by 2nd Gen copy.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:redirectFunctionUpgradeTraffic",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.redirectFunctionUpgradeTraffic",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function for which traffic target should be changed to 2nd Gen from 1st Gen.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}:redirectFunctionUpgradeTraffic",
"request": {
"$ref": "RedirectFunctionUpgradeTrafficRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"rollbackFunctionUpgradeTraffic": {
"description": "Reverts the traffic target of a function from the 2nd Gen copy to the original 1st Gen function. After this operation, all new traffic would be served by the 1st Gen.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:rollbackFunctionUpgradeTraffic",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.rollbackFunctionUpgradeTraffic",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function for which traffic target should be changed back to 1st Gen from 2nd Gen.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}:rollbackFunctionUpgradeTraffic",
"request": {
"$ref": "RollbackFunctionUpgradeTrafficRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setIamPolicy": {
"description": "Sets the access control policy on the specified resource. Replaces any existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED` errors.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setIamPolicy",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.setIamPolicy",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy is being specified. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+resource}:setIamPolicy",
"request": {
"$ref": "SetIamPolicyRequest"
},
"response": {
"$ref": "Policy"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"setupFunctionUpgradeConfig": {
"description": "Creates a 2nd Gen copy of the function configuration based on the 1st Gen function with the given name. This is the first step of the multi step process to upgrade 1st Gen functions to 2nd Gen. Only 2nd Gen configuration is setup as part of this request and traffic continues to be served by 1st Gen.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:setupFunctionUpgradeConfig",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.setupFunctionUpgradeConfig",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "Required. The name of the function which should have configuration copied for upgrade.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}:setupFunctionUpgradeConfig",
"request": {
"$ref": "SetupFunctionUpgradeConfigRequest"
},
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"testIamPermissions": {
"description": "Returns permissions that a caller has on the specified resource. If the resource does not exist, this will return an empty set of permissions, not a `NOT_FOUND` error. Note: This operation is designed to be used for building permission-aware UIs and command-line tools, not for authorization checking. This operation may \"fail open\" without warning.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:testIamPermissions",
"httpMethod": "POST",
"id": "cloudfunctions.projects.locations.functions.testIamPermissions",
"parameterOrder": [
"resource"
],
"parameters": {
"resource": {
"description": "REQUIRED: The resource for which the policy detail is being requested. See [Resource names](https://cloud.google.com/apis/design/resource_names) for the appropriate value for this field.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+resource}:testIamPermissions",
"request": {
"$ref": "TestIamPermissionsRequest"
},
"response": {
"$ref": "TestIamPermissionsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"operations": {
"methods": {
"get": {
"description": "Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/operations/{operationsId}",
"httpMethod": "GET",
"id": "cloudfunctions.projects.locations.operations.get",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"description": "The name of the operation resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+/operations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+name}",
"response": {
"$ref": "Operation"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
},
"list": {
"description": "Lists operations that match the specified filter in the request. If the server doesn't support this method, it returns `UNIMPLEMENTED`.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/operations",
"httpMethod": "GET",
"id": "cloudfunctions.projects.locations.operations.list",
"parameterOrder": [
"name"
],
"parameters": {
"filter": {
"description": "The standard list filter.",
"location": "query",
"type": "string"
},
"name": {
"description": "The name of the operation's parent resource.",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
},
"pageSize": {
"description": "The standard list page size.",
"format": "int32",
"location": "query",
"type": "integer"
},
"pageToken": {
"description": "The standard list page token.",
"location": "query",
"type": "string"
},
"returnPartialSuccess": {
"description": "When set to `true`, operations that are reachable are returned as normal, and those that are unreachable are returned in the ListOperationsResponse.unreachable field. This can only be `true` when reading across collections. For example, when `parent` is set to `\"projects/example/locations/-\"`. This field is not supported by default and will result in an `UNIMPLEMENTED` error if set unless explicitly documented otherwise in service or product specific documentation.",
"location": "query",
"type": "boolean"
}
},
"path": "v2alpha/{+name}/operations",
"response": {
"$ref": "ListOperationsResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
},
"runtimes": {
"methods": {
"list": {
"description": "Returns a list of runtimes that are supported for the requested project.",
"flatPath": "v2alpha/projects/{projectsId}/locations/{locationsId}/runtimes",
"httpMethod": "GET",
"id": "cloudfunctions.projects.locations.runtimes.list",
"parameterOrder": [
"parent"
],
"parameters": {
"filter": {
"description": "The filter for Runtimes that match the filter expression, following the syntax outlined in https://google.aip.dev/160.",
"location": "query",
"type": "string"
},
"parent": {
"description": "Required. The project and location from which the runtimes should be listed, specified in the format `projects/*/locations/*`",
"location": "path",
"pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
"path": "v2alpha/{+parent}/runtimes",
"response": {
"$ref": "ListRuntimesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/cloud-platform"
]
}
}
}
}
}
}
}
},
"revision": "20260129",
"rootUrl": "https://cloudfunctions.googleapis.com/",
"schemas": {
"AbortFunctionUpgradeRequest": {
"description": "Request for the `AbortFunctionUpgrade` method.",
"id": "AbortFunctionUpgradeRequest",
"properties": {},
"type": "object"
},
"AuditConfig": {
"description": "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.",
"id": "AuditConfig",
"properties": {
"auditLogConfigs": {
"description": "The configuration for logging of each type of permission.",
"items": {
"$ref": "AuditLogConfig"
},
"type": "array"
},
"service": {
"description": "Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.",
"type": "string"
}
},
"type": "object"
},
"AuditLogConfig": {
"description": "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.",
"id": "AuditLogConfig",
"properties": {
"exemptedMembers": {
"description": "Specifies the identities that do not cause logging for this type of permission. Follows the same format of Binding.members.",
"items": {
"type": "string"
},
"type": "array"
},
"logType": {
"description": "The log type that this config enables.",
"enum": [
"LOG_TYPE_UNSPECIFIED",
"ADMIN_READ",
"DATA_WRITE",
"DATA_READ"
],
"enumDescriptions": [
"Default case. Should never be this.",
"Admin reads. Example: CloudIAM getIamPolicy",
"Data writes. Example: CloudSQL Users create",
"Data reads. Example: CloudSQL Users list"
],
"type": "string"
}
},
"type": "object"
},
"AutomaticUpdatePolicy": {
"description": "Security patches are applied automatically to the runtime without requiring the function to be redeployed.",
"id": "AutomaticUpdatePolicy",
"properties": {},
"type": "object"
},
"Binding": {
"description": "Associates `members`, or principals, with a `role`.",
"id": "Binding",
"properties": {
"condition": {
"$ref": "Expr",
"description": "The condition that is associated with this binding. If the condition evaluates to `true`, then this binding applies to the current request. If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the principals in this binding. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies)."
},
"members": {
"description": "Specifies the principals requesting access for a Google Cloud resource. `members` can 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. Does not include identities that come from external identity providers (IdPs) through identity federation. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` . * `serviceAccount:{emailid}`: An email address that represents a Google service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `serviceAccount:{projectid}.svc.id.goog[{namespace}/{kubernetes-sa}]`: An identifier for a [Kubernetes service account](https://cloud.google.com/kubernetes-engine/docs/how-to/kubernetes-service-accounts). For example, `my-project.svc.id.goog[my-namespace/my-kubernetes-sa]`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`. * `principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workforce identity pool. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/group/{group_id}`: All workforce identities in a group. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All workforce identities with a specific attribute value. * `principalSet://iam.googleapis.com/locations/global/workforcePools/{pool_id}/*`: All identities in a workforce identity pool. * `principal://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/subject/{subject_attribute_value}`: A single identity in a workload identity pool. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/group/{group_id}`: A workload identity pool group. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/attribute.{attribute_name}/{attribute_value}`: All identities in a workload identity pool with a certain attribute. * `principalSet://iam.googleapis.com/projects/{project_number}/locations/global/workloadIdentityPools/{pool_id}/*`: All identities in a workload identity pool. * `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 to `user:{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 to `serviceAccount:{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 to `group:{emailid}` and the recovered group retains the role in the binding. * `deleted:principal://iam.googleapis.com/locations/global/workforcePools/{pool_id}/subject/{subject_attribute_value}`: Deleted single identity in a workforce identity pool. For example, `deleted:principal://iam.googleapis.com/locations/global/workforcePools/my-pool-id/subject/my-subject-attribute-value`.",
"items": {
"type": "string"
},
"type": "array"
},
"role": {
"description": "Role that is assigned to the list of `members`, or principals. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. For an overview of the IAM roles and permissions, see the [IAM documentation](https://cloud.google.com/iam/docs/roles-overview). For a list of the available pre-defined roles, see [here](https://cloud.google.com/iam/docs/understanding-roles).",
"type": "string"
}
},
"type": "object"
},
"BuildConfig": {
"description": "Describes the Build step of the function that builds a container from the given source.",
"id": "BuildConfig",
"properties": {
"automaticUpdatePolicy": {
"$ref": "AutomaticUpdatePolicy"
},
"build": {
"description": "Output only. The Cloud Build name of the latest successful deployment of the function.",
"readOnly": true,
"type": "string"
},
"dockerRegistry": {
"deprecated": true,
"description": "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: as of March 2025, `CONTAINER_REGISTRY` option is no longer available in response to Container Registry's deprecation: 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 `docker_repository` field is specified, this field should either be left unspecified or set to `ARTIFACT_REGISTRY`.",
"enum": [
"DOCKER_REGISTRY_UNSPECIFIED",
"CONTAINER_REGISTRY",
"ARTIFACT_REGISTRY"
],
"enumDescriptions": [
"Unspecified.",
"Docker images will be stored in multi-regional Container Registry repositories named `gcf`.",
"Docker images will be stored in regional Artifact Registry repositories. By default, GCF will create and use repositories named `gcf-artifacts` in every region in which a function is deployed. But the repository to use can also be specified by the user using the `docker_repository` field."
],
"type": "string"
},
"dockerRepository": {
"description": "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'.",
"type": "string"
},
"entryPoint": {
"description": "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`.",
"type": "string"
},
"environmentVariables": {
"additionalProperties": {
"type": "string"
},
"description": "User-provided build-time environment variables for the function",
"type": "object"
},
"onDeployUpdatePolicy": {
"$ref": "OnDeployUpdatePolicy"
},
"runtime": {
"description": "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](https://cloud.google.com/sdk/gcloud/reference/functions/deploy#--runtime).",
"type": "string"
},
"serviceAccount": {
"description": "Service account to be used for building the container. The format of this field is `projects/{projectId}/serviceAccounts/{serviceAccountEmail}`.",
"type": "string"
},
"source": {
"$ref": "Source",
"description": "The location of the function source code."
},
"sourceProvenance": {
"$ref": "SourceProvenance",
"description": "Output only. A permanent fixed identifier for source.",
"readOnly": true
},
"sourceToken": {
"description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.",
"type": "string"
},
"workerPool": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"BuildConfigOverrides": {
"description": "Contains overrides related to the function's build configuration.",
"id": "BuildConfigOverrides",
"properties": {
"runtime": {
"description": "Optional. Specifies the desired runtime for the new Cloud Run function. (e.g., `\"nodejs20\"`, `\"python312\"`). Constraints: 1. This field CANNOT be used to change the runtime language (e.g., from `NODEJS` to `PYTHON`). The backend will enforce this. 2. This field can ONLY be used to upgrade the runtime version (e.g., `nodejs18` to `nodejs20`). Downgrading the version is not permitted. The backend will validate the version change. If provided and valid, this overrides the runtime of the Gen1 function.",
"type": "string"
}
},
"type": "object"
},
"CommitFunctionUpgradeAsGen2Request": {
"description": "Request for the `CommitFunctionUpgradeAsGen2` method.",
"id": "CommitFunctionUpgradeAsGen2Request",
"properties": {},
"type": "object"
},
"CommitFunctionUpgradeRequest": {
"description": "Request for the `CommitFunctionUpgrade` method.",
"id": "CommitFunctionUpgradeRequest",
"properties": {},
"type": "object"
},
"Date": {
"description": "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",
"id": "Date",
"properties": {
"day": {
"description": "Day of a month. Must be from 1 to 31 and valid for the year and month, or 0 to specify a year by itself or a year and month where the day isn't significant.",
"format": "int32",
"type": "integer"
},
"month": {
"description": "Month of a year. Must be from 1 to 12, or 0 to specify a year without a month and day.",
"format": "int32",
"type": "integer"
},
"year": {
"description": "Year of the date. Must be from 1 to 9999, or 0 to specify a date without a year.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"DetachFunctionRequest": {
"description": "Request for the `DetachFunction` method.",
"id": "DetachFunctionRequest",
"properties": {},
"type": "object"
},
"DirectVpcNetworkInterface": {
"description": "The Direct VPC network interface. This is mutually exclusive with VPC Connector.",
"id": "DirectVpcNetworkInterface",
"properties": {
"network": {
"description": "Optional. The name of the VPC network to which the function will be connected. Specify either a VPC network or a subnet, or both. If you specify only a network, the subnet uses the same name as the network.",
"type": "string"
},
"subnetwork": {
"description": "Optional. The name of the VPC subnetwork that the Cloud Function resource will get IPs from. Specify either a VPC network or a subnet, or both. If both network and subnetwork are specified, the given VPC subnetwork must belong to the given VPC network. If subnetwork is not specified, the subnetwork with the same name with the network will be used.",
"type": "string"
},
"tags": {
"description": "Optional. Network tags applied to this Cloud Function resource.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"EventFilter": {
"description": "Filters events based on exact matches on the CloudEvents attributes.",
"id": "EventFilter",
"properties": {
"attribute": {
"description": "Required. The name of a CloudEvents attribute.",
"type": "string"
},
"operator": {
"description": "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`.",
"type": "string"
},
"value": {
"description": "Required. The value for the attribute.",
"type": "string"
}
},
"type": "object"
},
"EventTrigger": {
"description": "Describes EventTrigger, used to request events to be sent from another service.",
"id": "EventTrigger",
"properties": {
"channel": {
"description": "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.",
"type": "string"
},
"eventFilters": {
"description": "Criteria used to filter events.",
"items": {
"$ref": "EventFilter"
},
"type": "array"
},
"eventType": {
"description": "Required. The type of event to observe. For example: `google.cloud.audit.log.v1.written` or `google.cloud.pubsub.topic.v1.messagePublished`.",
"type": "string"
},
"pubsubTopic": {
"description": "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.",
"type": "string"
},
"retryPolicy": {
"description": "Optional. If unset, then defaults to ignoring failures (i.e. not retrying them).",
"enum": [
"RETRY_POLICY_UNSPECIFIED",
"RETRY_POLICY_DO_NOT_RETRY",
"RETRY_POLICY_RETRY"
],
"enumDescriptions": [
"Not specified.",
"Do not retry.",
"Retry on any failure, retry up to 7 days with an exponential backoff (capped at 10 seconds)."
],
"type": "string"
},
"service": {
"description": "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.",
"type": "string"
},
"serviceAccountEmail": {
"description": "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`.",
"type": "string"
},
"trigger": {
"description": "Output only. The resource name of the Eventarc trigger. The format of this field is `projects/{project}/locations/{region}/triggers/{trigger}`.",
"readOnly": true,
"type": "string"
},
"triggerRegion": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"Expr": {
"description": "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.",
"id": "Expr",
"properties": {
"description": {
"description": "Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.",
"type": "string"
},
"expression": {
"description": "Textual representation of an expression in Common Expression Language syntax.",
"type": "string"
},
"location": {
"description": "Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.",
"type": "string"
},
"title": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"Function": {
"description": "Describes a Cloud Function that contains user computation executed in response to an event. It encapsulates function and trigger configurations.",
"id": "Function",
"properties": {
"buildConfig": {
"$ref": "BuildConfig",
"description": "Describes the Build step of the function that builds a container from the given source."
},
"createTime": {
"description": "Output only. The create timestamp of a Cloud Function. This is only applicable to 2nd Gen functions.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"description": {
"description": "User-provided description of a function.",
"type": "string"
},
"environment": {
"description": "Describe whether the function is 1st Gen or 2nd Gen.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"GEN_1",
"GEN_2"
],
"enumDescriptions": [
"Unspecified",
"Gen 1",
"Gen 2"
],
"type": "string"
},
"eventTrigger": {
"$ref": "EventTrigger",
"description": "An Eventarc trigger managed by Google Cloud Functions that fires events in response to a condition in another service."
},
"kmsKeyName": {
"description": "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}`.",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Labels associated with this Cloud Function.",
"type": "object"
},
"name": {
"description": "A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`",
"type": "string"
},
"satisfiesPzi": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"satisfiesPzs": {
"description": "Output only. Reserved for future use.",
"readOnly": true,
"type": "boolean"
},
"serviceConfig": {
"$ref": "ServiceConfig",
"description": "Describes the Service being deployed. Currently deploys services to Cloud Run (fully managed)."
},
"state": {
"description": "Output only. State of the function.",
"enum": [
"STATE_UNSPECIFIED",
"ACTIVE",
"FAILED",
"DEPLOYING",
"DELETING",
"UNKNOWN",
"DETACHING",
"DETACH_FAILED"
],
"enumDescriptions": [
"Not specified. Invalid state.",
"Function has been successfully deployed and is serving.",
"Function deployment failed and the function is not serving.",
"Function is being created or updated.",
"Function is being deleted.",
"Function deployment failed and the function serving state is undefined. The function should be updated or deleted to move it out of this state.",
"Function is being detached.",
"Function detach failed and the function is still serving."
],
"readOnly": true,
"type": "string"
},
"stateMessages": {
"description": "Output only. State Messages for this Cloud Function.",
"items": {
"$ref": "GoogleCloudFunctionsV2alphaStateMessage"
},
"readOnly": true,
"type": "array"
},
"updateTime": {
"description": "Output only. The last update timestamp of a Cloud Function.",
"format": "google-datetime",
"readOnly": true,
"type": "string"
},
"upgradeInfo": {
"$ref": "UpgradeInfo",
"description": "Output only. UpgradeInfo for this Cloud Function",
"readOnly": true
},
"url": {
"description": "Output only. The deployed url for the function.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"GenerateDownloadUrlRequest": {
"description": "Request of `GenerateDownloadUrl` method.",
"id": "GenerateDownloadUrlRequest",
"properties": {},
"type": "object"
},
"GenerateDownloadUrlResponse": {
"description": "Response of `GenerateDownloadUrl` method.",
"id": "GenerateDownloadUrlResponse",
"properties": {
"downloadUrl": {
"description": "The generated Google Cloud Storage signed URL that should be used for function source code download.",
"type": "string"
}
},
"type": "object"
},
"GenerateUploadUrlRequest": {
"description": "Request of `GenerateSourceUploadUrl` method.",
"id": "GenerateUploadUrlRequest",
"properties": {
"environment": {
"description": "The function environment the generated upload url will be used for. The upload url for 2nd Gen functions can also be used for 1st gen functions, but not vice versa. If not specified, 2nd generation-style upload URLs are generated.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"GEN_1",
"GEN_2"
],
"enumDescriptions": [
"Unspecified",
"Gen 1",
"Gen 2"
],
"type": "string"
},
"kmsKeyName": {
"description": "Resource name of a KMS crypto key (managed by the user) used to encrypt/decrypt function source code objects in intermediate Cloud Storage buckets. When you generate an upload url and upload your source code, it gets copied to an intermediate Cloud Storage bucket. The source code is then copied to a versioned directory in the sources bucket in the consumer project during the function deployment. It must match the pattern `projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}`. The Google Cloud Functions service account (service-{project_number}@gcf-admin-robot.iam.gserviceaccount.com) must be granted the role 'Cloud KMS CryptoKey Encrypter/Decrypter (roles/cloudkms.cryptoKeyEncrypterDecrypter)' on the Key/KeyRing/Project/Organization (least access preferred).",
"type": "string"
}
},
"type": "object"
},
"GenerateUploadUrlResponse": {
"description": "Response of `GenerateSourceUploadUrl` method.",
"id": "GenerateUploadUrlResponse",
"properties": {
"storageSource": {
"$ref": "StorageSource",
"description": "The location of the source code in the upload bucket. Once the archive is uploaded using the `upload_url` use this field to set the `function.build_config.source.storage_source` during CreateFunction and UpdateFunction. Generation defaults to 0, as Cloud Storage provides a new generation only upon uploading a new object or version of an object."
},
"uploadUrl": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2alphaLocationMetadata": {
"description": "Extra GCF specific location information.",
"id": "GoogleCloudFunctionsV2alphaLocationMetadata",
"properties": {
"environments": {
"description": "The Cloud Function environments this location supports.",
"items": {
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"GEN_1",
"GEN_2"
],
"enumDescriptions": [
"Unspecified",
"Gen 1",
"Gen 2"
],
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2alphaOperationMetadata": {
"description": "Represents the metadata of the long-running operation.",
"id": "GoogleCloudFunctionsV2alphaOperationMetadata",
"properties": {
"apiVersion": {
"description": "API version used to start the operation.",
"type": "string"
},
"buildName": {
"description": "The build name of the function for create and update operations.",
"type": "string"
},
"cancelRequested": {
"description": "Identifies whether the user has requested cancellation of the operation. Operations that have successfully been cancelled have google.longrunning.Operation.error value with a google.rpc.Status.code of 1, corresponding to `Code.CANCELLED`.",
"type": "boolean"
},
"createTime": {
"description": "The time the operation was created.",
"format": "google-datetime",
"type": "string"
},
"customIamRoleDetected": {
"description": "Output only. Whether a custom IAM role binding was detected during the upgrade.",
"readOnly": true,
"type": "boolean"
},
"endTime": {
"description": "The time the operation finished running.",
"format": "google-datetime",
"type": "string"
},
"operationType": {
"description": "The operation type.",
"enum": [
"OPERATIONTYPE_UNSPECIFIED",
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION",
"REDIRECT_FUNCTION_UPGRADE_TRAFFIC",
"ROLLBACK_FUNCTION_UPGRADE_TRAFFIC",
"SETUP_FUNCTION_UPGRADE_CONFIG",
"ABORT_FUNCTION_UPGRADE",
"COMMIT_FUNCTION_UPGRADE",
"DETACH_FUNCTION",
"COMMIT_FUNCTION_UPGRADE_AS_GEN2"
],
"enumDescriptions": [
"Unspecified",
"CreateFunction",
"UpdateFunction",
"DeleteFunction",
"RedirectFunctionUpgradeTraffic",
"RollbackFunctionUpgradeTraffic",
"SetupFunctionUpgradeConfig",
"AbortFunctionUpgrade",
"CommitFunctionUpgrade",
"DetachFunction",
"CommitFunctionUpgradeAsGen2"
],
"type": "string"
},
"requestResource": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The original request that started the operation.",
"type": "object"
},
"sourceToken": {
"description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.",
"type": "string"
},
"stages": {
"description": "Mechanism for reporting in-progress stages",
"items": {
"$ref": "GoogleCloudFunctionsV2alphaStage"
},
"type": "array"
},
"statusDetail": {
"description": "Human-readable status of the operation, if any.",
"type": "string"
},
"target": {
"description": "Server-defined resource path for the target of the operation.",
"type": "string"
},
"verb": {
"description": "Name of the verb executed by the operation.",
"type": "string"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2alphaStage": {
"description": "Each Stage of the deployment process",
"id": "GoogleCloudFunctionsV2alphaStage",
"properties": {
"message": {
"description": "Message describing the Stage",
"type": "string"
},
"name": {
"description": "Name of the Stage. This will be unique for each Stage.",
"enum": [
"NAME_UNSPECIFIED",
"ARTIFACT_REGISTRY",
"BUILD",
"SERVICE",
"TRIGGER",
"SERVICE_ROLLBACK",
"TRIGGER_ROLLBACK"
],
"enumDescriptions": [
"Not specified. Invalid name.",
"Artifact Registry Stage",
"Build Stage",
"Service Stage",
"Trigger Stage",
"Service Rollback Stage",
"Trigger Rollback Stage"
],
"type": "string"
},
"resource": {
"description": "Resource of the Stage",
"type": "string"
},
"resourceUri": {
"description": "Link to the current Stage resource",
"type": "string"
},
"state": {
"description": "Current state of the Stage",
"enum": [
"STATE_UNSPECIFIED",
"NOT_STARTED",
"IN_PROGRESS",
"COMPLETE"
],
"enumDescriptions": [
"Not specified. Invalid state.",
"Stage has not started.",
"Stage is in progress.",
"Stage has completed."
],
"type": "string"
},
"stateMessages": {
"description": "State messages from the current Stage.",
"items": {
"$ref": "GoogleCloudFunctionsV2alphaStateMessage"
},
"type": "array"
}
},
"type": "object"
},
"GoogleCloudFunctionsV2alphaStateMessage": {
"description": "Informational messages about the state of the Cloud Function or Operation.",
"id": "GoogleCloudFunctionsV2alphaStateMessage",
"properties": {
"message": {
"description": "The message.",
"type": "string"
},
"severity": {
"description": "Severity of the state message.",
"enum": [
"SEVERITY_UNSPECIFIED",
"ERROR",
"WARNING",
"INFO"
],
"enumDescriptions": [
"Not specified. Invalid severity.",
"ERROR-level severity.",
"WARNING-level severity.",
"INFO-level severity."
],
"type": "string"
},
"type": {
"description": "One-word CamelCase type of the state message.",
"type": "string"
}
},
"type": "object"
},
"ListFunctionsResponse": {
"description": "Response for the `ListFunctions` method.",
"id": "ListFunctionsResponse",
"properties": {
"functions": {
"description": "The functions that match the request.",
"items": {
"$ref": "Function"
},
"type": "array"
},
"nextPageToken": {
"description": "A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.",
"type": "string"
},
"unreachable": {
"description": "Locations that could not be reached. The response does not include any functions from these locations.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"id": "ListLocationsResponse",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"type": "object"
},
"ListOperationsResponse": {
"description": "The response message for Operations.ListOperations.",
"id": "ListOperationsResponse",
"properties": {
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
},
"operations": {
"description": "A list of operations that matches the specified filter in the request.",
"items": {
"$ref": "Operation"
},
"type": "array"
},
"unreachable": {
"description": "Unordered list. Unreachable resources. Populated when the request sets `ListOperationsRequest.return_partial_success` and reads across collections. For example, when attempting to list all resources across all supported locations.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"ListRuntimesResponse": {
"description": "Response for the `ListRuntimes` method.",
"id": "ListRuntimesResponse",
"properties": {
"runtimes": {
"description": "The runtimes that match the request.",
"items": {
"$ref": "Runtime"
},
"type": "array"
}
},
"type": "object"
},
"Location": {
"description": "A resource that represents a Google Cloud location.",
"id": "Location",
"properties": {
"displayName": {
"description": "The friendly name for this location, typically a nearby city name. For example, \"Tokyo\".",
"type": "string"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given location.",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations. For example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"type": "object"
},
"OnDeployUpdatePolicy": {
"description": "Security patches are only applied when a function is redeployed.",
"id": "OnDeployUpdatePolicy",
"properties": {
"runtimeVersion": {
"description": "Output only. contains the runtime version which was used during latest function deployment.",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"Operation": {
"description": "This resource represents a long-running operation that is the result of a network API call.",
"id": "Operation",
"properties": {
"done": {
"description": "If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.",
"type": "boolean"
},
"error": {
"$ref": "Status",
"description": "The error result of the operation in case of failure or cancellation."
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "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.",
"type": "object"
},
"name": {
"description": "The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.",
"type": "string"
},
"response": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.",
"type": "object"
}
},
"type": "object"
},
"OperationMetadataV1": {
"description": "Metadata describing an Operation",
"id": "OperationMetadataV1",
"properties": {
"buildId": {
"description": "The Cloud Build ID of the function created or updated by an API call. This field is only populated for Create and Update operations.",
"type": "string"
},
"buildName": {
"description": "The Cloud Build Name of the function deployment. This field is only populated for Create and Update operations. `projects//locations//builds/`.",
"type": "string"
},
"request": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "The original request that started the operation.",
"type": "object"
},
"sourceToken": {
"description": "An identifier for Firebase function sources. Disclaimer: This field is only supported for Firebase function deployments.",
"type": "string"
},
"target": {
"description": "Target of the operation - for example `projects/project-1/locations/region-1/functions/function-1`",
"type": "string"
},
"type": {
"description": "Type of operation.",
"enum": [
"OPERATION_UNSPECIFIED",
"CREATE_FUNCTION",
"UPDATE_FUNCTION",
"DELETE_FUNCTION"
],
"enumDescriptions": [
"Unknown operation type.",
"Triggered by CreateFunction call",
"Triggered by UpdateFunction call",
"Triggered by DeleteFunction call."
],
"type": "string"
},
"updateTime": {
"description": "The last update timestamp of the operation.",
"format": "google-datetime",
"type": "string"
},
"versionId": {
"description": "Version id of the function created or updated by an API call. This field is only populated for Create and Update operations.",
"format": "int64",
"type": "string"
}
},
"type": "object"
},
"Policy": {
"description": "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](https://cloud.google.com/iam/help/conditions/resource-policies). **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](https://cloud.google.com/iam/docs/).",
"id": "Policy",
"properties": {
"auditConfigs": {
"description": "Specifies cloud audit logging configuration for this policy.",
"items": {
"$ref": "AuditConfig"
},
"type": "array"
},
"bindings": {
"description": "Associates a list of `members`, or principals, with a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one principal. The `bindings` in a `Policy` can refer to up to 1,500 principals; up to 250 of these principals can be Google groups. Each occurrence of a principal counts towards these limits. For example, if the `bindings` grant 50 different roles to `user:alice@example.com`, and not to any other principal, then you can add another 1,450 principals to the `bindings` in the `Policy`.",
"items": {
"$ref": "Binding"
},
"type": "array"
},
"etag": {
"description": "`etag` is 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 the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.",
"format": "byte",
"type": "string"
},
"version": {
"description": "Specifies the format of the policy. Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected. Any operation that affects conditional role bindings must specify version `3`. 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 the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy 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](https://cloud.google.com/iam/help/conditions/resource-policies).",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"RedirectFunctionUpgradeTrafficRequest": {
"description": "Request for the `RedirectFunctionUpgradeTraffic` method.",
"id": "RedirectFunctionUpgradeTrafficRequest",
"properties": {},
"type": "object"
},
"RepoSource": {
"description": "Location of the source in a Google Cloud Source Repository.",
"id": "RepoSource",
"properties": {
"branchName": {
"description": "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",
"type": "string"
},
"commitSha": {
"description": "Explicit commit SHA to build.",
"type": "string"
},
"dir": {
"description": "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)",
"type": "string"
},
"projectId": {
"description": "ID of the project that owns the Cloud Source Repository. If omitted, the project ID requesting the build is assumed.",
"type": "string"
},
"repoName": {
"description": "Name of the Cloud Source Repository.",
"type": "string"
},
"tagName": {
"description": "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",
"type": "string"
}
},
"type": "object"
},
"RollbackFunctionUpgradeTrafficRequest": {
"description": "Request for the `RollbackFunctionUpgradeTraffic` method.",
"id": "RollbackFunctionUpgradeTrafficRequest",
"properties": {},
"type": "object"
},
"Runtime": {
"description": "Describes a runtime and any special information (e.g., deprecation status) related to it.",
"id": "Runtime",
"properties": {
"decommissionDate": {
"$ref": "Date",
"description": "Decommission date for the runtime."
},
"deprecationDate": {
"$ref": "Date",
"description": "Deprecation date for the runtime."
},
"displayName": {
"description": "The user facing name, eg 'Go 1.13', 'Node.js 12', etc.",
"type": "string"
},
"environment": {
"description": "The environment for the runtime.",
"enum": [
"ENVIRONMENT_UNSPECIFIED",
"GEN_1",
"GEN_2"
],
"enumDescriptions": [
"Unspecified",
"Gen 1",
"Gen 2"
],
"type": "string"
},
"name": {
"description": "The name of the runtime, e.g., 'go113', 'nodejs12', etc.",
"type": "string"
},
"stage": {
"description": "The stage of life this runtime is in, e.g., BETA, GA, etc.",
"enum": [
"RUNTIME_STAGE_UNSPECIFIED",
"DEVELOPMENT",
"ALPHA",
"BETA",
"GA",
"DEPRECATED",
"DECOMMISSIONED"
],
"enumDescriptions": [
"Not specified.",
"The runtime is in development.",
"The runtime is in the Alpha stage.",
"The runtime is in the Beta stage.",
"The runtime is generally available.",
"The runtime is deprecated.",
"The runtime is no longer supported."
],
"type": "string"
},
"warnings": {
"description": "Warning messages, e.g., a deprecation warning.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"SecretEnvVar": {
"description": "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.",
"id": "SecretEnvVar",
"properties": {
"key": {
"description": "Name of the environment variable.",
"type": "string"
},
"projectId": {
"description": "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.",
"type": "string"
},
"secret": {
"description": "Name of the secret in secret manager (not the full resource name).",
"type": "string"
},
"version": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"SecretVersion": {
"description": "Configuration for a single version.",
"id": "SecretVersion",
"properties": {
"path": {
"description": "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_foo` would mount the secret value file at `/etc/secrets/secret_foo`.",
"type": "string"
},
"version": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"SecretVolume": {
"description": "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.",
"id": "SecretVolume",
"properties": {
"mountPath": {
"description": "The path within the container to mount the secret volume. For example, setting the mount_path 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",
"type": "string"
},
"projectId": {
"description": "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.",
"type": "string"
},
"secret": {
"description": "Name of the secret in secret manager (not the full resource name).",
"type": "string"
},
"versions": {
"description": "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.",
"items": {
"$ref": "SecretVersion"
},
"type": "array"
}
},
"type": "object"
},
"ServiceConfig": {
"description": "Describes the Service being deployed. Currently Supported : Cloud Run (fully managed).",
"id": "ServiceConfig",
"properties": {
"allTrafficOnLatestRevision": {
"description": "Whether 100% of traffic is routed to the latest revision. On CreateFunction and UpdateFunction, when set to true, the revision being deployed will serve 100% of traffic, ignoring any traffic split settings, if any. On GetFunction, true will be returned if the latest revision is serving 100% of traffic.",
"type": "boolean"
},
"availableCpu": {
"description": "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",
"type": "string"
},
"availableMemory": {
"description": "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.",
"type": "string"
},
"binaryAuthorizationPolicy": {
"description": "Optional. The binary authorization policy to be checked when deploying the Cloud Run service.",
"type": "string"
},
"directVpcEgress": {
"description": "Optional. Egress settings for direct VPC. If not provided, it defaults to VPC_EGRESS_PRIVATE_RANGES_ONLY.",
"enum": [
"DIRECT_VPC_EGRESS_UNSPECIFIED",
"VPC_EGRESS_PRIVATE_RANGES_ONLY",
"VPC_EGRESS_ALL_TRAFFIC"
],
"enumDescriptions": [
"Unspecified.",
"Sends only traffic to internal addresses through the VPC network.",
"Sends all outbound traffic through the VPC network."
],
"type": "string"
},
"directVpcNetworkInterface": {
"description": "Optional. The Direct VPC network interface for the Cloud Function. Currently only a single Direct VPC is supported.",
"items": {
"$ref": "DirectVpcNetworkInterface"
},
"type": "array"
},
"environmentVariables": {
"additionalProperties": {
"type": "string"
},
"description": "Environment variables that shall be available during function execution.",
"type": "object"
},
"ingressSettings": {
"description": "The ingress settings for the function, controlling what traffic can reach it.",
"enum": [
"INGRESS_SETTINGS_UNSPECIFIED",
"ALLOW_ALL",
"ALLOW_INTERNAL_ONLY",
"ALLOW_INTERNAL_AND_GCLB"
],
"enumDescriptions": [
"Unspecified.",
"Allow HTTP traffic from public and private sources.",
"Allow HTTP traffic from only private VPC sources.",
"Allow HTTP traffic from private VPC sources and through GCLB."
],
"type": "string"
},
"maxInstanceCount": {
"description": "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](https://cloud.google.com/functions/docs/max-instances) Guide for more details.",
"format": "int32",
"type": "integer"
},
"maxInstanceRequestConcurrency": {
"description": "Sets the maximum number of concurrent requests that each instance can receive. Defaults to 1.",
"format": "int32",
"type": "integer"
},
"minInstanceCount": {
"description": "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.",
"format": "int32",
"type": "integer"
},
"revision": {
"description": "Output only. The name of service revision.",
"readOnly": true,
"type": "string"
},
"secretEnvironmentVariables": {
"description": "Secret environment variables configuration.",
"items": {
"$ref": "SecretEnvVar"
},
"type": "array"
},
"secretVolumes": {
"description": "Secret volumes configuration.",
"items": {
"$ref": "SecretVolume"
},
"type": "array"
},
"securityLevel": {
"description": "Security level configure whether the function only accepts https. This configuration is only applicable to 1st Gen functions with Http trigger. By default https is optional for 1st Gen functions; 2nd Gen functions are https ONLY.",
"enum": [
"SECURITY_LEVEL_UNSPECIFIED",
"SECURE_ALWAYS",
"SECURE_OPTIONAL"
],
"enumDescriptions": [
"Unspecified.",
"Requests for a URL that match this handler that do not use HTTPS are automatically redirected to the HTTPS URL with the same path. Query parameters are reserved for the redirect.",
"Both HTTP and HTTPS requests with URLs that match the handler succeed without redirects. The application can examine the request to determine which protocol was used and respond accordingly."
],
"type": "string"
},
"service": {
"description": "Output only. Name of the service associated with a Function. The format of this field is `projects/{project}/locations/{region}/services/{service}`",
"readOnly": true,
"type": "string"
},
"serviceAccountEmail": {
"description": "The email of the service's service account. If empty, defaults to `{project_number}-compute@developer.gserviceaccount.com`.",
"type": "string"
},
"timeoutSeconds": {
"description": "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.",
"format": "int32",
"type": "integer"
},
"uri": {
"description": "Output only. URI of the Service deployed.",
"readOnly": true,
"type": "string"
},
"vpcConnector": {
"description": "The Serverless VPC Access connector that this cloud function can connect to. The format of this field is `projects/*/locations/*/connectors/*`.",
"type": "string"
},
"vpcConnectorEgressSettings": {
"description": "The egress settings for the connector, controlling what traffic is diverted through it.",
"enum": [
"VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED",
"PRIVATE_RANGES_ONLY",
"ALL_TRAFFIC"
],
"enumDescriptions": [
"Unspecified.",
"Use the VPC Access Connector only for private IP space from RFC1918.",
"Force the use of VPC Access Connector for all egress traffic from the function."
],
"type": "string"
}
},
"type": "object"
},
"ServiceConfigOverrides": {
"description": "Contains overrides related to the function's service configuration.",
"id": "ServiceConfigOverrides",
"properties": {
"maxInstanceCount": {
"description": "Optional. Specifies the maximum number of instances for the new Cloud Run function. If provided, this overrides the max_instance_count setting of the Gen1 function.",
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"SetIamPolicyRequest": {
"description": "Request message for `SetIamPolicy` method.",
"id": "SetIamPolicyRequest",
"properties": {
"policy": {
"$ref": "Policy",
"description": "REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Google Cloud services (such as Projects) might reject them."
},
"updateMask": {
"description": "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\"`",
"format": "google-fieldmask",
"type": "string"
}
},
"type": "object"
},
"SetupFunctionUpgradeConfigRequest": {
"description": "Request for the `SetupFunctionUpgradeConfig` method.",
"id": "SetupFunctionUpgradeConfigRequest",
"properties": {
"buildConfigOverrides": {
"$ref": "BuildConfigOverrides",
"description": "Optional. Specifies overrides for the build process."
},
"serviceConfigOverrides": {
"$ref": "ServiceConfigOverrides",
"description": "Optional. Specifies overrides for the service configuration."
},
"triggerServiceAccount": {
"description": "Optional. 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`.",
"type": "string"
}
},
"type": "object"
},
"Source": {
"description": "The location of the function source code.",
"id": "Source",
"properties": {
"gitUri": {
"description": "If provided, get the source from GitHub repository. This option is valid only for GCF 1st Gen function. Example: https://github.com///blob//",
"type": "string"
},
"repoSource": {
"$ref": "RepoSource",
"description": "If provided, get the source from this location in a Cloud Source Repository."
},
"storageSource": {
"$ref": "StorageSource",
"description": "If provided, get the source from this location in Google Cloud Storage."
}
},
"type": "object"
},
"SourceProvenance": {
"description": "Provenance of the source. Ways to find the original source, or verify that some source was used for this build.",
"id": "SourceProvenance",
"properties": {
"gitUri": {
"description": "A copy of the build's `source.git_uri`, if exists, with any commits resolved.",
"type": "string"
},
"resolvedRepoSource": {
"$ref": "RepoSource",
"description": "A copy of the build's `source.repo_source`, if exists, with any revisions resolved."
},
"resolvedStorageSource": {
"$ref": "StorageSource",
"description": "A copy of the build's `source.storage_source`, if exists, with any generations resolved."
}
},
"type": "object"
},
"Status": {
"description": "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](https://github.com/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](https://cloud.google.com/apis/design/errors).",
"id": "Status",
"properties": {
"code": {
"description": "The status code, which should be an enum value of google.rpc.Code.",
"format": "int32",
"type": "integer"
},
"details": {
"description": "A list of messages that carry the error details. There is a common set of message types for APIs to use.",
"items": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"type": "object"
},
"type": "array"
},
"message": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"StorageSource": {
"description": "Location of the source in an archive file in Google Cloud Storage.",
"id": "StorageSource",
"properties": {
"bucket": {
"description": "Google Cloud Storage bucket containing the source (see [Bucket Name Requirements](https://cloud.google.com/storage/docs/bucket-naming#requirements)).",
"type": "string"
},
"generation": {
"description": "Google Cloud Storage generation for the object. If the generation is omitted, the latest generation will be used.",
"format": "int64",
"type": "string"
},
"object": {
"description": "Google Cloud Storage object containing the source. This object must be a gzipped archive file (`.tar.gz`) containing source to build.",
"type": "string"
},
"sourceUploadUrl": {
"description": "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.",
"type": "string"
}
},
"type": "object"
},
"TestIamPermissionsRequest": {
"description": "Request message for `TestIamPermissions` method.",
"id": "TestIamPermissionsRequest",
"properties": {
"permissions": {
"description": "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](https://cloud.google.com/iam/docs/overview#permissions).",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"TestIamPermissionsResponse": {
"description": "Response message for `TestIamPermissions` method.",
"id": "TestIamPermissionsResponse",
"properties": {
"permissions": {
"description": "A subset of `TestPermissionsRequest.permissions` that the caller is allowed.",
"items": {
"type": "string"
},
"type": "array"
}
},
"type": "object"
},
"UpgradeInfo": {
"description": "Information related to: * A function's eligibility for 1st Gen to 2nd Gen migration. * Current state of migration for function undergoing migration.",
"id": "UpgradeInfo",
"properties": {
"buildConfig": {
"$ref": "BuildConfig",
"description": "Describes the Build step of the function that builds a container to prepare for 2nd gen upgrade."
},
"eventTrigger": {
"$ref": "EventTrigger",
"description": "Describes the Event trigger which has been setup to prepare for 2nd gen upgrade."
},
"serviceConfig": {
"$ref": "ServiceConfig",
"description": "Describes the Cloud Run service which has been setup to prepare for 2nd gen upgrade."
},
"upgradeState": {
"description": "UpgradeState of the function",
"enum": [
"UPGRADE_STATE_UNSPECIFIED",
"ELIGIBLE_FOR_2ND_GEN_UPGRADE",
"INELIGIBLE_FOR_UPGRADE_UNTIL_REDEPLOYMENT",
"UPGRADE_OPERATION_IN_PROGRESS",
"SETUP_FUNCTION_UPGRADE_CONFIG_SUCCESSFUL",
"SETUP_FUNCTION_UPGRADE_CONFIG_ERROR",
"ABORT_FUNCTION_UPGRADE_ERROR",
"REDIRECT_FUNCTION_UPGRADE_TRAFFIC_SUCCESSFUL",
"REDIRECT_FUNCTION_UPGRADE_TRAFFIC_ERROR",
"ROLLBACK_FUNCTION_UPGRADE_TRAFFIC_ERROR",
"COMMIT_FUNCTION_UPGRADE_ERROR",
"COMMIT_FUNCTION_UPGRADE_ERROR_ROLLBACK_SAFE",
"COMMIT_FUNCTION_UPGRADE_AS_GEN2_SUCCESSFUL",
"COMMIT_FUNCTION_UPGRADE_AS_GEN2_ERROR"
],
"enumDescriptions": [
"Unspecified state. Most functions are in this upgrade state.",
"Functions in this state are eligible for 1st Gen upgrade.",
"Functions in this state are ineligible for 1st Gen upgrade until redeployment with newer runtime.",
"An upgrade related operation is in progress.",
"SetupFunctionUpgradeConfig API was successful and a 2nd Gen function has been created based on 1st Gen function instance.",
"SetupFunctionUpgradeConfig API was un-successful.",
"AbortFunctionUpgrade API was un-successful.",
"RedirectFunctionUpgradeTraffic API was successful and traffic is served by 2nd Gen function stack.",
"RedirectFunctionUpgradeTraffic API was un-successful.",
"RollbackFunctionUpgradeTraffic API was un-successful.",
"CommitFunctionUpgrade API was un-successful and 1st gen function might have broken.",
"CommitFunctionUpgrade API was un-successful but safe to rollback traffic or abort.",
"Indicates that the `CommitFunctionUpgradeAsGen2` API call succeeded and the function was successfully migrated to the 2nd Gen stack.",
"CommitFunctionUpgradeAsGen2 API was un-successful and 1st gen function might have broken."
],
"type": "string"
}
},
"type": "object"
}
},
"servicePath": "",
"title": "Cloud Functions API",
"version": "v2alpha",
"version_module": true
}