@google-cloud/functions

{ "options": { "syntax": "proto3" }, "nested": { "google": { "nested": { "cloud": { "nested": { "functions": { "nested": { "v1": { "options": { "go_package": "cloud.google.com/go/functions/apiv1/functionspb;functionspb", "java_multiple_files": true, "java_outer_classname": "FunctionsOperationsProto", "java_package": "com.google.cloud.functions.v1", "objc_class_prefix": "GCF", "(google.api.resource_definition).type": "cloudkms.googleapis.com/CryptoKey", "(google.api.resource_definition).pattern": "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}" }, "nested": { "CloudFunctionsService": { "options": { "(google.api.default_host)": "cloudfunctions.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "ListFunctions": { "requestType": "ListFunctionsRequest", "responseType": "ListFunctionsResponse", "options": { "(google.api.http).get": "/v1/{parent=projects/*/locations/*}/functions" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{parent=projects/*/locations/*}/functions" } } ] }, "GetFunction": { "requestType": "GetFunctionRequest", "responseType": "CloudFunction", "options": { "(google.api.http).get": "/v1/{name=projects/*/locations/*/functions/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{name=projects/*/locations/*/functions/*}" } }, { "(google.api.method_signature)": "name" } ] }, "CreateFunction": { "requestType": "CreateFunctionRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).post": "/v1/{location=projects/*/locations/*}/functions", "(google.api.http).body": "function", "(google.api.method_signature)": "location,function", "(google.longrunning.operation_info).response_type": "CloudFunction", "(google.longrunning.operation_info).metadata_type": "OperationMetadataV1" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{location=projects/*/locations/*}/functions", "body": "function" } }, { "(google.api.method_signature)": "location,function" }, { "(google.longrunning.operation_info)": { "response_type": "CloudFunction", "metadata_type": "OperationMetadataV1" } } ] }, "UpdateFunction": { "requestType": "UpdateFunctionRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).patch": "/v1/{function.name=projects/*/locations/*/functions/*}", "(google.api.http).body": "function", "(google.api.method_signature)": "function", "(google.longrunning.operation_info).response_type": "CloudFunction", "(google.longrunning.operation_info).metadata_type": "OperationMetadataV1" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v1/{function.name=projects/*/locations/*/functions/*}", "body": "function" } }, { "(google.api.method_signature)": "function" }, { "(google.longrunning.operation_info)": { "response_type": "CloudFunction", "metadata_type": "OperationMetadataV1" } } ] }, "DeleteFunction": { "requestType": "DeleteFunctionRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).delete": "/v1/{name=projects/*/locations/*/functions/*}", "(google.api.method_signature)": "name", "(google.longrunning.operation_info).response_type": "google.protobuf.Empty", "(google.longrunning.operation_info).metadata_type": "OperationMetadataV1" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v1/{name=projects/*/locations/*/functions/*}" } }, { "(google.api.method_signature)": "name" }, { "(google.longrunning.operation_info)": { "response_type": "google.protobuf.Empty", "metadata_type": "OperationMetadataV1" } } ] }, "CallFunction": { "requestType": "CallFunctionRequest", "responseType": "CallFunctionResponse", "options": { "(google.api.http).post": "/v1/{name=projects/*/locations/*/functions/*}:call", "(google.api.http).body": "*", "(google.api.method_signature)": "name,data" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{name=projects/*/locations/*/functions/*}:call", "body": "*" } }, { "(google.api.method_signature)": "name,data" } ] }, "GenerateUploadUrl": { "requestType": "GenerateUploadUrlRequest", "responseType": "GenerateUploadUrlResponse", "options": { "(google.api.http).post": "/v1/{parent=projects/*/locations/*}/functions:generateUploadUrl", "(google.api.http).body": "*" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{parent=projects/*/locations/*}/functions:generateUploadUrl", "body": "*" } } ] }, "GenerateDownloadUrl": { "requestType": "GenerateDownloadUrlRequest", "responseType": "GenerateDownloadUrlResponse", "options": { "(google.api.http).post": "/v1/{name=projects/*/locations/*/functions/*}:generateDownloadUrl", "(google.api.http).body": "*" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{name=projects/*/locations/*/functions/*}:generateDownloadUrl", "body": "*" } } ] }, "SetIamPolicy": { "requestType": "google.iam.v1.SetIamPolicyRequest", "responseType": "google.iam.v1.Policy", "options": { "(google.api.http).post": "/v1/{resource=projects/*/locations/*/functions/*}:setIamPolicy", "(google.api.http).body": "*" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{resource=projects/*/locations/*/functions/*}:setIamPolicy", "body": "*" } } ] }, "GetIamPolicy": { "requestType": "google.iam.v1.GetIamPolicyRequest", "responseType": "google.iam.v1.Policy", "options": { "(google.api.http).get": "/v1/{resource=projects/*/locations/*/functions/*}:getIamPolicy" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v1/{resource=projects/*/locations/*/functions/*}:getIamPolicy" } } ] }, "TestIamPermissions": { "requestType": "google.iam.v1.TestIamPermissionsRequest", "responseType": "google.iam.v1.TestIamPermissionsResponse", "options": { "(google.api.http).post": "/v1/{resource=projects/*/locations/*/functions/*}:testIamPermissions", "(google.api.http).body": "*" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v1/{resource=projects/*/locations/*/functions/*}:testIamPermissions", "body": "*" } } ] } } }, "CloudFunction": { "options": { "(google.api.resource).type": "cloudfunctions.googleapis.com/CloudFunction", "(google.api.resource).pattern": "projects/{project}/locations/{location}/functions/{function}" }, "oneofs": { "sourceCode": { "oneof": [ "sourceArchiveUrl", "sourceRepository", "sourceUploadUrl" ] }, "trigger": { "oneof": [ "httpsTrigger", "eventTrigger" ] }, "runtimeUpdatePolicy": { "oneof": [ "automaticUpdatePolicy", "onDeployUpdatePolicy" ] } }, "fields": { "name": { "type": "string", "id": 1 }, "description": { "type": "string", "id": 2 }, "sourceArchiveUrl": { "type": "string", "id": 3 }, "sourceRepository": { "type": "SourceRepository", "id": 4 }, "sourceUploadUrl": { "type": "string", "id": 16 }, "httpsTrigger": { "type": "HttpsTrigger", "id": 5 }, "eventTrigger": { "type": "EventTrigger", "id": 6 }, "status": { "type": "CloudFunctionStatus", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "entryPoint": { "type": "string", "id": 8 }, "runtime": { "type": "string", "id": 19 }, "timeout": { "type": "google.protobuf.Duration", "id": 9 }, "availableMemoryMb": { "type": "int32", "id": 10 }, "serviceAccountEmail": { "type": "string", "id": 11 }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 12, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "versionId": { "type": "int64", "id": 14, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "labels": { "keyType": "string", "type": "string", "id": 15 }, "environmentVariables": { "keyType": "string", "type": "string", "id": 17 }, "buildEnvironmentVariables": { "keyType": "string", "type": "string", "id": 28 }, "network": { "type": "string", "id": 18, "options": { "deprecated": true } }, "maxInstances": { "type": "int32", "id": 20 }, "minInstances": { "type": "int32", "id": 32 }, "vpcConnector": { "type": "string", "id": 22 }, "vpcConnectorEgressSettings": { "type": "VpcConnectorEgressSettings", "id": 23 }, "ingressSettings": { "type": "IngressSettings", "id": 24 }, "kmsKeyName": { "type": "string", "id": 25, "options": { "(google.api.resource_reference).type": "cloudkms.googleapis.com/CryptoKey" } }, "buildWorkerPool": { "type": "string", "id": 26 }, "buildId": { "type": "string", "id": 27, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "buildName": { "type": "string", "id": 33, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "secretEnvironmentVariables": { "rule": "repeated", "type": "SecretEnvVar", "id": 29 }, "secretVolumes": { "rule": "repeated", "type": "SecretVolume", "id": 30 }, "sourceToken": { "type": "string", "id": 31, "options": { "(google.api.field_behavior)": "INPUT_ONLY" } }, "dockerRepository": { "type": "string", "id": 34, "options": { "(google.api.resource_reference).type": "artifactregistry.googleapis.com/Repository" } }, "dockerRegistry": { "type": "DockerRegistry", "id": 35, "options": { "deprecated": true } }, "automaticUpdatePolicy": { "type": "AutomaticUpdatePolicy", "id": 40 }, "onDeployUpdatePolicy": { "type": "OnDeployUpdatePolicy", "id": 41 }, "buildServiceAccount": { "type": "string", "id": 43 } }, "nested": { "VpcConnectorEgressSettings": { "values": { "VPC_CONNECTOR_EGRESS_SETTINGS_UNSPECIFIED": 0, "PRIVATE_RANGES_ONLY": 1, "ALL_TRAFFIC": 2 } }, "IngressSettings": { "values": { "INGRESS_SETTINGS_UNSPECIFIED": 0, "ALLOW_ALL": 1, "ALLOW_INTERNAL_ONLY": 2, "ALLOW_INTERNAL_AND_GCLB": 3 } }, "DockerRegistry": { "values": { "DOCKER_REGISTRY_UNSPECIFIED": 0, "CONTAINER_REGISTRY": 1, "ARTIFACT_REGISTRY": 2 } }, "AutomaticUpdatePolicy": { "fields": {} }, "OnDeployUpdatePolicy": { "fields": { "runtimeVersion": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } } } }, "SourceRepository": { "fields": { "url": { "type": "string", "id": 1 }, "deployedUrl": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } } } }, "HttpsTrigger": { "fields": { "url": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "securityLevel": { "type": "SecurityLevel", "id": 2 } }, "nested": { "SecurityLevel": { "values": { "SECURITY_LEVEL_UNSPECIFIED": 0, "SECURE_ALWAYS": 1, "SECURE_OPTIONAL": 2 } } } }, "EventTrigger": { "fields": { "eventType": { "type": "string", "id": 1 }, "resource": { "type": "string", "id": 2 }, "service": { "type": "string", "id": 3 }, "failurePolicy": { "type": "FailurePolicy", "id": 5 } } }, "FailurePolicy": { "oneofs": { "action": { "oneof": [ "retry" ] } }, "fields": { "retry": { "type": "Retry", "id": 1 } }, "nested": { "Retry": { "fields": {} } } }, "CloudFunctionStatus": { "values": { "CLOUD_FUNCTION_STATUS_UNSPECIFIED": 0, "ACTIVE": 1, "OFFLINE": 2, "DEPLOY_IN_PROGRESS": 3, "DELETE_IN_PROGRESS": 4, "UNKNOWN": 5 } }, "SecretEnvVar": { "fields": { "key": { "type": "string", "id": 1 }, "projectId": { "type": "string", "id": 2 }, "secret": { "type": "string", "id": 3 }, "version": { "type": "string", "id": 4 } } }, "SecretVolume": { "fields": { "mountPath": { "type": "string", "id": 1 }, "projectId": { "type": "string", "id": 2 }, "secret": { "type": "string", "id": 3 }, "versions": { "rule": "repeated", "type": "SecretVersion", "id": 4 } }, "nested": { "SecretVersion": { "fields": { "version": { "type": "string", "id": 1 }, "path": { "type": "string", "id": 2 } } } } }, "CreateFunctionRequest": { "fields": { "location": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "locations.googleapis.com/Location" } }, "function": { "type": "CloudFunction", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "UpdateFunctionRequest": { "fields": { "function": { "type": "CloudFunction", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED" } }, "updateMask": { "type": "google.protobuf.FieldMask", "id": 2 } } }, "GetFunctionRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudfunctions.googleapis.com/CloudFunction" } }, "versionId": { "type": "int64", "id": 2, "options": { "(google.api.field_behavior)": "OPTIONAL" } } } }, "ListFunctionsRequest": { "fields": { "parent": { "type": "string", "id": 1, "options": { "(google.api.resource_reference).type": "locations.googleapis.com/Location" } }, "pageSize": { "type": "int32", "id": 2 }, "pageToken": { "type": "string", "id": 3 } } }, "ListFunctionsResponse": { "fields": { "functions": { "rule": "repeated", "type": "CloudFunction", "id": 1 }, "nextPageToken": { "type": "string", "id": 2 }, "unreachable": { "rule": "repeated", "type": "string", "id": 3 } } }, "DeleteFunctionRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudfunctions.googleapis.com/CloudFunction" } } } }, "CallFunctionRequest": { "fields": { "name": { "type": "string", "id": 1, "options": { "(google.api.field_behavior)": "REQUIRED", "(google.api.resource_reference).type": "cloudfunctions.googleapis.com/CloudFunction" } }, "data": { "type": "string", "id": 2, "options": { "(google.api.field_behavior)": "REQUIRED" } } } }, "CallFunctionResponse": { "fields": { "executionId": { "type": "string", "id": 1 }, "result": { "type": "string", "id": 2 }, "error": { "type": "string", "id": 3 } } }, "GenerateUploadUrlRequest": { "fields": { "parent": { "type": "string", "id": 1 }, "kmsKeyName": { "type": "string", "id": 2, "options": { "(google.api.resource_reference).type": "cloudkms.googleapis.com/CryptoKey" } } } }, "GenerateUploadUrlResponse": { "fields": { "uploadUrl": { "type": "string", "id": 1 } } }, "GenerateDownloadUrlRequest": { "fields": { "name": { "type": "string", "id": 1 }, "versionId": { "type": "uint64", "id": 2 } } }, "GenerateDownloadUrlResponse": { "fields": { "downloadUrl": { "type": "string", "id": 1 } } }, "OperationType": { "values": { "OPERATION_UNSPECIFIED": 0, "CREATE_FUNCTION": 1, "UPDATE_FUNCTION": 2, "DELETE_FUNCTION": 3 } }, "OperationMetadataV1": { "fields": { "target": { "type": "string", "id": 1 }, "type": { "type": "OperationType", "id": 2 }, "request": { "type": "google.protobuf.Any", "id": 3 }, "versionId": { "type": "int64", "id": 4 }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 5 }, "buildId": { "type": "string", "id": 6 }, "sourceToken": { "type": "string", "id": 7 }, "buildName": { "type": "string", "id": 8 } } } } }, "v2": { "options": { "go_package": "cloud.google.com/go/functions/apiv2/functionspb;functionspb", "java_multiple_files": true, "java_outer_classname": "FunctionsProto", "java_package": "com.google.cloud.functions.v2", "objc_class_prefix": "GCF", "(google.api.resource_definition).type": "cloudkms.googleapis.com/CryptoKey", "(google.api.resource_definition).pattern": "projects/{project}/locations/{location}/keyRings/{key_ring}/cryptoKeys/{crypto_key}" }, "nested": { "FunctionService": { "options": { "(google.api.default_host)": "cloudfunctions.googleapis.com", "(google.api.oauth_scopes)": "https://www.googleapis.com/auth/cloud-platform" }, "methods": { "GetFunction": { "requestType": "GetFunctionRequest", "responseType": "Function", "options": { "(google.api.http).get": "/v2/{name=projects/*/locations/*/functions/*}", "(google.api.method_signature)": "name" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{name=projects/*/locations/*/functions/*}" } }, { "(google.api.method_signature)": "name" } ] }, "ListFunctions": { "requestType": "ListFunctionsRequest", "responseType": "ListFunctionsResponse", "options": { "(google.api.http).get": "/v2/{parent=projects/*/locations/*}/functions", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*/locations/*}/functions" } }, { "(google.api.method_signature)": "parent" } ] }, "CreateFunction": { "requestType": "CreateFunctionRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).post": "/v2/{parent=projects/*/locations/*}/functions", "(google.api.http).body": "function", "(google.api.method_signature)": "parent,function,function_id", "(google.longrunning.operation_info).response_type": "google.cloud.functions.v2.Function", "(google.longrunning.operation_info).metadata_type": "google.cloud.functions.v2.OperationMetadata" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*/locations/*}/functions", "body": "function" } }, { "(google.api.method_signature)": "parent,function,function_id" }, { "(google.longrunning.operation_info)": { "response_type": "google.cloud.functions.v2.Function", "metadata_type": "google.cloud.functions.v2.OperationMetadata" } } ] }, "UpdateFunction": { "requestType": "UpdateFunctionRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).patch": "/v2/{function.name=projects/*/locations/*/functions/*}", "(google.api.http).body": "function", "(google.api.method_signature)": "function,update_mask", "(google.longrunning.operation_info).response_type": "google.cloud.functions.v2.Function", "(google.longrunning.operation_info).metadata_type": "google.cloud.functions.v2.OperationMetadata" }, "parsedOptions": [ { "(google.api.http)": { "patch": "/v2/{function.name=projects/*/locations/*/functions/*}", "body": "function" } }, { "(google.api.method_signature)": "function,update_mask" }, { "(google.longrunning.operation_info)": { "response_type": "google.cloud.functions.v2.Function", "metadata_type": "google.cloud.functions.v2.OperationMetadata" } } ] }, "DeleteFunction": { "requestType": "DeleteFunctionRequest", "responseType": "google.longrunning.Operation", "options": { "(google.api.http).delete": "/v2/{name=projects/*/locations/*/functions/*}", "(google.api.method_signature)": "name", "(google.longrunning.operation_info).response_type": "google.protobuf.Empty", "(google.longrunning.operation_info).metadata_type": "google.cloud.functions.v2.OperationMetadata" }, "parsedOptions": [ { "(google.api.http)": { "delete": "/v2/{name=projects/*/locations/*/functions/*}" } }, { "(google.api.method_signature)": "name" }, { "(google.longrunning.operation_info)": { "response_type": "google.protobuf.Empty", "metadata_type": "google.cloud.functions.v2.OperationMetadata" } } ] }, "GenerateUploadUrl": { "requestType": "GenerateUploadUrlRequest", "responseType": "GenerateUploadUrlResponse", "options": { "(google.api.http).post": "/v2/{parent=projects/*/locations/*}/functions:generateUploadUrl", "(google.api.http).body": "*" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{parent=projects/*/locations/*}/functions:generateUploadUrl", "body": "*" } } ] }, "GenerateDownloadUrl": { "requestType": "GenerateDownloadUrlRequest", "responseType": "GenerateDownloadUrlResponse", "options": { "(google.api.http).post": "/v2/{name=projects/*/locations/*/functions/*}:generateDownloadUrl", "(google.api.http).body": "*" }, "parsedOptions": [ { "(google.api.http)": { "post": "/v2/{name=projects/*/locations/*/functions/*}:generateDownloadUrl", "body": "*" } } ] }, "ListRuntimes": { "requestType": "ListRuntimesRequest", "responseType": "ListRuntimesResponse", "options": { "(google.api.http).get": "/v2/{parent=projects/*/locations/*}/runtimes", "(google.api.method_signature)": "parent" }, "parsedOptions": [ { "(google.api.http)": { "get": "/v2/{parent=projects/*/locations/*}/runtimes" } }, { "(google.api.method_signature)": "parent" } ] } } }, "OperationType": { "values": { "OPERATIONTYPE_UNSPECIFIED": 0, "CREATE_FUNCTION": 1, "UPDATE_FUNCTION": 2, "DELETE_FUNCTION": 3 } }, "Environment": { "values": { "ENVIRONMENT_UNSPECIFIED": 0, "GEN_1": 1, "GEN_2": 2 } }, "Function": { "options": { "(google.api.resource).type": "cloudfunctions.googleapis.com/Function", "(google.api.resource).pattern": "projects/{project}/locations/{location}/functions/{function}", "(google.api.resource).plural": "functions", "(google.api.resource).singular": "function" }, "fields": { "name": { "type": "string", "id": 1 }, "description": { "type": "string", "id": 2 }, "buildConfig": { "type": "BuildConfig", "id": 3 }, "serviceConfig": { "type": "ServiceConfig", "id": 4 }, "eventTrigger": { "type": "EventTrigger", "id": 5 }, "state": { "type": "State", "id": 6, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "updateTime": { "type": "google.protobuf.Timestamp", "id": 7, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "labels": { "keyType": "string", "type": "string", "id": 8 }, "stateMessages": { "rule": "repeated", "type": "StateMessage", "id": 9, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "environment": { "type": "Environment", "id": 10 }, "url": { "type": "string", "id": 14, "options": { "(google.api.field_behavior)": "OUTPUT_ONLY" } }, "kmsKeyName": { "type": "string", "id": 25, "options": { "(google.api.resource_reference).type": "cloudkms.googleapis.com/CryptoKey" } }, "satisfiesPzs": { "type": "bool", "id": 27,