.TH "GCLOUD_ALPHA_FUNCTIONS_CALL" 1



.SH "NAME"
.HP
gcloud alpha functions call \- triggers execution of a Google Cloud Function



.SH "SYNOPSIS"
.HP
\f5gcloud alpha functions call\fR (\fINAME\fR\ :\ \fB\-\-region\fR=\fIREGION\fR) [\fB\-\-cloud\-event\fR=\fICLOUD_EVENT\fR\ |\ \fB\-\-data\fR=\fIDATA\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

\fB(ALPHA)\fR Triggers execution of a Google Cloud Function.



.SH "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
\f5\-\-data\fR flag value differently), run:

.RS 2m
$ gcloud alpha functions call helloWorld \e
  \-\-data='{"message": "Hello World!"}'
.RE

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.



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5NAME\fR on the command line with a fully specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fINAME\fR

ID of the function or fully qualified identifier for the function.

To set the \f5function\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5NAME\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-region\fR=\fIREGION\fR

The Cloud region for the function. Overrides the default \f5functions/region\fR
property value for this command invocation.

To set the \f5region\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5NAME\fR on the command line with a fully specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-region\fR on the command line;
.IP "\(bu" 2m
set the property \f5functions/region\fR.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-cloud\-event\fR=\fICLOUD_EVENT\fR

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.

.TP 2m
\fB\-\-data\fR=\fIDATA\fR

JSON string with data that will be passed to the function.


.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud functions call
.RE

.RS 2m
$ gcloud beta functions call
.RE