Consulta i connettori supportati per Application Integration.
Attività della funzione Cloud Functions
L'attività Cloud Function ti consente di configurare ed eseguire Cloud Run Functions dall'integrazione. Cloud Run Functions rappresenta la prossima evoluzione di Cloud Functions, offrendo un modello di programmazione basato sugli eventi con maggiore controllo e scalabilità, sfruttando la piattaforma serverless Cloud Run. Cloud Run Functions offre un'unica soluzione serverless per tutti i tipi di carichi di lavoro.
Il task Cloud Functions supporta le seguenti versioni di Cloud Run Functions:
- Cloud Functions (1ª generazione.)
- Funzioni Cloud Run create utilizzando l'API Cloud Functions v2
Per informazioni dettagliate sulle differenze tra le versioni di Cloud Run Functions, consulta la guida al confronto tra Cloud Functions.
Prima di iniziare
Assicurati di eseguire le seguenti attività nel tuo progetto Google Cloud prima di configurare l'attività Cloud Function.
- Per connetterti a Cloud Function, assicurati di aver creato un profilo OAuth 2.0 o di aver collegato un service account gestito dall'utente alla tua integrazione:
-
Se la tua integrazione ha un account di servizio collegato, assegna il ruolo IAM Invoker di Cloud Functions a questo account di servizio.
Per informazioni sulla concessione dei ruoli a un account di servizio, vedi Gestire l'accesso ai service account.
- L'attività funzione Cloud Functions supporta solo i profili di autenticazione di tipo Token ID Google OIDC. Crea un profilo di autenticazione di tipo Token ID Google OIDC utilizzando il account di servizio con il ruolo IAM Cloud Functions Invoker assegnato. Se l'attività Cloud Function non richiede l'autenticazione, il campo Profilo di autenticazione nel riquadro di configurazione dell'attività può essere lasciato vuoto.
- Assicurati che i Controlli di servizio VPC non siano configurati per l'Application Integration nel tuo progetto Google Cloud .
Se la tua integrazione ha configurato sia un profilo ID OIDC sia un account di servizio gestito dall'utente, per impostazione predefinita viene utilizzato il profilo ID OIDC per l'autenticazione. Se non è configurato né il profilo ID OIDC né il account di servizio gestito dall'utente, viene utilizzato il account di servizio predefinito (service-PROJECT_NUMBER@gcp-sa-integrations.iam.gserviceaccount.com
) per chiamare l'attività Cloud Functions.
Configura l'attività della funzione Cloud Functions
Per configurare l'attività Cloud Function nell'integrazione, segui questi passaggi:
- Nel menu di navigazione, fai clic su Integrazioni.
Si apre l'elenco delle integrazioni disponibili nell'interfaccia utente di integrazione delle applicazioni.
- Seleziona un'integrazione esistente o fai clic su Crea integrazione.
Se stai creando una nuova integrazione, inserisci un nome e una descrizione nella finestra di dialogo di creazione e fai clic su Crea.
- Dal menu a discesa Attività, fai clic su funzione Cloud Functions per posizionarla nell'Editor integrazioni.
- Fai clic sull'elemento Cloud Function nel designer per aprire il riquadro di configurazione, quindi fai clic su Configura Cloud Function.
-
Se ti viene chiesto di concedere autorizzazioni al account di servizio, fai clic su
Concedi.
Application Integration concede automaticamente le autorizzazioni richieste al account di servizio.
- Nel riquadro Configurazione di Cloud Functions, seleziona una delle seguenti opzioni:
- Collega funzione esistente:seleziona questa opzione per associare una funzione esistente all'integrazione. Puoi collegare Cloud Functions (1ª generazione) e Cloud Functions create con l'API Cloud Functions v2 dalla tua integrazione.
- Nel campo URL trigger di Cloud Functions, inserisci l'URL trigger della funzione esistente.
L'URL deve seguire uno dei seguenti formati:
# For Cloud Functions (1st gen) https://REGION_NAME-PROJECT_ID.cloudfunctions.net/FUNCTION_NAME
# For Cloud Run functions created using the Cloud Functions v2 API https://FUNCTION_NAME-PROJECT_ID.REGION_NAME.run.app
- Nel campo URL trigger di Cloud Functions, inserisci l'URL trigger della funzione esistente.
- Crea nuova funzione:seleziona questa opzione per creare una nuova funzione per l'integrazione.
- Nel campo Nome funzione, inserisci un nome univoco per le nuove funzioni Cloud Run.
- Dal menu a discesa Regione, seleziona la regione in cui viene eseguito il deployment delle funzioni Cloud Run.
- Nel menu a discesa Versione funzione, seleziona la versione di Cloud Run Functions che preferisci:
- Cloud Functions (1ª gen.): si tratta della versione legacy di Cloud Run Functions, precedentemente nota come Cloud Functions (1ª generazione.), che utilizza il formato dell'endpoint
.cloudfunctions.net
. - Cloud Functions (ultima generazione): si tratta dell'ultima versione delle funzioni Cloud Run, create utilizzando l'API Cloud Functions v2. Basato su Cloud Run ed Eventarc, supporta timeout delle richieste estesi (fino a 60 minuti), offre una maggiore concorrenza e utilizza i formati degli endpoint
.cloudfunctions.net
e.run.app
.
Per saperne di più sulle differenze tra le due versioni, vedi Confronto tra Cloud Functions.
- Cloud Functions (1ª gen.): si tratta della versione legacy di Cloud Run Functions, precedentemente nota come Cloud Functions (1ª generazione.), che utilizza il formato dell'endpoint
- Collega funzione esistente:seleziona questa opzione per associare una funzione esistente all'integrazione. Puoi collegare Cloud Functions (1ª generazione) e Cloud Functions create con l'API Cloud Functions v2 dalla tua integrazione.
- Fai clic su Salva.
La configurazione di un'attività Cloud Functions in Application Integration crea funzioni Cloud Run attivate tramite HTTP di base nel tuo progetto Google Cloud.
Modello di funzione Cloud
Gli esempi seguenti mostrano come utilizzare l'attività Cloud Function nell'integrazione per lingue diverse.
Python
Quando configuri la Cloud Function utilizzando una funzione Cloud Run esistente, assicurati che i file sorgente main.py
, task.py
e requirements.txt
della funzione siano nel seguente formato:
task.py
# Sample Code: # print(event.get('task_string_key')) # event.set('task_int_array_key', [456, 789]); # event.log('some logging') def run(event): """Actual cloud function custom logic. Args: event : event object in main.py that contains all parameters. """ return
main.py
"""Un-editable platform wrapper which invokes user code.""" import traceback from flask import json from flask import jsonify from task import run VALUE_NAME = [ 'stringValue', 'intValue', 'doubleValue', 'booleanValue', 'protoValue' ] ARRAY_VALUE_NAME = { 'stringArray': 'stringValues', 'intArray': 'intValues', 'doubleArray': 'doubleValues', 'booleanArray': 'booleanValues', 'protoArray': 'protoValues' } VALUE_TYPE_URL = 'type.googleapis.com/google.protobuf.Value' CLOUD_FUNCTION_EXCEPTION_KEY = 'CloudFunctionException' CLOUD_FUNCTION_LOGGING_KEY = 'CloudFunctionLogging' class _Event(object): """Event object.""" def __init__(self, json_payload): self._event_params = json_payload.get('eventParameters', dict()) self._task_params = json_payload.get('taskParameters', dict()) self._log = [] print('Event param is ' + str(self._event_params)) print('Task param is ' + str(self._task_params)) def set(self, key, value): """Set the event parameters key-value. Args: key: parameter key. value: parameter value. """ new_param = self._create_param(key, value) param = self._get_param_by_key(key) if param is None: if 'parameters' not in self._event_params: self._event_params['parameters'] = [] self._event_params['parameters'].append(new_param) else: param['value'] = new_param['value'] def _create_param(self, key, value): """Create a new parameter with given key value pair. Args: key: parameter key. value: parameter value. Returns: parameter. """ new_param = {} new_param['key'] = key if isinstance(value, str): new_param['value'] = {'stringValue': value} elif isinstance(value, int): new_param['value'] = {'intValue': value} elif isinstance(value, float): new_param['value'] = {'doubleValue': value} elif isinstance(value, bool): new_param['value'] = {'booleanValue': value} elif isinstance(value, dict): if 'type@' in value: new_param['value'] = {'protoValue': value} else: new_param['value'] = { 'protoValue': { '@type': 'type.googleapis.com/google.protobuf.Value', 'value': value } } elif isinstance(value, list): if not value: raise RuntimeError('Cannot create a param with empty list') if any(not isinstance(val, type(value[0])) for val in value): print('Not all elements in the list have the same type') new_param['value'] = { 'protoValue': { '@type': 'type.googleapis.com/google.protobuf.Value', 'value': value } } elif isinstance(value[0], str): new_param['value'] = {'stringArray': {'stringValues': value}} elif isinstance(value[0], int): new_param['value'] = {'intArray': {'intValues': value}} elif isinstance(value[0], float): new_param['value'] = {'doubleArray': {'doubleValues': value}} elif isinstance(value[0], bool): new_param['value'] = {'booleanArray': {'booleanValues': value}} elif isinstance(value[0], dict): if all('@type' in val and val['@type'] == value[0]['@type'] for val in value): new_param['value'] = {'protoArray': {'protoValues': value}} else: new_param['value'] = { 'protoValue': { '@type': 'type.googleapis.com/google.protobuf.Value', 'value': value } } else: raise RuntimeError('The type ' + type(value[0]) + ' in the list is not supported') else: raise RuntimeError('Value ' + str(value) + ' has the type ' + type(value) + ' that is not supported') return new_param def get(self, key): """Get the event parameter value for specified key. Args: key: parameter key. Returns: Parameter value. """ param = self._get_param_by_key(key) if param is None: raise RuntimeError('Can not find param with key ' + key) return self._get_param_value(param) def _get_param_by_key(self, key): """Get the parameter for specified key. Args: key: parameter key. Returns: Parameter. """ param = self._get_param_by_key_from_params(key, self._task_params) if param is None: return self._get_param_by_key_from_params(key, self._event_params) value = self._get_param_value(param) if isinstance(value, str) and len(value) > 2 and value.startswith( '$') and value.endswith('$'): return self._get_param_by_key_from_params(value[1:-1], self._event_params) return param def _get_param_by_key_from_params(self, key, params): """Get the parameter for specified key from event parameters. Args: key: parameter key. params: event parameters. Returns: Parameter. """ if not isinstance(params, dict) or 'parameters' not in params: return None for param in params['parameters']: if param['key'] == key: return param return None def _get_param_value(self, param): """Get the parameter value for specified parameter. Args: param: parameter. Returns: Parameter value. """ value = param['value'] if len(value) != 1: raise RuntimeError('param does not have size of 1') for value_name in VALUE_NAME: if value_name in value: if value_name == 'protoValue' and value[value_name][ '@type'] == VALUE_TYPE_URL: return value[value_name]['value'] return value[value_name] for array_value_name in ARRAY_VALUE_NAME: if array_value_name in value: return value[array_value_name][ARRAY_VALUE_NAME[array_value_name]] raise RuntimeError('Cannot get value from param ' + str(param)) def set_error(self): """Set the cloud function error to event parameters in order for user to see on IP.""" self.set(CLOUD_FUNCTION_EXCEPTION_KEY, traceback.format_exc()) def log(self, message): self._log.append(str(message)) def get_response(self): """Get the response that can be returned to IP. Returns: The response text or any set of values that can be turned into a Response object using `make_response <http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>`. """ if self._log: self.set(CLOUD_FUNCTION_LOGGING_KEY, self._log) res = { 'eventParameters': self._event_params, } return jsonify(res) def execute_function(request): """Entry point of the cloud function. Args: request (flask.Request): HTTP request object. Returns: The response text or any set of values that can be turned into a Response object using `make_response <http://flask.pocoo.org/docs/1.0/api/#flask.Flask.make_response>`. """ try: request_json = request.get_json(silent=True) event = _Event(request_json) run(event) except: event.set_error() return event.get_response()
requirements.txt
# Function dependencies, for example: # package>=version
Per ulteriori informazioni sul formato della risposta, vedi ValueType.
Java
Il seguente esempio mostra come utilizzare l'attività Cloud Function nell'integrazione. Assicurati che la risposta segua il formato JSON supportato, come descritto nell'esempio:
private static final Gson gson = new Gson(); @Override public void service(HttpRequest request, HttpResponse response) throws Exception { JsonObject body = gson.fromJson(request.getReader(), JsonObject.class); JsonArray resParams = new JsonArray(); for (JsonElement param: body.getAsJsonObject("eventParameters").getAsJsonArray("parameters")) { if (param.getAsJsonObject().get("key").getAsString().equals("input")) { JsonObject newParam= new JsonObject(); newParam.addProperty("key", "input"); JsonObject value = new JsonObject(); value.addProperty("stringValue","2"); newParam.add("value", value); resParams.add(newParam); } else { resParams.add(param); } } JsonObject parameters = new JsonObject(); parameters.add("parameters", resParams); JsonObject res = new JsonObject(); res.add("eventParameters", parameters); System.out.println(res); BufferedWriter writer = response.getWriter(); writer.write(res.toString()); }
Per ulteriori informazioni sul formato della risposta, vedi ValueType.
JavaScript
Il seguente esempio mostra come utilizzare l'attività Cloud Function nell'integrazione. Assicurati che la risposta segua il formato JSON supportato, come descritto nell'esempio:
const functions = require('@google-cloud/functions-framework'); functions.http('execute_function', (req, res) => { console.log(JSON.stringify(req.body)); let response = {"eventParameters":{"parameters":[{"key":"input","value":{"stringValue":"2"}}]}}; res.send(JSON.stringify(response)); });
Per ulteriori informazioni sul formato della risposta, vedi ValueType.
PHP
Il seguente esempio mostra come utilizzare l'attività Cloud Function nell'integrazione. Assicurati che la risposta segua il formato JSON supportato, come descritto nell'esempio:
use Psr\Http\Message\ServerRequestInterface; function execute_function(ServerRequestInterface $request) { return '{"eventParameters":{"parameters":[{"key":"input","value":{"stringValue":"2"}}]}}'; }
Per ulteriori informazioni sul formato della risposta, vedi ValueType.
Modificare un'attività della funzione Cloud Function
Application Integration ti indirizza alla pagina della console Google Cloud appropriata per modificare le funzioni Cloud Run in base al tipo di versione.
Cloud Functions (1ª gen.)
Per modificare un'attività Cloud Function configurata utilizzando la versione Cloud Functions (1ª generazione.), segui questi passaggi:
- Nel riquadro di configurazione dell'attività, fai clic su Apri Cloud Function.
Viene visualizzata la pagina Cloud Functions (1ª generazione.) > Dettagli funzione in Google Cloud console.
- Fai clic su Modifica.
- Nella pagina Modifica funzione, il passaggio Configurazione ti consente di modificare le impostazioni di configurazione predefinite della Cloud Function. Per ulteriori informazioni, consulta Configurazione di Cloud Functions.
- Fai clic su Avanti per passare al passaggio Codice e modificare il codice sorgente della Cloud Function.
Per impostazione predefinita, la Cloud Function contiene i seguenti file di origine:
- main.py : questo file contiene il codice di inizializzazione per eseguire la Cloud Function dall'integrazione.
- task.py : questo file contiene il codice eseguibile della Cloud Function.
Scrivi lo script all'interno della funzione
run(event)
. Questa funzione viene chiamata quando viene eseguita l'attività Cloud Function. L'oggettoevent
del file main.py contiene tutti i parametri dell'attività.Consulta Accedere alle variabili di integrazione per informazioni su come utilizzare le variabili definite a livello di integrazione nello script.
- Fai clic su Esegui il deployment.
Cloud Run Functions
Per modificare un'attività Cloud Function configurata utilizzando la versione Cloud Functions (ultima generazione), segui questi passaggi:
- Nel riquadro di configurazione dell'attività, fai clic su Apri Cloud Function.
Viene visualizzata la pagina Cloud Run Functions > Service details in Google Cloud console.
- Nella scheda Origine, fai clic su Modifica origine per modificare i file del codice sorgente delle funzioni Cloud Run.
Per impostazione predefinita, le funzioni Cloud Run contengono i seguenti file di origine:
- main.py : questo file contiene il codice di inizializzazione per eseguire Cloud Functions dall'integrazione.
- task.py: questo file contiene il codice eseguibile di Cloud Functions.
Scrivi lo script all'interno della funzione
run(event)
. Questa funzione viene chiamata quando viene eseguita l'attività Cloud Run Functions. L'oggettoevent
del file main.py contiene tutti i parametri dell'attività.Consulta Accedere alle variabili di integrazione per informazioni su come utilizzare le variabili definite a livello di integrazione nello script.
- Fai clic su Salva e ridistribuisci.
Accedere alle variabili di integrazione
Per accedere a una variabile di integrazione nella Cloud Function, trasmetti la variabile come parametro dell'attività all'attività funzione Cloud Functions Functions. Il parametro dell'attività è una coppia chiave-valore in cui Key è il nome della variabile di riferimento utilizzata nel file di origine di Cloud Function e Value è il nome della variabile di integrazione corrispondente a cui punta la variabile di riferimento. Puoi aggiungere uno o più parametri dell'attività nella sezione Parametri dell'attività del riquadro di configurazione dell'attività.
Per accedere alle variabili di integrazione dalla tua Cloud Function, vengono utilizzati i seguenti metodi:
- set: scrive il valore in una variabile.
- get: legge il valore di una variabile.
Ad esempio, se hai una variabile di integrazione denominata EmployeeName che vuoi utilizzare nel file di origine della Cloud Function, definisci i seguenti parametri dell'attività:
- Chiave: EmployeeKey
- Valore: EmployeeName
Il seguente script di esempio mostra l'utilizzo delle funzioni set e get per accedere alle variabili di integrazione definite.
def run(event): # Read the integration variable EmployeeName using the reference variable EmployeeKey value = event.get('EmployeeKey'); # Change the integration variable EmployeeName value using the reference variable EmployeeKey event.set('EmployeeKey' , 'XYZ'); # The new value of the integration variable is retained throughout the Cloud Function task. return
Strategia di gestione degli errori
Una strategia di gestione degli errori per un'attività specifica l'azione da intraprendere se l'attività non riesce a causa di un errore temporaneo. Per informazioni su come utilizzare una strategia di gestione degli errori e sui diversi tipi di strategie di gestione degli errori, consulta Strategie di gestione degli errori.
Esclusioni SLA
L'attività Cloud Functions ha una dipendenza dal prodotto
Google Cloud Functions.
Poiché questa dipendenza è esterna a Application Integration, tutte le esecuzioni delle integrazioni active
che non vanno a buon fine a causa dell'errore nell'attività Cloud Function sono escluse dai termini e condizioni dell'accordo sul livello del servizio (SLA) di Application Integration.
Quote e limiti
Per informazioni su quote e limiti per Cloud Run Functions e Cloud Functions (1ª generazione.), consulta Confronto tra configurazioni.
Passaggi successivi
- Scopri di più su tutte le attività e gli attivatori.
- Scopri come testare e pubblicare un'integrazione.
- Scopri di più sulla gestione degli errori.
- Scopri di più sui log di esecuzione dell'integrazione.