package google.cloud.functions.v1beta2

Get desktop application:
View/edit binary Protocol Buffers messages

A service that application uses to manipulate triggers and functions.

• rpc CallFunction (CallFunctionRequest, CallFunctionResponse)

  functions.proto:66

  Invokes synchronously deployed function. To be used for testing, very limited traffic allowed.

  message CallFunctionRequest

  functions.proto:256

  Request for the `CallFunction` method.

  • string name = 1

    The name of the function to be called.

  • string data = 2

    Input to be passed to the function.

  message CallFunctionResponse

  functions.proto:265

  Response of `CallFunction` method.

  • string execution_id = 1

    Execution id of function invocation.

  • string result = 2

    Result populated for successful execution of synchronous function. Will not be populated if function does not return a result through context.

  • string error = 3

    Either system or user-function generated error. Set if execution was not successful.

• rpc CreateFunction (CreateFunctionRequest, longrunning.Operation)

  functions.proto:48

  Creates a new function. If a function with the given name already exists in the specified project, the long running operation will return `ALREADY_EXISTS` error.

  message CreateFunctionRequest

  functions.proto:195

  Request for the `CreateFunction` method.

  • string location = 1

    The project and location in which the function should be created, specified in the format `projects/*/locations/*`

  • optional CloudFunction function = 2

    Function to be created.

• rpc DeleteFunction (DeleteFunctionRequest, longrunning.Operation)

  functions.proto:60

  Deletes a function with the given name from the specified project. If the given function is used by some trigger, the trigger will be updated to remove this function.

  message DeleteFunctionRequest

  functions.proto:250

  Request for the `DeleteFunction` method.

  • string name = 1

    The name of the function which should be deleted.

• rpc GetFunction (GetFunctionRequest, CloudFunction)

  functions.proto:41

  Returns a function with the given name from the requested project.

  message GetFunctionRequest

  functions.proto:214

  Request for the `GetFunction` method.

  • string name = 1

    The name of the function which details should be obtained.

• rpc ListFunctions (ListFunctionsRequest, ListFunctionsResponse)

  functions.proto:36

  Returns a list of functions that belong to the requested project.

  message ListFunctionsRequest

  functions.proto:220

  Request for the `ListFunctions` method.

  • string location = 1

    The project and location from which the function should be listed, specified in the format `projects/*/locations/*` If you want to list functions in all locations, use "-" in place of a location.

  • int32 page_size = 2

    Maximum number of functions to return per call.

  • string page_token = 3

    The value returned by the last `ListFunctionsResponse`; indicates that this is a continuation of a prior `ListFunctions` call, and that the system should return the next page of data.

  message ListFunctionsResponse

  functions.proto:238

  Response for the `ListFunctions` method.

  • repeated CloudFunction functions = 1

    The functions that match the request.

  • string next_page_token = 2

    If not empty, indicates that there may be more functions that match the request; this value should be passed in a new [google.cloud.functions.v1beta2.ListFunctionsRequest][] to get more functions.

• rpc UpdateFunction (UpdateFunctionRequest, longrunning.Operation)

  functions.proto:53

  Updates existing function.

  message UpdateFunctionRequest

  functions.proto:205

  Request for the `UpdateFunction` method.

  • string name = 1

    The name of the function to be updated.

  • optional CloudFunction function = 2

    New version of the function.

Describes a Cloud Function that contains user computation executed in response to an event. It encapsulate function and triggers configurations.

Used as response type in: CloudFunctionsService.GetFunction

Used as field type in: CreateFunctionRequest, ListFunctionsResponse, UpdateFunctionRequest

• string name = 1

  A user-defined name of the function. Function names must be unique globally and match pattern `projects/*/locations/*/functions/*`

• oneof source_code

  The location of the function source code.

  • string source_archive_url = 14

    The URL, starting with gs://, pointing to the zip archive which contains the function.

  • SourceRepository source_repository = 3

    The hosted repository where the function is defined.

• oneof trigger

  An event that triggers the function.

  • HTTPSTrigger https_trigger = 6

    An HTTPS endpoint type of source that can be triggered via URL.

  • EventTrigger event_trigger = 12

    A source that fires events in response to a condition in another service.

• CloudFunctionStatus status = 7

  Output only. Status of the function deployment.

• string latest_operation = 8

  Output only. Name of the most recent operation modifying the function. If the function status is `DEPLOYING` or `DELETING`, then it points to the active operation.

• string entry_point = 9

  The name of the function (as defined in source code) that will be executed. Defaults to the resource name suffix, if not specified. For backward compatibility, if function with given name is not found, then the system will try to use function named "function". For Node.js this is name of a function exported by the module specified in `source_location`.

• optional protobuf.Duration timeout = 10

  The function execution timeout. Execution is considered failed and can be terminated if the function is not completed at the end of the timeout period. Defaults to 60 seconds.

• int32 available_memory_mb = 11

  The amount of memory in MB available for a function. Defaults to 256MB.

• string service_account = 13

  Output only. The service account of the function.

• optional protobuf.Timestamp update_time = 15

  Output only. The last update timestamp of a Cloud Function.

Describes the current stage of a deployment.

Used in: CloudFunction

• STATUS_UNSPECIFIED = 0

  Status not specified.

• READY = 1

  Successfully deployed.

• FAILED = 2

  Not deployed correctly - behavior is undefined. The item should be updated or deleted to move it out of this state.

• DEPLOYING = 3

  Creation or update in progress.

• DELETING = 4

  Deletion in progress.

Describes EventTrigger, used to request events be sent from another service.

Used in: CloudFunction

• string event_type = 1

  `event_type` names contain the service that is sending an event and the kind of event that was fired. Must be of the form `providers/*/eventTypes/*` e.g. Directly handle a Message published to Google Cloud Pub/Sub `providers/cloud.pubsub/eventTypes/topic.publish` Handle an object changing in Google Cloud Storage `providers/cloud.storage/eventTypes/object.change` Handle a write to the Firebase Realtime Database `providers/firebase.database/eventTypes/data.write`

• string resource = 2

  Which instance of the source's service should send events. E.g. for Pub/Sub this would be a Pub/Sub topic at `projects/*/topics/*`. For Google Cloud Storage this would be a bucket at `projects/*/buckets/*`. For any source that only supports one instance per-project, this should be the name of the project (`projects/*`)

Describes HTTPSTrigger, could be used to connect web hooks to function.

Used in: CloudFunction

• string url = 1

  Output only. The deployed url for the function.

Metadata describing an [Operation][google.longrunning.Operation]

• string target = 1

  Target of the operation - for example projects/project-1/locations/region-1/functions/function-1

• OperationType type = 2

  Type of operation.

• optional protobuf.Any request = 3

  The original request that started the operation.

A type of an operation.

Used in: OperationMetadataV1Beta2

• OPERATION_UNSPECIFIED = 0

  Unknown operation type.

• CREATE_FUNCTION = 1

  Triggered by CreateFunction call

• UPDATE_FUNCTION = 2

  Triggered by UpdateFunction call

• DELETE_FUNCTION = 3

  Triggered by DeleteFunction call.

Describes the location of the function source in a remote repository.

Used in: CloudFunction

• string repository_url = 1

  URL to the hosted repository where the function is defined. Only paths in https://source.developers.google.com domain are supported. The path should contain the name of the repository.

• string source_path = 2

  The path within the repository where the function is defined. The path should point to the directory where Cloud Functions files are located. Use "/" if the function is defined directly in the root directory of a repository.

• oneof version

  The version of a function. Defaults to the latest version of the master branch.

  • string branch = 3

    The name of the branch from which the function should be fetched.

  • string tag = 4

    The name of the tag that captures the state of the repository from which the function should be fetched.

  • string revision = 5

    The id of the revision that captures the state of the repository from which the function should be fetched.

• string deployed_revision = 6

  Output only. The id of the revision that was resolved at the moment of function creation or update. For example when a user deployed from a branch, it will be the revision id of the latest change on this branch at that time. If user deployed from revision then this value will be always equal to the revision specified by the user.