1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-08 10:35:03 +00:00
gcloud-help/gcloud/functions/call

89 lines
3.1 KiB
Text
Raw Normal View History

2022-03-01 04:29:52 +00:00
NAME
gcloud functions call - triggers execution of a Google Cloud Function
SYNOPSIS
2024-01-18 10:21:20 +00:00
gcloud functions call (NAME : --region=REGION)
2022-07-27 08:55:33 +00:00
[--cloud-event=CLOUD_EVENT | --data=DATA] [GCLOUD_WIDE_FLAG ...]
2022-03-01 04:29:52 +00:00
DESCRIPTION
Triggers execution of a Google Cloud Function.
EXAMPLES
To call a function, giving it 'Hello World!' in the message field of its
event argument (depending on your environment you might need to escape
characters in --data flag value differently), run:
$ gcloud functions call helloWorld \
--data='{"message": "Hello World!"}'
Note that this method has a limited quota which cannot be increased. It is
intended for testing and debugging and should not be used in production.
Calls to HTTP-triggered functions are sent as HTTP POST requests. To use
other HTTP methods, use a dedicated HTTP request tool such as cURL or wget.
POSITIONAL ARGUMENTS
2024-12-11 10:18:23 +00:00
Function resource - The Cloud Function name to execute. The arguments in
2022-03-01 04:29:52 +00:00
this group can be used to specify the attributes of this resource. (NOTE)
Some attributes are not given arguments in this group but can be set in
2023-05-04 10:43:54 +00:00
other ways.
To set the project attribute:
2022-03-01 04:29:52 +00:00
◆ provide the argument NAME on the command line with a fully specified
name;
◆ provide the argument --project on the command line;
◆ set the property core/project.
This must be specified.
NAME
2023-05-04 10:43:54 +00:00
ID of the function or fully qualified identifier for the function.
To set the function attribute:
2022-03-01 04:29:52 +00:00
▸ provide the argument NAME on the command line.
2022-08-10 08:48:58 +00:00
This positional argument must be specified if any of the other
arguments in this group are specified.
2022-03-01 04:29:52 +00:00
--region=REGION
The Cloud region for the function. Overrides the default
2023-05-04 10:43:54 +00:00
functions/region property value for this command invocation.
To set the region attribute:
2022-03-01 04:29:52 +00:00
▸ provide the argument NAME on the command line with a fully
specified name;
▸ provide the argument --region on the command line;
▸ set the property functions/region.
FLAGS
2022-07-27 08:55:33 +00:00
At most one of these can be specified:
--cloud-event=CLOUD_EVENT
JSON encoded string with a CloudEvent in structured content mode.
Mutually exclusive with --data flag.
Use for Cloud Functions 2nd Gen CloudEvent functions. The CloudEvent
object will be sent to your function as a binary content mode message
with the top-level 'data' field set as the HTTP body and all other
JSON fields sent as HTTP headers.
--data=DATA
JSON string with data that will be passed to the function.
2022-03-01 04:29:52 +00:00
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,
--help, --impersonate-service-account, --log-http, --project, --quiet,
--trace-token, --user-output-enabled, --verbosity.
Run $ gcloud help for details.
NOTES
These variants are also available:
$ gcloud alpha functions call
$ gcloud beta functions call