- NAME
-
- gcloud functions call - triggers execution of a Google Cloud Function
- SYNOPSIS
-
-
gcloud functions call
(NAME
:--region
=REGION
) [--cloud-event
=CLOUD_EVENT
|--data
=DATA
] [GCLOUD_WIDE_FLAG …
]
-
- 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
-
-
Function resource - The Cloud function name to execute. The arguments in 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 other ways.
To set the
project
attribute:-
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
-
ID of the function or fully qualified identifier for the function.
To set the
function
attribute:-
provide the argument
NAME
on the command line.
This positional argument must be specified if any of the other arguments in this group are specified.
-
provide the argument
--region
=REGION
-
The Cloud region for the function. Overrides the default
functions/region
property value for this command invocation.To set the
region
attribute:-
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
.
-
provide the argument
-
provide the argument
-
Function resource - The Cloud function name to execute. The arguments in 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 other ways.
- FLAGS
-
-
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.
-
At most one of these can be specified:
- 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
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.
[{
"type": "thumb-down",
"id": "hardToUnderstand",
"label":"Hard to understand"
},{
"type": "thumb-down",
"id": "incorrectInformationOrSampleCode",
"label":"Incorrect information or sample code"
},{
"type": "thumb-down",
"id": "missingTheInformationSamplesINeed",
"label":"Missing the information/samples I need"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]
{
"lastModified": "Last updated 2024-02-06 UTC.",
"confidential": False
}