File: //lib/google-cloud-sdk/lib/surface/functions/call.py
# -*- coding: utf-8 -*- #
# Copyright 2015 Google LLC. All Rights Reserved.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
"""Triggers execution of a Google Cloud Function."""
from __future__ import absolute_import
from __future__ import division
from __future__ import unicode_literals
import json
from googlecloudsdk.api_lib.functions import util
from googlecloudsdk.calliope import base
from googlecloudsdk.calliope import exceptions
from googlecloudsdk.command_lib.functions import flags
import six
class Call(base.Command):
"""Trigger 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:
$ {command} 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.
"""
@staticmethod
def Args(parser):
"""Register flags for this command."""
flags.AddFunctionResourceArg(parser, 'to execute')
parser.add_argument(
'--data',
help='JSON string with data that will be passed to the function.')
@util.CatchHTTPErrorRaiseHTTPException
def Run(self, args):
"""This is what gets called when the user runs this command.
Args:
args: an argparse namespace. All the arguments that were provided to this
command invocation.
Returns:
Function call results (error or result with execution id)
"""
if args.data:
try:
json.loads(args.data)
except ValueError as e:
raise exceptions.InvalidArgumentException(
'--data', 'Is not a valid JSON: ' + six.text_type(e))
client = util.GetApiClientInstance()
function_ref = args.CONCEPTS.name.Parse()
# Do not retry calling function - most likely user want to know that the
# call failed and debug.
client.projects_locations_functions.client.num_retries = 0
messages = client.MESSAGES_MODULE
return client.projects_locations_functions.Call(
messages.CloudfunctionsProjectsLocationsFunctionsCallRequest(
name=function_ref.RelativeName(),
callFunctionRequest=messages.CallFunctionRequest(data=args.data)))