From 65669fc6d62f2ee015b48e35f393a35c5bb6b58c Mon Sep 17 00:00:00 2001 From: Harry Pidcock Date: Tue, 11 Sep 2018 10:37:43 +1000 Subject: [PATCH] Added Environment Variables configuration to Cloud Functions (#1830) --- google/resource_cloudfunctions_function.go | 15 + .../resource_cloudfunctions_function_test.go | 28 + google/utils.go | 5 + .../cloudfunctions/v1/cloudfunctions-api.json | 1415 +++++++++-------- .../cloudfunctions/v1/cloudfunctions-gen.go | 91 +- vendor/vendor.json | 6 +- .../r/cloudfunctions_function.html.markdown | 5 + 7 files changed, 846 insertions(+), 719 deletions(-) diff --git a/google/resource_cloudfunctions_function.go b/google/resource_cloudfunctions_function.go index dc087f6a..34772b2e 100644 --- a/google/resource_cloudfunctions_function.go +++ b/google/resource_cloudfunctions_function.go @@ -169,6 +169,11 @@ func resourceCloudFunctionsFunction() *schema.Resource { Optional: true, }, + "environment_variables": { + Type: schema.TypeMap, + Optional: true, + }, + "trigger_bucket": { Type: schema.TypeString, Optional: true, @@ -319,6 +324,10 @@ func resourceCloudFunctionsCreate(d *schema.ResourceData, meta interface{}) erro function.Labels = expandLabels(d) } + if _, ok := d.GetOk("environment_variables"); ok { + function.EnvironmentVariables = expandEnvironmentVariables(d) + } + log.Printf("[DEBUG] Creating cloud function: %s", function.Name) op, err := config.clientCloudFunctions.Projects.Locations.Functions.Create( cloudFuncId.locationId(), function).Do() @@ -361,6 +370,7 @@ func resourceCloudFunctionsRead(d *schema.ResourceData, meta interface{}) error } d.Set("timeout", timeout) d.Set("labels", function.Labels) + d.Set("environment_variables", function.EnvironmentVariables) if function.SourceArchiveUrl != "" { // sourceArchiveUrl should always be a Google Cloud Storage URL (e.g. gs://bucket/object) // https://cloud.google.com/functions/docs/reference/rest/v1/projects.locations.functions @@ -440,6 +450,11 @@ func resourceCloudFunctionsUpdate(d *schema.ResourceData, meta interface{}) erro updateMaskArr = append(updateMaskArr, "labels") } + if d.HasChange("environment_variables") { + function.EnvironmentVariables = expandEnvironmentVariables(d) + updateMaskArr = append(updateMaskArr, "environment_variables") + } + if d.HasChange("retry_on_failure") { if d.Get("retry_on_failure").(bool) { if function.EventTrigger == nil { diff --git a/google/resource_cloudfunctions_function_test.go b/google/resource_cloudfunctions_function_test.go index 799d12e9..086a0cee 100644 --- a/google/resource_cloudfunctions_function_test.go +++ b/google/resource_cloudfunctions_function_test.go @@ -66,6 +66,8 @@ func TestAccCloudFunctionsFunction_basic(t *testing.T) { resource.TestCheckResourceAttr(funcResourceName, "trigger_http", "true"), testAccCloudFunctionsFunctionHasLabel("my-label", "my-label-value", &function), + testAccCloudFunctionsFunctionHasEnvironmentVariable("TEST_ENV_VARIABLE", + "test-env-variable-value", &function), ), }, { @@ -119,6 +121,10 @@ func TestAccCloudFunctionsFunction_update(t *testing.T) { "timeout", "91"), testAccCloudFunctionsFunctionHasLabel("my-label", "my-updated-label-value", &function), testAccCloudFunctionsFunctionHasLabel("a-new-label", "a-new-label-value", &function), + testAccCloudFunctionsFunctionHasEnvironmentVariable("TEST_ENV_VARIABLE", + "test-env-variable-value", &function), + testAccCloudFunctionsFunctionHasEnvironmentVariable("NEW_ENV_VARIABLE", + "new-env-variable-value", &function), ), }, }, @@ -347,6 +353,21 @@ func testAccCloudFunctionsFunctionHasLabel(key, value string, } } +func testAccCloudFunctionsFunctionHasEnvironmentVariable(key, value string, + function *cloudfunctions.CloudFunction) resource.TestCheckFunc { + return func(s *terraform.State) error { + if val, ok := function.EnvironmentVariables[key]; ok { + if val != value { + return fmt.Errorf("Environment Variable value did not match for key %s: expected %s but found %s", + key, value, val) + } + } else { + return fmt.Errorf("Environment Variable with key %s not found", key) + } + return nil + } +} + func createZIPArchiveForIndexJs(sourcePath string) (string, error) { source, err := ioutil.ReadFile(sourcePath) if err != nil { @@ -411,6 +432,9 @@ resource "google_cloudfunctions_function" "function" { labels { my-label = "my-label-value" } + environment_variables { + TEST_ENV_VARIABLE = "test-env-variable-value" + } } `, bucketName, zipFilePath, functionName) } @@ -440,6 +464,10 @@ resource "google_cloudfunctions_function" "function" { my-label = "my-updated-label-value" a-new-label = "a-new-label-value" } + environment_variables { + TEST_ENV_VARIABLE = "test-env-variable-value" + NEW_ENV_VARIABLE = "new-env-variable-value" + } }`, bucketName, zipFilePath, functionName) } diff --git a/google/utils.go b/google/utils.go index 0590222a..7fe5aab2 100644 --- a/google/utils.go +++ b/google/utils.go @@ -272,6 +272,11 @@ func expandLabels(d *schema.ResourceData) map[string]string { return expandStringMap(d, "labels") } +// expandEnvironmentVariables pulls the value of "environment_variables" out of a schema.ResourceData as a map[string]string. +func expandEnvironmentVariables(d *schema.ResourceData) map[string]string { + return expandStringMap(d, "environment_variables") +} + // expandStringMap pulls the value of key out of a schema.ResourceData as a map[string]string. func expandStringMap(d *schema.ResourceData, key string) map[string]string { v, ok := d.GetOk(key) diff --git a/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-api.json b/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-api.json index 1726c80d..6607ae9b 100644 --- a/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-api.json +++ b/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-api.json @@ -1,10 +1,4 @@ { - "protocol": "rest", - "icons": { - "x32": "http://www.google.com/images/icons/product/search-32.gif", - "x16": "http://www.google.com/images/icons/product/search-16.gif" - }, - "canonicalName": "Cloud Functions", "auth": { "oauth2": { "scopes": { @@ -14,77 +8,165 @@ } } }, - "rootUrl": "https://cloudfunctions.googleapis.com/", - "ownerDomain": "google.com", - "name": "cloudfunctions", + "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, - "title": "Google Cloud Functions API", + "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:v1", + "kind": "discovery#restDescription", + "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": { "operations": { "methods": { - "list": { - "httpMethod": "GET", - "response": { - "$ref": "ListOperationsResponse" - }, - "parameterOrder": [], - "parameters": { - "filter": { - "type": "string", - "location": "query", - "description": "The standard list filter." - }, - "name": { - "location": "query", - "description": "The name of the operation's parent resource.", - "type": "string" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", - "type": "string" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "The standard list page size.", - "format": "int32" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/operations", - "id": "cloudfunctions.operations.list", - "path": "v1/operations", - "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id." - }, "get": { + "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice.", + "flatPath": "v1/operations/{operationsId}", "httpMethod": "GET", - "response": { - "$ref": "Operation" - }, + "id": "cloudfunctions.operations.get", "parameterOrder": [ "name" ], "parameters": { "name": { - "required": true, - "type": "string", - "pattern": "^operations/[^/]+$", + "description": "The name of the operation resource.", "location": "path", - "description": "The name of the operation resource." + "pattern": "^operations/[^/]+$", + "required": true, + "type": "string" } }, + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/operations/{operationsId}", - "id": "cloudfunctions.operations.get", - "path": "v1/{+name}", - "description": "Gets the latest state of a long-running operation. Clients can use this\nmethod to poll the operation result at intervals as recommended by the API\nservice." + ] + }, + "list": { + "description": "Lists operations that match the specified filter in the request. If the\nserver doesn't support this method, it returns `UNIMPLEMENTED`.\n\nNOTE: the `name` binding allows API services to override the binding\nto use different resource name schemes, such as `users/*/operations`. To\noverride the binding, API services can add a binding such as\n`\"/v1/{name=users/*}/operations\"` to their service configuration.\nFor backwards compatibility, the default name includes the operations\ncollection id, however overriding users must ensure the name binding\nis the parent resource, without the operations collection id.", + "flatPath": "v1/operations", + "httpMethod": "GET", + "id": "cloudfunctions.operations.list", + "parameterOrder": [], + "parameters": { + "filter": { + "description": "The standard list filter.", + "location": "query", + "type": "string" + }, + "name": { + "description": "The name of the operation's parent resource.", + "location": "query", + "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" + } + }, + "path": "v1/operations", + "response": { + "$ref": "ListOperationsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } }, @@ -93,281 +175,281 @@ "locations": { "methods": { "list": { + "description": "Lists information about the supported locations for this service.", + "flatPath": "v1/projects/{projectsId}/locations", "httpMethod": "GET", - "response": { - "$ref": "ListLocationsResponse" - }, + "id": "cloudfunctions.projects.locations.list", "parameterOrder": [ "name" ], "parameters": { "filter": { - "type": "string", + "description": "The standard list filter.", "location": "query", - "description": "The standard list filter." + "type": "string" }, "name": { - "location": "path", "description": "The resource that owns the locations collection, if applicable.", + "location": "path", + "pattern": "^projects/[^/]+$", "required": true, - "type": "string", - "pattern": "^projects/[^/]+$" - }, - "pageToken": { - "location": "query", - "description": "The standard list page token.", "type": "string" }, "pageSize": { - "type": "integer", - "location": "query", "description": "The standard list page size.", - "format": "int32" + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The standard list page token.", + "location": "query", + "type": "string" } }, + "path": "v1/{+name}/locations", + "response": { + "$ref": "ListLocationsResponse" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations", - "id": "cloudfunctions.projects.locations.list", - "path": "v1/{+name}/locations", - "description": "Lists information about the supported locations for this service." + ] } }, "resources": { "functions": { "methods": { - "patch": { - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "PATCH", - "parameters": { - "updateMask": { - "location": "query", - "description": "Required list of fields to be updated in this request.", - "format": "google-fieldmask", - "type": "string" - }, - "name": { - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", - "location": "path", - "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`" - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", - "path": "v1/{+name}", - "id": "cloudfunctions.projects.locations.functions.patch", - "request": { - "$ref": "CloudFunction" - }, - "description": "Updates existing function." - }, - "get": { - "response": { - "$ref": "CloudFunction" - }, - "parameterOrder": [ - "name" - ], - "httpMethod": "GET", - "parameters": { - "name": { - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", - "location": "path", - "description": "The name of the function which details should be obtained." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", - "path": "v1/{+name}", - "id": "cloudfunctions.projects.locations.functions.get", - "description": "Returns a function with the given name from the requested project." - }, - "delete": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", - "id": "cloudfunctions.projects.locations.functions.delete", - "path": "v1/{+name}", - "description": "Deletes a function with the given name from the specified project. If the\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.", - "httpMethod": "DELETE", - "response": { - "$ref": "Operation" - }, - "parameterOrder": [ - "name" - ], - "parameters": { - "name": { - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", - "location": "path", - "description": "The name of the function which should be deleted." - } - }, - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ] - }, - "list": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions", - "path": "v1/{+parent}/functions", - "id": "cloudfunctions.projects.locations.functions.list", - "description": "Returns a list of functions that belong to the requested project.", - "response": { - "$ref": "ListFunctionsResponse" - }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "GET", - "scopes": [ - "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "pageToken": { - "location": "query", - "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.", - "type": "string" - }, - "pageSize": { - "type": "integer", - "location": "query", - "description": "Maximum number of functions to return per call.", - "format": "int32" - }, - "parent": { - "location": "path", - "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" - } - } - }, "call": { - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call", - "path": "v1/{+name}:call", - "id": "cloudfunctions.projects.locations.functions.call", "description": "Invokes synchronously deployed function. To be used for testing, very\nlimited traffic allowed.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:call", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.call", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of the function to be called.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:call", "request": { "$ref": "CallFunctionRequest" }, "response": { "$ref": "CallFunctionResponse" }, - "parameterOrder": [ - "name" - ], - "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "name": { - "location": "path", - "description": "The name of the function to be called.", - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$" - } - } + ] }, "create": { + "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions", "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.create", "parameterOrder": [ "location" ], + "parameters": { + "location": { + "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+location}/functions", + "request": { + "$ref": "CloudFunction" + }, "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\ngiven function is used by some trigger, the trigger will be updated to\nremove this function.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "httpMethod": "DELETE", + "id": "cloudfunctions.projects.locations.functions.delete", + "parameterOrder": [ + "name" ], "parameters": { - "location": { + "name": { + "description": "The name of the function which should be deleted.", "location": "path", - "description": "The project and location in which the function should be created, specified\nin the format `projects/*/locations/*`", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$" + "type": "string" } }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions", - "id": "cloudfunctions.projects.locations.functions.create", - "path": "v1/{+location}/functions", - "description": "Creates a new function. If a function with the given name already exists in\nthe specified project, the long running operation will return\n`ALREADY_EXISTS` error.", + "path": "v1/{+name}", + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "generateDownloadUrl": { + "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl", + "parameterOrder": [ + "name" + ], + "parameters": { + "name": { + "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}:generateDownloadUrl", "request": { - "$ref": "CloudFunction" - } + "$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.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.", + "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-goog-content-length-range: 0,104857600`", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl", + "httpMethod": "POST", + "id": "cloudfunctions.projects.locations.functions.generateUploadUrl", + "parameterOrder": [ + "parent" + ], + "parameters": { + "parent": { + "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/functions:generateUploadUrl", "request": { "$ref": "GenerateUploadUrlRequest" }, "response": { "$ref": "GenerateUploadUrlResponse" }, - "parameterOrder": [ - "parent" - ], - "httpMethod": "POST", "scopes": [ "https://www.googleapis.com/auth/cloud-platform" - ], - "parameters": { - "parent": { - "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+$", - "location": "path", - "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*" - } - }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl", - "path": "v1/{+parent}/functions:generateUploadUrl", - "id": "cloudfunctions.projects.locations.functions.generateUploadUrl" + ] }, - "generateDownloadUrl": { - "response": { - "$ref": "GenerateDownloadUrlResponse" - }, + "get": { + "description": "Returns a function with the given name from the requested project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}", + "httpMethod": "GET", + "id": "cloudfunctions.projects.locations.functions.get", "parameterOrder": [ "name" ], - "httpMethod": "POST", + "parameters": { + "name": { + "description": "The name of the function which details should be obtained.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+name}", + "response": { + "$ref": "CloudFunction" + }, "scopes": [ "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "list": { + "description": "Returns a list of functions that belong to the requested project.", + "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions", + "httpMethod": "GET", + "id": "cloudfunctions.projects.locations.functions.list", + "parameterOrder": [ + "parent" + ], + "parameters": { + "pageSize": { + "description": "Maximum number of functions to return per call.", + "format": "int32", + "location": "query", + "type": "integer" + }, + "pageToken": { + "description": "The value returned by the last\n`ListFunctionsResponse`; indicates that\nthis is a continuation of a prior `ListFunctions` call, and that the\nsystem should return the next page of data.", + "location": "query", + "type": "string" + }, + "parent": { + "description": "The project and location from which the function should be listed,\nspecified in the format `projects/*/locations/*`\nIf you want to list functions in all locations, use \"-\" in place of a\nlocation.", + "location": "path", + "pattern": "^projects/[^/]+/locations/[^/]+$", + "required": true, + "type": "string" + } + }, + "path": "v1/{+parent}/functions", + "response": { + "$ref": "ListFunctionsResponse" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] + }, + "patch": { + "description": "Updates existing function.", + "flatPath": "v1/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\nglobally and match pattern `projects/*/locations/*/functions/*`", "location": "path", - "description": "The name of function for which source code Google Cloud Storage signed\nURL should be generated.", + "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$", "required": true, - "type": "string", - "pattern": "^projects/[^/]+/locations/[^/]+/functions/[^/]+$" + "type": "string" + }, + "updateMask": { + "description": "Required list of fields to be updated in this request.", + "format": "google-fieldmask", + "location": "query", + "type": "string" } }, - "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions/{functionsId}:generateDownloadUrl", - "path": "v1/{+name}:generateDownloadUrl", - "id": "cloudfunctions.projects.locations.functions.generateDownloadUrl", - "description": "Returns a signed URL for downloading deployed function source code.\nThe URL is only valid for a limited period and should be used within\nminutes after generation.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls", + "path": "v1/{+name}", "request": { - "$ref": "GenerateDownloadUrlRequest" - } + "$ref": "CloudFunction" + }, + "response": { + "$ref": "Operation" + }, + "scopes": [ + "https://www.googleapis.com/auth/cloud-platform" + ] } } } @@ -376,216 +458,113 @@ } } }, - "parameters": { - "upload_protocol": { - "type": "string", - "location": "query", - "description": "Upload protocol for media (e.g. \"raw\", \"multipart\")." - }, - "prettyPrint": { - "type": "boolean", - "default": "true", - "location": "query", - "description": "Returns response with indentations and line breaks." - }, - "fields": { - "type": "string", - "location": "query", - "description": "Selector specifying which fields to include in a partial response." - }, - "uploadType": { - "type": "string", - "location": "query", - "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\")." - }, - "$.xgafv": { - "location": "query", - "enum": [ - "1", - "2" - ], - "description": "V1 error format.", - "type": "string", - "enumDescriptions": [ - "v1 error format", - "v2 error format" - ] - }, - "callback": { - "type": "string", - "location": "query", - "description": "JSONP" - }, - "alt": { - "enum": [ - "json", - "media", - "proto" - ], - "type": "string", - "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", - "description": "Data format for response.", - "default": "json" - }, - "access_token": { - "type": "string", - "location": "query", - "description": "OAuth access token." - }, - "key": { - "location": "query", - "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.", - "type": "string" - }, - "quotaUser": { - "type": "string", - "location": "query", - "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." - }, - "pp": { - "type": "boolean", - "default": "true", - "location": "query", - "description": "Pretty-print response." - }, - "oauth_token": { - "type": "string", - "location": "query", - "description": "OAuth 2.0 token for the current user." - }, - "bearer_token": { - "type": "string", - "location": "query", - "description": "OAuth bearer token." - } - }, - "version": "v1", - "baseUrl": "https://cloudfunctions.googleapis.com/", - "servicePath": "", - "description": "API for managing lightweight user-provided functions executed in response to events.", - "kind": "discovery#restDescription", - "basePath": "", - "documentationLink": "https://cloud.google.com/functions", - "id": "cloudfunctions:v1", - "revision": "20171206", - "discoveryVersion": "v1", - "version_module": true, + "revision": "20180702", + "rootUrl": "https://cloudfunctions.googleapis.com/", "schemas": { - "OperationMetadataV1Beta2": { - "description": "Metadata describing an Operation", - "type": "object", + "CallFunctionRequest": { + "description": "Request for the `CallFunction` method.", + "id": "CallFunctionRequest", "properties": { - "type": { - "enum": [ - "OPERATION_UNSPECIFIED", - "CREATE_FUNCTION", - "UPDATE_FUNCTION", - "DELETE_FUNCTION" - ], - "description": "Type of operation.", - "type": "string", - "enumDescriptions": [ - "Unknown operation type.", - "Triggered by CreateFunction call", - "Triggered by UpdateFunction call", - "Triggered by DeleteFunction call." - ] - }, - "updateTime": { - "type": "string", - "description": "The last update timestamp of the operation.", - "format": "google-datetime" - }, - "target": { - "type": "string", - "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1" - }, - "request": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - }, - "description": "The original request that started the operation.", - "type": "object" - }, - "versionId": { - "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", - "format": "int64", + "data": { + "description": "Input to be passed to the function.", "type": "string" } }, - "id": "OperationMetadataV1Beta2" + "type": "object" }, - "Status": { - "type": "object", + "CallFunctionResponse": { + "description": "Response of `CallFunction` method.", + "id": "CallFunctionResponse", "properties": { - "code": { - "description": "The status code, which should be an enum value of google.rpc.Code.", + "error": { + "description": "Either system or user-function generated error. Set if execution\nwas not successful.", + "type": "string" + }, + "executionId": { + "description": "Execution id of function invocation.", + "type": "string" + }, + "result": { + "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.", + "type": "string" + } + }, + "type": "object" + }, + "CloudFunction": { + "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.", + "id": "CloudFunction", + "properties": { + "availableMemoryMb": { + "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.", "format": "int32", "type": "integer" }, - "message": { - "description": "A developer-facing error message, which should be in English. Any\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "description": { + "description": "User-provided description of a function.", "type": "string" }, - "details": { - "type": "array", - "items": { - "additionalProperties": { - "type": "any", - "description": "Properties of the object. Contains field @type with type URL." - }, - "type": "object" - }, - "description": "A list of messages that carry the error details. There is a common set of\nmessage types for APIs to use." - } - }, - "id": "Status", - "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons." - }, - "CallFunctionRequest": { - "type": "object", - "properties": { - "data": { - "type": "string", - "description": "Input to be passed to the function." - } - }, - "id": "CallFunctionRequest", - "description": "Request for the `CallFunction` method." - }, - "SourceRepository": { - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory." + "entryPoint": { + "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`.", + "type": "string" }, - "deployedUrl": { - "type": "string", - "description": "Output only. The URL pointing to the hosted repository where the function\nwere defined at the time of deployment. It always points to a specific\ncommit in the format described above." - } - }, - "id": "SourceRepository", - "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted." - }, - "CloudFunction": { - "type": "object", - "properties": { - "sourceUploadUrl": { - "type": "string", - "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl" + "environmentVariables": { + "additionalProperties": { + "type": "string" + }, + "description": "**Beta Feature**\n\nEnvironment variables that shall be available during function execution.", + "type": "object" }, "eventTrigger": { "$ref": "EventTrigger", "description": "A source that fires events in response to a condition in another service." }, + "httpsTrigger": { + "$ref": "HttpsTrigger", + "description": "An HTTPS endpoint type of source that can be triggered via URL." + }, + "labels": { + "additionalProperties": { + "type": "string" + }, + "description": "Labels associated with this Cloud Function.", + "type": "object" + }, + "maxInstances": { + "description": "The limit on the maximum number of function instances that may coexist at a\ngiven time. This feature is currently in alpha, available only for\nwhitelisted users.", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`", + "type": "string" + }, + "network": { + "description": "The VPC Network that this cloud function can connect to. It can be\neither the fully-qualified URI, or the short name of the network resource.\nIf the short network name is used, the network must belong to the same\nproject. Otherwise, it must belong to a project within the same\norganization. The format of this field is either\n`projects/{project}/global/networks/{network}` or `{network}`, where\n{project} is a project id where the network is defined, and {network} is\nthe short name of the network.\n\nSee [the VPC documentation](https://cloud.google.com/compute/docs/vpc) for\nmore information on connecting Cloud projects.\n\nThis feature is currently in alpha, available only for whitelisted users.", + "type": "string" + }, + "runtime": { + "description": "The runtime in which the function is going to run. If empty, defaults to\nNode.js 6.", + "type": "string" + }, + "serviceAccountEmail": { + "description": "Output only. The email of the function's service account.", + "type": "string" + }, + "sourceArchiveUrl": { + "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.", + "type": "string" + }, + "sourceRepository": { + "$ref": "SourceRepository", + "description": "**Beta Feature**\n\nThe source repository where a function is hosted." + }, + "sourceUploadUrl": { + "description": "The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1.GenerateUploadUrl", + "type": "string" + }, "status": { + "description": "Output only. Status of the function deployment.", "enum": [ "CLOUD_FUNCTION_STATUS_UNSPECIFIED", "ACTIVE", @@ -594,8 +573,6 @@ "DELETE_IN_PROGRESS", "UNKNOWN" ], - "description": "Output only. Status of the function deployment.", - "type": "string", "enumDescriptions": [ "Not specified. Invalid state.", "Function has been succesfully deployed and is serving.", @@ -603,251 +580,239 @@ "Function is being created or updated.", "Function is being deleted.", "Function deployment failed and the function serving state is undefined.\nThe function should be updated or deleted to move it out of this state." - ] + ], + "type": "string" }, "timeout": { - "type": "string", "description": "The function execution timeout. Execution is considered failed and\ncan be terminated if the function is not completed at the end of the\ntimeout period. Defaults to 60 seconds.", - "format": "google-duration" + "format": "google-duration", + "type": "string" }, - "availableMemoryMb": { - "description": "The amount of memory in MB available for a function.\nDefaults to 256MB.", - "format": "int32", - "type": "integer" - }, - "name": { - "description": "A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`", + "updateTime": { + "description": "Output only. The last update timestamp of a Cloud Function.", + "format": "google-datetime", "type": "string" }, "versionId": { - "type": "string", "description": "Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created.", - "format": "int64" - }, - "sourceArchiveUrl": { - "type": "string", - "description": "The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function." - }, - "sourceRepository": { - "$ref": "SourceRepository", - "description": "**Beta Feature**\n\nThe source repository where a function is hosted." - }, - "entryPoint": { - "type": "string", - "description": "The name of the function (as defined in source code) that will be\nexecuted. Defaults to the resource name suffix, if not specified. For\nbackward compatibility, if function with given name is not found, then the\nsystem will try to use function named \"function\".\nFor Node.js this is name of a function exported by the module specified\nin `source_location`." - }, - "labels": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "description": "Labels associated with this Cloud Function." - }, - "updateTime": { - "type": "string", - "description": "Output only. The last update timestamp of a Cloud Function.", - "format": "google-datetime" - }, - "httpsTrigger": { - "$ref": "HttpsTrigger", - "description": "An HTTPS endpoint type of source that can be triggered via URL." - }, - "serviceAccountEmail": { - "type": "string", - "description": "Output only. The email of the function's service account." - }, - "description": { - "type": "string", - "description": "User-provided description of a function." + "format": "int64", + "type": "string" } }, - "id": "CloudFunction", - "description": "Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations." + "type": "object" + }, + "EventTrigger": { + "description": "Describes EventTrigger, used to request events be sent from another\nservice.", + "id": "EventTrigger", + "properties": { + "eventType": { + "description": "Required. The type of event to observe. For example:\n`providers/cloud.storage/eventTypes/object.change` and\n`providers/cloud.pubsub/eventTypes/topic.publish`.\n\nEvent types match pattern `providers/*/eventTypes/*.*`.\nThe pattern contains:\n\n1. namespace: For example, `cloud.storage` and\n `google.firebase.analytics`.\n2. resource type: The type of resource on which event occurs. For\n example, the Google Cloud Storage API includes the type `object`.\n3. action: The action that generates the event. For example, action for\n a Google Cloud Storage Object is 'change'.\nThese parts are lower case.", + "type": "string" + }, + "failurePolicy": { + "$ref": "FailurePolicy", + "description": "Specifies policy for failed executions." + }, + "resource": { + "description": "Required. The resource(s) from which to observe events, for example,\n`projects/_/buckets/myBucket`.\n\nNot all syntactically correct values are accepted by all services. For\nexample:\n\n1. The authorization model must support it. Google Cloud Functions\n only allows EventTriggers to be deployed that observe resources in the\n same project as the `CloudFunction`.\n2. The resource type must match the pattern expected for an\n `event_type`. For example, an `EventTrigger` that has an\n `event_type` of \"google.pubsub.topic.publish\" should have a resource\n that matches Google Cloud Pub/Sub topics.\n\nAdditionally, some services may support short names when creating an\n`EventTrigger`. These will always be returned in the normalized \"long\"\nformat.\n\nSee each *service's* documentation for supported formats.", + "type": "string" + }, + "service": { + "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace.", + "type": "string" + } + }, + "type": "object" + }, + "FailurePolicy": { + "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).", + "id": "FailurePolicy", + "properties": { + "retry": { + "$ref": "Retry", + "description": "If specified, then the function will be retried in case of a failure." + } + }, + "type": "object" + }, + "GenerateDownloadUrlRequest": { + "description": "Request of `GenerateDownloadUrl` method.", + "id": "GenerateDownloadUrlRequest", + "properties": { + "versionId": { + "description": "The optional version of function. If not set, default, current version\nis used.", + "format": "uint64", + "type": "string" + } + }, + "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\nfunction source code download.", + "type": "string" + } + }, + "type": "object" + }, + "GenerateUploadUrlRequest": { + "description": "Request of `GenerateSourceUploadUrl` method.", + "id": "GenerateUploadUrlRequest", + "properties": {}, + "type": "object" + }, + "GenerateUploadUrlResponse": { + "description": "Response of `GenerateSourceUploadUrl` method.", + "id": "GenerateUploadUrlResponse", + "properties": { + "uploadUrl": { + "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function.", + "type": "string" + } + }, + "type": "object" }, "HttpsTrigger": { "description": "Describes HttpsTrigger, could be used to connect web hooks to function.", - "type": "object", + "id": "HttpsTrigger", "properties": { "url": { "description": "Output only. The deployed url for the function.", "type": "string" } }, - "id": "HttpsTrigger" + "type": "object" + }, + "ListFunctionsResponse": { + "description": "Response for the `ListFunctions` method.", + "id": "ListFunctionsResponse", + "properties": { + "functions": { + "description": "The functions that match the request.", + "items": { + "$ref": "CloudFunction" + }, + "type": "array" + }, + "nextPageToken": { + "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1.ListFunctionsRequest\nto get more functions.", + "type": "string" + } + }, + "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" + } + }, + "type": "object" }, "Location": { "description": "A resource that represents Google Cloud Platform location.", - "type": "object", + "id": "Location", "properties": { - "name": { - "type": "string", - "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`" - }, - "locationId": { - "description": "The canonical id for this location. For example: `\"us-east1\"`.", + "displayName": { + "description": "The friendly name for this location, typically a nearby city name.\nFor example, \"Tokyo\".", "type": "string" }, - "metadata": { - "type": "object", - "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\nlocation." - }, "labels": { "additionalProperties": { "type": "string" }, "description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}", "type": "object" - } - }, - "id": "Location" - }, - "GenerateDownloadUrlResponse": { - "description": "Response of `GenerateDownloadUrl` method.", - "type": "object", - "properties": { - "downloadUrl": { - "description": "The generated Google Cloud Storage signed URL that should be used for\nfunction source code download.", - "type": "string" - } - }, - "id": "GenerateDownloadUrlResponse" - }, - "Retry": { - "type": "object", - "properties": {}, - "id": "Retry", - "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution." - }, - "GenerateUploadUrlRequest": { - "type": "object", - "properties": {}, - "id": "GenerateUploadUrlRequest", - "description": "Request of `GenerateSourceUploadUrl` method." - }, - "ListOperationsResponse": { - "type": "object", - "properties": { - "operations": { - "description": "A list of operations that matches the specified filter in the request.", - "type": "array", - "items": { - "$ref": "Operation" - } }, - "nextPageToken": { - "type": "string", - "description": "The standard List next-page token." - } - }, - "id": "ListOperationsResponse", - "description": "The response message for Operations.ListOperations." - }, - "GenerateUploadUrlResponse": { - "type": "object", - "properties": { - "uploadUrl": { - "type": "string", - "description": "The generated Google Cloud Storage signed URL that should be used for a\nfunction source code upload. The uploaded file should be a zip archive\nwhich contains a function." - } - }, - "id": "GenerateUploadUrlResponse", - "description": "Response of `GenerateSourceUploadUrl` method." - }, - "ListFunctionsResponse": { - "type": "object", - "properties": { - "nextPageToken": { - "description": "If not empty, indicates that there may be more functions that match\nthe request; this value should be passed in a new\ngoogle.cloud.functions.v1.ListFunctionsRequest\nto get more functions.", + "locationId": { + "description": "The canonical id for this location. For example: `\"us-east1\"`.", "type": "string" }, - "functions": { - "type": "array", - "items": { - "$ref": "CloudFunction" + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" }, - "description": "The functions that match the request." + "description": "Service-specific metadata. For example the available capacity at the given\nlocation.", + "type": "object" + }, + "name": { + "description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`", + "type": "string" } }, - "id": "ListFunctionsResponse", - "description": "Response for the `ListFunctions` method." + "type": "object" }, - "CallFunctionResponse": { - "description": "Response of `CallFunction` method.", - "type": "object", + "Operation": { + "description": "This resource represents a long-running operation that is the result of a\nnetwork API call.", + "id": "Operation", "properties": { - "executionId": { - "description": "Execution id of function invocation.", - "type": "string" - }, - "result": { - "description": "Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.", - "type": "string" + "done": { + "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable.", + "type": "boolean" }, "error": { - "description": "Either system or user-function generated error. Set if execution\nwas not successful.", - "type": "string" - } - }, - "id": "CallFunctionResponse" - }, - "ListLocationsResponse": { - "type": "object", - "properties": { - "nextPageToken": { - "type": "string", - "description": "The standard List next-page token." + "$ref": "Status", + "description": "The error result of the operation in case of failure or cancellation." }, - "locations": { - "type": "array", - "items": { - "$ref": "Location" + "metadata": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" }, - "description": "A list of locations that matches the specified filter in the request." - } - }, - "id": "ListLocationsResponse", - "description": "The response message for Locations.ListLocations." - }, - "EventTrigger": { - "description": "Describes EventTrigger, used to request events be sent from another\nservice.", - "type": "object", - "properties": { - "eventType": { - "type": "string", - "description": "Required. The type of event to observe. For example:\n`providers/cloud.storage/eventTypes/object.change` and\n`providers/cloud.pubsub/eventTypes/topic.publish`.\n\nEvent types match pattern `providers/*/eventTypes/*.*`.\nThe pattern contains:\n 1. namespace: For example, `cloud.storage` and\n `google.firebase.analytics`.\n 2. resource type: The type of resource on which event occurs. For\n example, the Google Cloud Storage API includes the type `object`.\n 3. action: The action that generates the event. For example, action for\n a Google Cloud Storage Object is 'change'.\nThese parts are lower case." + "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any.", + "type": "object" }, - "resource": { - "description": "Required. The resource(s) from which to observe events, for example,\n`projects/_/buckets/myBucket`.\n\nNot all syntactically correct values are accepted by all services. For\nexample:\n\n1. The authorization model must support it. Google Cloud Functions\n only allows EventTriggers to be deployed that observe resources in the\n same project as the `CloudFunction`.\n2. The resource type must match the pattern expected for an\n `event_type`. For example, an `EventTrigger` that has an\n `event_type` of \"google.pubsub.topic.publish\" should have a resource\n that matches Google Cloud Pub/Sub topics.\n\nAdditionally, some services may support short names when creating an\n`EventTrigger`. These will always be returned in the normalized \"long\"\nformat.\n\nSee each *service's* documentation for supported formats.", + "name": { + "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", "type": "string" }, - "service": { - "type": "string", - "description": "The hostname of the service that should be observed.\n\nIf no string is provided, the default service implementing the API will\nbe used. For example, `storage.googleapis.com` is the default for all\nevent types in the `google.storage` namespace." - }, - "failurePolicy": { - "$ref": "FailurePolicy", - "description": "Specifies policy for failed executions." + "response": { + "additionalProperties": { + "description": "Properties of the object. Contains field @type with type URL.", + "type": "any" + }, + "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`.", + "type": "object" } }, - "id": "EventTrigger" + "type": "object" }, "OperationMetadataV1": { "description": "Metadata describing an Operation", - "type": "object", + "id": "OperationMetadataV1", "properties": { - "updateTime": { - "description": "The last update timestamp of the operation.", - "format": "google-datetime", - "type": "string" - }, - "target": { - "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1", - "type": "string" - }, "request": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", @@ -856,87 +821,135 @@ "description": "The original request that started the operation.", "type": "object" }, - "versionId": { - "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", - "format": "int64", + "target": { + "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1", "type": "string" }, "type": { - "type": "string", - "enumDescriptions": [ - "Unknown operation type.", - "Triggered by CreateFunction call", - "Triggered by UpdateFunction call", - "Triggered by DeleteFunction call." - ], + "description": "Type of operation.", "enum": [ "OPERATION_UNSPECIFIED", "CREATE_FUNCTION", "UPDATE_FUNCTION", "DELETE_FUNCTION" ], - "description": "Type of operation." - } - }, - "id": "OperationMetadataV1" - }, - "GenerateDownloadUrlRequest": { - "type": "object", - "properties": { + "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": "The optional version of function. If not set, default, current version\nis used.", - "format": "uint64", + "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", + "format": "int64", "type": "string" } }, - "id": "GenerateDownloadUrlRequest", - "description": "Request of `GenerateDownloadUrl` method." + "type": "object" }, - "FailurePolicy": { - "description": "Describes the policy in case of function's execution failure.\nIf empty, then defaults to ignoring failures (i.e. not retrying them).", - "type": "object", + "OperationMetadataV1Beta2": { + "description": "Metadata describing an Operation", + "id": "OperationMetadataV1Beta2", "properties": { - "retry": { - "$ref": "Retry", - "description": "If specified, then the function will be retried in case of a failure." - } - }, - "id": "FailurePolicy" - }, - "Operation": { - "type": "object", - "properties": { - "response": { - "type": "object", + "request": { "additionalProperties": { "description": "Properties of the object. Contains field @type with type URL.", "type": "any" }, - "description": "The normal response of the operation in case of success. If the original\nmethod returns no data on success, such as `Delete`, the response is\n`google.protobuf.Empty`. If the original method is standard\n`Get`/`Create`/`Update`, the response should be the resource. For other\nmethods, the response should have the type `XxxResponse`, where `Xxx`\nis the original method name. For example, if the original method name\nis `TakeSnapshot()`, the inferred response type is\n`TakeSnapshotResponse`." + "description": "The original request that started the operation.", + "type": "object" }, - "name": { - "description": "The server-assigned name, which is only unique within the same service that\noriginally returns it. If you use the default HTTP mapping, the\n`name` should have the format of `operations/some/unique/name`.", + "target": { + "description": "Target of the operation - for example\nprojects/project-1/locations/region-1/functions/function-1", "type": "string" }, - "error": { - "$ref": "Status", - "description": "The error result of the operation in case of failure or cancellation." + "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" }, - "metadata": { - "type": "object", - "additionalProperties": { - "description": "Properties of the object. Contains field @type with type URL.", - "type": "any" - }, - "description": "Service-specific metadata associated with the operation. It typically\ncontains progress information and common metadata such as create time.\nSome services might not provide such metadata. Any method that returns a\nlong-running operation should document the metadata type, if any." + "updateTime": { + "description": "The last update timestamp of the operation.", + "format": "google-datetime", + "type": "string" }, - "done": { - "type": "boolean", - "description": "If the value is `false`, it means the operation is still in progress.\nIf `true`, the operation is completed, and either `error` or `response` is\navailable." + "versionId": { + "description": "Version id of the function created or updated by an API call.\nThis field is only pupulated for Create and Update operations.", + "format": "int64", + "type": "string" } }, - "id": "Operation", - "description": "This resource represents a long-running operation that is the result of a\nnetwork API call." + "type": "object" + }, + "Retry": { + "description": "Describes the retry policy in case of function's execution failure.\nA function execution will be retried on any failure.\nA failed execution will be retried up to 7 days with an exponential backoff\n(capped at 10 seconds).\nRetried execution is charged as any other execution.", + "id": "Retry", + "properties": {}, + "type": "object" + }, + "SourceRepository": { + "description": "Describes SourceRepository, used to represent parameters related to\nsource repository where a function is hosted.", + "id": "SourceRepository", + "properties": { + "deployedUrl": { + "description": "Output only. The URL pointing to the hosted repository where the function\nwere defined at the time of deployment. It always points to a specific\ncommit in the format described above.", + "type": "string" + }, + "url": { + "description": "The URL pointing to the hosted repository where the function is defined.\nThere are supported Cloud Source Repository URLs in the following\nformats:\n\nTo refer to a specific commit:\n`https://source.developers.google.com/projects/*/repos/*/revisions/*/paths/*`\nTo refer to a moveable alias (branch):\n`https://source.developers.google.com/projects/*/repos/*/moveable-aliases/*/paths/*`\nIn particular, to refer to HEAD use `master` moveable alias.\nTo refer to a specific fixed alias (tag):\n`https://source.developers.google.com/projects/*/repos/*/fixed-aliases/*/paths/*`\n\nYou may omit `paths/*` if you want to use the main directory.", + "type": "string" + } + }, + "type": "object" + }, + "Status": { + "description": "The `Status` type defines a logical error model that is suitable for different\nprogramming environments, including REST APIs and RPC APIs. It is used by\n[gRPC](https://github.com/grpc). The error model is designed to be:\n\n- Simple to use and understand for most users\n- Flexible enough to meet unexpected needs\n\n# Overview\n\nThe `Status` message contains three pieces of data: error code, error message,\nand error details. The error code should be an enum value of\ngoogle.rpc.Code, but it may accept additional error codes if needed. The\nerror message should be a developer-facing English message that helps\ndevelopers *understand* and *resolve* the error. If a localized user-facing\nerror message is needed, put the localized message in the error details or\nlocalize it in the client. The optional error details may contain arbitrary\ninformation about the error. There is a predefined set of error detail types\nin the package `google.rpc` that can be used for common error conditions.\n\n# Language mapping\n\nThe `Status` message is the logical representation of the error model, but it\nis not necessarily the actual wire format. When the `Status` message is\nexposed in different client libraries and different wire protocols, it can be\nmapped differently. For example, it will likely be mapped to some exceptions\nin Java, but more likely mapped to some error codes in C.\n\n# Other uses\n\nThe error model and the `Status` message can be used in a variety of\nenvironments, either with or without APIs, to provide a\nconsistent developer experience across different environments.\n\nExample uses of this error model include:\n\n- Partial errors. If a service needs to return partial errors to the client,\n it may embed the `Status` in the normal response to indicate the partial\n errors.\n\n- Workflow errors. A typical workflow has multiple steps. Each step may\n have a `Status` message for error reporting.\n\n- Batch operations. If a client uses batch request and batch response, the\n `Status` message should be used directly inside batch response, one for\n each error sub-response.\n\n- Asynchronous operations. If an API call embeds asynchronous operation\n results in its response, the status of those operations should be\n represented directly using the `Status` message.\n\n- Logging. If some API errors are stored in logs, the message `Status` could\n be used directly after any stripping needed for security/privacy reasons.", + "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\nmessage 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\nuser-facing error message should be localized and sent in the\ngoogle.rpc.Status.details field, or localized by the client.", + "type": "string" + } + }, + "type": "object" } - } -} + }, + "servicePath": "", + "title": "Cloud Functions API", + "version": "v1", + "version_module": true +} \ No newline at end of file diff --git a/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-gen.go b/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-gen.go index 4e1f95e6..9b546a68 100644 --- a/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-gen.go +++ b/vendor/google.golang.org/api/cloudfunctions/v1/cloudfunctions-gen.go @@ -1,4 +1,4 @@ -// Package cloudfunctions provides access to the Google Cloud Functions API. +// Package cloudfunctions provides access to the Cloud Functions API. // // See https://cloud.google.com/functions // @@ -216,6 +216,12 @@ type CloudFunction struct { // in `source_location`. EntryPoint string `json:"entryPoint,omitempty"` + // EnvironmentVariables: **Beta Feature** + // + // Environment variables that shall be available during function + // execution. + EnvironmentVariables map[string]string `json:"environmentVariables,omitempty"` + // EventTrigger: A source that fires events in response to a condition // in another service. EventTrigger *EventTrigger `json:"eventTrigger,omitempty"` @@ -227,11 +233,47 @@ type CloudFunction struct { // Labels: Labels associated with this Cloud Function. Labels map[string]string `json:"labels,omitempty"` + // MaxInstances: The limit on the maximum number of function instances + // that may coexist at a + // given time. This feature is currently in alpha, available only + // for + // whitelisted users. + MaxInstances int64 `json:"maxInstances,omitempty"` + // Name: A user-defined name of the function. Function names must be // unique // globally and match pattern `projects/*/locations/*/functions/*` Name string `json:"name,omitempty"` + // Network: The VPC Network that this cloud function can connect to. It + // can be + // either the fully-qualified URI, or the short name of the network + // resource. + // If the short network name is used, the network must belong to the + // same + // project. Otherwise, it must belong to a project within the + // same + // organization. The format of this field is + // either + // `projects/{project}/global/networks/{network}` or `{network}`, + // where + // {project} is a project id where the network is defined, and {network} + // is + // the short name of the network. + // + // See [the VPC + // documentation](https://cloud.google.com/compute/docs/vpc) for + // more information on connecting Cloud projects. + // + // This feature is currently in alpha, available only for whitelisted + // users. + Network string `json:"network,omitempty"` + + // Runtime: The runtime in which the function is going to run. If empty, + // defaults to + // Node.js 6. + Runtime string `json:"runtime,omitempty"` + // ServiceAccountEmail: Output only. The email of the function's service // account. ServiceAccountEmail string `json:"serviceAccountEmail,omitempty"` @@ -323,14 +365,15 @@ type EventTrigger struct { // // Event types match pattern `providers/*/eventTypes/*.*`. // The pattern contains: - // 1. namespace: For example, `cloud.storage` and - // `google.firebase.analytics`. - // 2. resource type: The type of resource on which event occurs. For - // example, the Google Cloud Storage API includes the type + // + // 1. namespace: For example, `cloud.storage` and + // `google.firebase.analytics`. + // 2. resource type: The type of resource on which event occurs. For + // example, the Google Cloud Storage API includes the type // `object`. - // 3. action: The action that generates the event. For example, action + // 3. action: The action that generates the event. For example, action // for - // a Google Cloud Storage Object is 'change'. + // a Google Cloud Storage Object is 'change'. // These parts are lower case. EventType string `json:"eventType,omitempty"` @@ -680,6 +723,11 @@ func (s *ListOperationsResponse) MarshalJSON() ([]byte, error) { // Location: A resource that represents Google Cloud Platform location. type Location struct { + // DisplayName: The friendly name for this location, typically a nearby + // city name. + // For example, "Tokyo". + DisplayName string `json:"displayName,omitempty"` + // Labels: Cross-service attributes for the location. For example // // {"cloud.googleapis.com/region": "us-east1"} @@ -699,7 +747,7 @@ type Location struct { // For example: "projects/example-project/locations/us-east1" Name string `json:"name,omitempty"` - // ForceSendFields is a list of field names (e.g. "Labels") to + // ForceSendFields is a list of field names (e.g. "DisplayName") to // unconditionally include in API requests. By default, fields with // empty values are omitted from API requests. However, any non-pointer, // non-interface field appearing in ForceSendFields will be sent to the @@ -707,10 +755,10 @@ type Location struct { // used to include empty fields in Patch requests. ForceSendFields []string `json:"-"` - // NullFields is a list of field names (e.g. "Labels") to include in API - // requests with the JSON null value. By default, fields with empty - // values are omitted from API requests. However, any field with an - // empty value appearing in NullFields will be sent to the server as + // NullFields is a list of field names (e.g. "DisplayName") to include + // in API requests with the JSON null value. By default, fields with + // empty values are omitted from API requests. However, any field with + // an empty value appearing in NullFields will be sent to the server as // null. It is an error if a field in this list has a non-empty value. // This may be used to include null fields in Patch requests. NullFields []string `json:"-"` @@ -2197,11 +2245,24 @@ type ProjectsLocationsFunctionsGenerateUploadUrlCall struct { // source code. // For more information about the signed URL usage // see: -// https://cloud.google.com/storage/docs/access-control/signed-urls +// https://cloud.google.com/storage/docs/access-control/signed-urls. // // Once the function source code upload is complete, the used signed // URL should be provided in CreateFunction or UpdateFunction request // as a reference to the function source code. +// +// When uploading source code to the generated signed URL, please +// follow +// these restrictions: +// +// * Source file type should be a zip file. +// * Source file size should not exceed 100MB limit. +// +// When making a HTTP PUT request, these two headers need to be +// specified: +// +// * `content-type: application/zip` +// * `x-goog-content-length-range: 0,104857600` func (r *ProjectsLocationsFunctionsService) GenerateUploadUrl(parent string, generateuploadurlrequest *GenerateUploadUrlRequest) *ProjectsLocationsFunctionsGenerateUploadUrlCall { c := &ProjectsLocationsFunctionsGenerateUploadUrlCall{s: r.s, urlParams_: make(gensupport.URLParams)} c.parent = parent @@ -2295,7 +2356,7 @@ func (c *ProjectsLocationsFunctionsGenerateUploadUrlCall) Do(opts ...googleapi.C } return ret, nil // { - // "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.", + // "description": "Returns a signed URL for uploading a function source code.\nFor more information about the signed URL usage see:\nhttps://cloud.google.com/storage/docs/access-control/signed-urls.\nOnce the function source code upload is complete, the used signed\nURL should be provided in CreateFunction or UpdateFunction request\nas a reference to the function source code.\n\nWhen uploading source code to the generated signed URL, please follow\nthese restrictions:\n\n* Source file type should be a zip file.\n* Source file size should not exceed 100MB limit.\n\nWhen making a HTTP PUT request, these two headers need to be specified:\n\n* `content-type: application/zip`\n* `x-goog-content-length-range: 0,104857600`", // "flatPath": "v1/projects/{projectsId}/locations/{locationsId}/functions:generateUploadUrl", // "httpMethod": "POST", // "id": "cloudfunctions.projects.locations.functions.generateUploadUrl", @@ -2304,7 +2365,7 @@ func (c *ProjectsLocationsFunctionsGenerateUploadUrlCall) Do(opts ...googleapi.C // ], // "parameters": { // "parent": { - // "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*", + // "description": "The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*`.", // "location": "path", // "pattern": "^projects/[^/]+/locations/[^/]+$", // "required": true, diff --git a/vendor/vendor.json b/vendor/vendor.json index f9328fdf..8c3fd73c 100644 --- a/vendor/vendor.json +++ b/vendor/vendor.json @@ -1262,10 +1262,10 @@ "revisionTime": "2018-04-19T00:06:09Z" }, { - "checksumSHA1": "M6qPoWx14U0JlqP2c/Mvx9fYmDo=", + "checksumSHA1": "M4KP9cR8pFbyJyG15Dbl2JRAgGw=", "path": "google.golang.org/api/cloudfunctions/v1", - "revision": "f4694fe510ef1f58a08157aa15e795ffea4d4766", - "revisionTime": "2017-12-15T00:04:04Z" + "revision": "31ca0e01cd791f07750cb23fc99327721f753290", + "revisionTime": "2018-07-30T00:09:01Z" }, { "checksumSHA1": "uLifIDdJHnoBlTG0G4T6DGSB9l4=", diff --git a/website/docs/r/cloudfunctions_function.html.markdown b/website/docs/r/cloudfunctions_function.html.markdown index 0eb75107..014fdf2f 100644 --- a/website/docs/r/cloudfunctions_function.html.markdown +++ b/website/docs/r/cloudfunctions_function.html.markdown @@ -38,6 +38,9 @@ resource "google_cloudfunctions_function" "function" { labels { my-label = "my-label-value" } + environment_variables { + MY_ENV_VAR = "my-env-var-value" + } } ``` @@ -69,6 +72,8 @@ The following arguments are supported: * `labels` - (Optional) A set of key/value label pairs to assign to the function. +* `environment_variables` - (Optional) A set of key/value environment variable pairs to assign to the function. + * `retry_on_failure` - (Optional) Whether the function should be retried on failure. This only applies to bucket and topic triggers, not HTTPS triggers. ## Attributes Reference