"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.",
"response":{
"$ref":"Operation"
},
"parameterOrder":[
"name"
],
"httpMethod":"GET",
"parameters":{
"name":{
"location":"path",
"description":"The name of the operation resource.",
"type":"string",
"required":true,
"pattern":"^operations/[^/]+$"
}
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath":"v1beta2/operations/{operationsId}"
},
"list":{
"httpMethod":"GET",
"parameterOrder":[],
"response":{
"$ref":"ListOperationsResponse"
},
"parameters":{
"pageToken":{
"location":"query",
"description":"The standard list page token.",
"type":"string"
},
"name":{
"description":"The name of the operation's parent resource.",
"type":"string",
"location":"query"
},
"pageSize":{
"location":"query",
"format":"int32",
"description":"The standard list page size.",
"type":"integer"
},
"filter":{
"location":"query",
"description":"The standard list filter.",
"type":"string"
}
},
"scopes":[
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath":"v1beta2/operations",
"path":"v1beta2/operations",
"id":"cloudfunctions.operations.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."
"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.",
"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",
"location":"query"
},
"pageSize":{
"format":"int32",
"description":"Maximum number of functions to return per call.",
"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.",
"description":"The project and location in which the Google Cloud Storage signed URL\nshould be generated, specified in the format `projects/*/locations/*",
"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 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",
"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.",
"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.",
"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.",
"description":"Describes a Cloud Function that contains user computation executed in\nresponse to an event. It encapsulate function and triggers configurations.",
"type":"object",
"properties":{
"sourceRepository":{
"$ref":"SourceRepository",
"description":"The hosted repository where the function is defined."
},
"labels":{
"type":"object",
"additionalProperties":{
"type":"string"
},
"description":"Labels associated with this Cloud Function."
},
"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"
},
"sourceRepositoryUrl":{
"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"
},
"updateTime":{
"format":"google-datetime",
"description":"Output only. The last update timestamp of a Cloud Function.",
"type":"string"
},
"latestOperation":{
"description":"Output only. Name of the most recent operation modifying the function. If\nthe function status is `DEPLOYING` or `DELETING`, then it points to the\nactive operation.",
"type":"string"
},
"httpsTrigger":{
"description":"An HTTPS endpoint type of source that can be triggered via URL.",
"$ref":"HTTPSTrigger"
},
"timeout":{
"format":"google-duration",
"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.",
"type":"string"
},
"status":{
"description":"Output only. Status of the function deployment.",
"type":"string",
"enumDescriptions":[
"Status not specified.",
"Successfully deployed.",
"Not deployed correctly - behavior is undefined. The item should be updated\nor deleted to move it out of this state.",
"Creation or update in progress.",
"Deletion in progress."
],
"enum":[
"STATUS_UNSPECIFIED",
"READY",
"FAILED",
"DEPLOYING",
"DELETING"
]
},
"sourceUploadUrl":{
"description":"The Google Cloud Storage signed URL used for source uploading, generated\nby google.cloud.functions.v1beta2.GenerateUploadUrl",
"type":"string"
},
"eventTrigger":{
"description":"A source that fires events in response to a condition in another service.",
"$ref":"EventTrigger"
},
"availableMemoryMb":{
"format":"int32",
"description":"The amount of memory in MB available for a function.\nDefaults to 256MB.",
"type":"integer"
},
"name":{
"type":"string",
"description":"A user-defined name of the function. Function names must be unique\nglobally and match pattern `projects/*/locations/*/functions/*`"
},
"versionId":{
"type":"string",
"format":"int64",
"description":"Output only.\nThe version identifier of the Cloud Function. Each deployment attempt\nresults in a new version of a function being created."
},
"serviceAccount":{
"description":"Output only. The service account of the function.",
"type":"string"
},
"sourceArchiveUrl":{
"description":"The Google Cloud Storage URL, starting with gs://, pointing to the zip\narchive which contains the function.",
"type":"string"
}
},
"id":"CloudFunction"
},
"Location":{
"description":"A resource that represents Google Cloud Platform location.",
"type":"object",
"properties":{
"locationId":{
"description":"The canonical id for this location. For example: `\"us-east1\"`.",
"type":"string"
},
"metadata":{
"additionalProperties":{
"description":"Properties of the object. Contains field @type with type URL.",
"type":"any"
},
"description":"Service-specific metadata. For example the available capacity at the given\nlocation.",
"type":"object"
},
"labels":{
"additionalProperties":{
"type":"string"
},
"description":"Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"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":"Location"
},
"GenerateDownloadUrlResponse":{
"id":"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.",
"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.",
"description":"Response of `GenerateUploadUrl` method.",
"type":"object",
"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.",
"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.v1beta2.ListFunctionsRequest\nto get more functions.",
"description":"Result populated for successful execution of synchronous function. Will\nnot be populated if function does not return a result through context.",
"description":"`event_type` names contain the service that is sending an event and the\nkind of event that was fired. Must be of the form\n`providers/*/eventTypes/*` e.g. Directly handle a Message published to\nGoogle Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish`\n\n Handle an object changing in Google Cloud Storage\n `providers/cloud.storage/eventTypes/object.change`\n\n Handle a write to the Firebase Realtime Database\n `providers/google.firebase.database/eventTypes/ref.write`",
"description":"Which instance of the source's service should send events. E.g. for Pub/Sub\nthis would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud\nStorage this would be a bucket at `projects/*/buckets/*`. For any source\nthat only supports one instance per-project, this should be the name of the\nproject (`projects/*`)",
"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.",
"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 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`.",
"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.",
"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.",
"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":"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."
"description":"The name of the branch from which the function should be fetched.",
"type":"string"
},
"deployedRevision":{
"description":"Output only. The id of the revision that was resolved at the moment of\nfunction creation or update. For example when a user deployed from a\nbranch, it will be the revision id of the latest change on this branch at\nthat time. If user deployed from revision then this value will be always\nequal to the revision specified by the user.",
"type":"string"
},
"sourcePath":{
"description":"The path within the repository where the function is defined. The path\nshould point to the directory where Cloud Functions files are located. Use\n\"/\" if the function is defined directly in the root directory of a\nrepository.",
"description":"URL to the hosted repository where the function is defined. Only paths in\nhttps://source.developers.google.com domain are supported. The path should\ncontain the name of the repository.",
