Utility helper in $util

Nota

Ora supportiamo principalmente il runtime APPSYNC_JS e la relativa documentazione. Prendi in considerazione l'utilizzo del runtime APPSYNC_JS e delle relative guide qui.

La $util variabile contiene metodi di utilità generali per aiutarti a lavorare con i dati. Se non diversamente specificato, tutte le utilità usano il set di caratteri UTF-8.

Utilità di analisi JSON

Elenco degli strumenti di analisi JSON

$util.parseJson(String) : Object

Da una stringa JSON restituisce una rappresentazione oggetto del risultato.

$util.toJson(Object) : String

Da un oggetto restituisce una rappresentazione JSON "a stringhe" di tale oggetto.

Utilità di codifica

Elenco degli strumenti di codifica

$util.urlEncode(String) : String

Restituisce la stringa di input come stringa codificata application/x-www-form-urlencoded.

$util.urlDecode(String) : String

Decodifica una stringa codificata application/x-www-form-urlencoded nella relativa forma non codificata.

$util.base64Encode( byte[] ) : String

Codifica l'input in una stringa con codifica base64.

$util.base64Decode(String) : byte[]

Decodifica i dati da una stringa con codifica base64.

Utilità per la generazione di ID

Elenco di utilità per la generazione di ID

$util.autoId() : String

Restituisce un valore UUID generato casualmente a 128 bit.

$util.autoUlid() : String

Restituisce un ULID (Universally Unique Lexicographically Sortable Identifier) generato casualmente a 128 bit.

$util.autoKsuid() : String

Restituisce un KSUID (K-Sortable Unique Identifier) base62 generato casualmente a 128 bit codificato come String con una lunghezza di 27.

Utili di errore

Elenco delle utilità di errore

$util.error(String)

Genera un errore personalizzato. Utilizzalo nei modelli di mappatura delle richieste o delle risposte per rilevare un errore nella richiesta o nel risultato della chiamata.

$util.error(String, String)

Genera un errore personalizzato. Usalo nei modelli di mappatura delle richieste o delle risposte per rilevare un errore nella richiesta o nel risultato dell'invocazione. Puoi anche specificare un. errorType

$util.error(String, String, Object)

Genera un errore personalizzato. Utilizzalo nei modelli di mappatura delle richieste o delle risposte per rilevare un errore nella richiesta o nel risultato della chiamata. Puoi anche specificare un campo errorType e un. data Il valore di data verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL.

Nota

dataverrà filtrato in base al set di selezione dell'interrogazione.

$util.error(String, String, Object, Object)

Genera un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. Inoltre, è errorType possibile specificare un data campo, un errorInfo campo e un campo. Il valore di data verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL.

Nota

dataverrà filtrato in base al set di selezione dell'interrogazione. Il valore di errorInfo verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL.

errorInfoNON verrà filtrato in base al set di selezione delle query.

$util.appendError(String)

Aggiunge un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. A differenza di $util.error(String), la valutazione del modello non viene interrotta, in modo che i dati possano essere restituiti al chiamante.

$util.appendError(String, String)

Aggiunge un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. È inoltre possibile specificare un campo errorType. A differenza di $util.error(String, String), la valutazione del modello non viene interrotta, in modo che i dati possano essere restituiti al chiamante.

$util.appendError(String, String, Object)

Aggiunge un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. È inoltre possibile specificare un campo errorType e un campo data. A differenza di $util.error(String, String, Object), la valutazione del modello non viene interrotta, in modo che i dati possano essere restituiti al chiamante. Il valore di data verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL.

Nota

dataverrà filtrato in base al set di selezione delle interrogazioni.

$util.appendError(String, String, Object, Object)

Aggiunge un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. Inoltre, è errorType possibile specificare un data campo, un errorInfo campo e un campo. A differenza di $util.error(String, String, Object, Object), la valutazione del modello non viene interrotta, in modo che i dati possano essere restituiti al chiamante. Il valore di data verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL.

Nota

dataverrà filtrato in base al set di selezione dell'interrogazione. Il valore di errorInfo verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL.

errorInfoNON verrà filtrato in base al set di selezione delle query.

Utilità per la convalida delle condizioni

Elenco degli strumenti di convalida delle condizioni

$util.validate(Boolean, String) : void

Se la condizione è falsa, lancia un messaggio CustomTemplateException con il messaggio specificato.

$util.validate(Boolean, String, String) : void

Se la condizione è falsa, genera un messaggio CustomTemplateException con il messaggio e il tipo di errore specificati.

$util.validate(Boolean, String, String, Object) : void

Se la condizione è falsa, genera un messaggio CustomTemplateException con il messaggio e il tipo di errore specificati, oltre ai dati da restituire nella risposta.

Utilità comportamentali nulle

Elenco di utilità con comportamento nullo

$util.isNull(Object) : Boolean

Restituisce true se l'oggetto fornito è null.

$util.isNullOrEmpty(String) : Boolean

Restituisce true se i dati forniti sono null o una stringa vuota. In caso contrario, restituisce false.

$util.isNullOrBlank(String) : Boolean

Restituisce true se i dati forniti sono null o una stringa vuota. In caso contrario, restituisce false.

$util.defaultIfNull(Object, Object) : Object

Restituisce il primo oggetto se non è null. In caso contrario, restituisce il secondo oggetto come "oggetto predefinito".

$util.defaultIfNullOrEmpty(String, String) : String

Restituisce la prima stringa se non è null o vuota. In caso contrario, restituisce la seconda stringa come "stringa predefinita".

$util.defaultIfNullOrBlank(String, String) : String

Restituisce la prima stringa se non è null o vuota. In caso contrario, restituisce la seconda stringa come "stringa predefinita".

Utilità per la corrispondenza dei modelli

Elenco degli strumenti per la corrispondenza dei tipi e dei modelli

$util.typeOf(Object) : String

Restituisce una stringa che descrive il tipo di oggetto. Le identificazioni di tipi supportate sono: "Null", "Number", "String", "Map", "List", "Boolean". Se un tipo non può essere identificato, il tipo restituito è "Object".

$util.matches(String, String) : Boolean

Restituisce true se il modello specificato nel primo argomento corrisponde ai dati forniti nel secondo argomento. Il modello deve essere un'espressione regolare, ad esempio $util.matches("a*b", "aaaaab"). La funzionalità si basa sulla classe Pattern che puoi consultare per ottenere altre informazioni.

$util.authType() : String

Restituisce una stringa che descrive il tipo di autenticazione multipla utilizzato da una richiesta, restituendo «IAM Authorization», «User Pool Authorization», «Open ID Connect Authorization» o «API Key Authorization».

Utilità per la convalida degli oggetti

Elenco degli strumenti di convalida degli oggetti

$util.isString(Object) : Boolean

Restituisce true se l'oggetto è una stringa.

$util.isNumber(Object) : Boolean

Restituisce true se l'oggetto è un numero.

$util.isBoolean(Object) : Boolean

Restituisce true se l'oggetto è un valore booleano.

$util.isList(Object) : Boolean

Restituisce true se l'oggetto è un elenco.

$util.isMap(Object) : Boolean

Restituisce true se l'oggetto è una mappa.

CloudWatch utilità di registrazione

CloudWatch lista di utilità di registrazione

$util.log.info(Object) : Void

Registra la rappresentazione String dell'oggetto fornito nel flusso di registro richiesto quando la registrazione a livello di richiesta e di campo è abilitata con il livello di CloudWatch log su un'API. ALL

$util.log.info(String, Object...) : Void

Registra la rappresentazione String degli oggetti forniti nel flusso di registro richiesto quando la registrazione a livello di richiesta e di campo è CloudWatch abilitata con il livello di log su un'API. ALL Questa utilità sostituirà tutte le variabili indicate da «{}» nella prima stringa di formato di input con la rappresentazione String degli oggetti forniti nell'ordine.

$util.log.error(Object) : Void

Registra la rappresentazione String dell'oggetto fornito nel flusso di log richiesto quando la CloudWatch registrazione a livello di campo è abilitata con livello di registro ERROR o livello di registro su un'API. ALL

$util.log.error(String, Object...) : Void

Registra la rappresentazione String degli oggetti forniti nel flusso di registro richiesto quando la registrazione a livello di campo è abilitata con livello di CloudWatch registro o livello di registro su un'API. ERROR ALL Questa utilità sostituirà tutte le variabili indicate da «{}» nella prima stringa di formato di input con la rappresentazione String degli oggetti forniti nell'ordine.

Restituisce il valore di comportamento (utils)

Elenco delle utilità di comportamento del valore restituito

$util.qr() e $util.quiet()

Esegue un'istruzione VTL mentre sopprime il valore restituito. Ciò è utile per eseguire metodi senza utilizzare segnaposti temporanei, ad esempio aggiungere elementi a una mappa. Per esempio:

#set ($myMap = {})
#set($discard = $myMap.put("id", "first value"))

Diventa:

#set ($myMap = {})
$util.qr($myMap.put("id", "first value"))

$util.escapeJavaScript(String) : String

Restituisce la stringa di input come stringa di JavaScript escape.

$util.urlEncode(String) : String

Restituisce la stringa di input come stringa codificata application/x-www-form-urlencoded.

$util.urlDecode(String) : String

Decodifica una stringa codificata application/x-www-form-urlencoded nella relativa forma non codificata.

$util.base64Encode( byte[] ) : String

Codifica l'input in una stringa con codifica base64.

$util.base64Decode(String) : byte[]

Decodifica i dati da una stringa con codifica base64.

$util.parseJson(String) : Object

Da una stringa JSON restituisce una rappresentazione oggetto del risultato.

$util.toJson(Object) : String

Da un oggetto restituisce una rappresentazione JSON "a stringhe" di tale oggetto.

$util.autoId() : String

Restituisce un valore UUID generato casualmente a 128 bit.

$util.autoUlid() : String

Restituisce un ULID (Universally Unique Lexicographically Sortable Identifier) generato casualmente a 128 bit.

$util.autoKsuid() : String

Restituisce un KSUID (K-Sortable Unique Identifier) base62 generato casualmente a 128 bit codificato come String con una lunghezza di 27.

$util.unauthorized()

Genera Unauthorized per il campo in fase di risoluzione. Utilizzalo nei modelli di mappatura delle richieste o delle risposte per determinare se consentire al chiamante di risolvere il campo.

$util.error(String)

Genera un errore personalizzato. Utilizzalo nei modelli di mappatura delle richieste o delle risposte per rilevare un errore nella richiesta o nel risultato della chiamata.

$util.error(String, String)

Genera un errore personalizzato. Usalo nei modelli di mappatura delle richieste o delle risposte per rilevare un errore nella richiesta o nel risultato dell'invocazione. Puoi anche specificare un. errorType

$util.error(String, String, Object)

Genera un errore personalizzato. Utilizzalo nei modelli di mappatura delle richieste o delle risposte per rilevare un errore nella richiesta o nel risultato della chiamata. Puoi anche specificare un campo errorType e un. data Il valore di data verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL. Nota: data verrà filtrato in base al set di selezioni della query.

$util.error(String, String, Object, Object)

Genera un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. È inoltre possibile specificare un campo errorType, un campo data e un campo errorInfo. Il valore di data verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL. Nota: data verrà filtrato in base al set di selezioni della query. Il valore di errorInfo verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL. Nota: errorInfo NON verrà filtrato in base al set di selezioni della query.

$util.appendError(String)

Aggiunge un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. A differenza di $util.error(String), la valutazione del modello non viene interrotta, in modo che i dati possano essere restituiti al chiamante.

$util.appendError(String, String)

Aggiunge un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. È inoltre possibile specificare un campo errorType. A differenza di $util.error(String, String), la valutazione del modello non viene interrotta, in modo che i dati possano essere restituiti al chiamante.

$util.appendError(String, String, Object)

Aggiunge un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. È inoltre possibile specificare un campo errorType e un campo data. A differenza di $util.error(String, String, Object), la valutazione del modello non viene interrotta, in modo che i dati possano essere restituiti al chiamante. Il valore di data verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL. Nota: data verrà filtrato in base al set di selezioni della query.

$util.appendError(String, String, Object, Object)

Aggiunge un errore personalizzato. Può essere usato nei modelli di mappatura di richieste o risposte se il modello rileva un errore nella richiesta o nel risultato della chiamata. È inoltre possibile specificare un campo errorType, un campo data e un campo errorInfo. A differenza di $util.error(String, String, Object, Object), la valutazione del modello non viene interrotta, in modo che i dati possano essere restituiti al chiamante. Il valore di data verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL. Nota: data verrà filtrato in base al set di selezioni della query. Il valore di errorInfo verrà aggiunto al blocco error corrispondente all'interno di errors nella risposta di GraphQL. Nota: errorInfo NON verrà filtrato in base al set di selezioni della query.

$util.validate(Boolean, String) : void

Se la condizione è falsa, lancia un messaggio CustomTemplateException con il messaggio specificato.

$util.validate(Boolean, String, String) : void

Se la condizione è falsa, genera un messaggio CustomTemplateException con il messaggio e il tipo di errore specificati.

$util.validate(Boolean, String, String, Object) : void

Se la condizione è falsa, genera un messaggio CustomTemplateException con il messaggio e il tipo di errore specificati, oltre ai dati da restituire nella risposta.

$util.isNull(Object) : Boolean

Restituisce true se l'oggetto fornito è null.

$util.isNullOrEmpty(String) : Boolean

Restituisce true se i dati forniti sono null o una stringa vuota. In caso contrario, restituisce false.

$util.isNullOrBlank(String) : Boolean

Restituisce true se i dati forniti sono null o una stringa vuota. In caso contrario, restituisce false.

$util.defaultIfNull(Object, Object) : Object

Restituisce il primo oggetto se non è null. In caso contrario, restituisce il secondo oggetto come "oggetto predefinito".

$util.defaultIfNullOrEmpty(String, String) : String

Restituisce la prima stringa se non è null o vuota. In caso contrario, restituisce la seconda stringa come "stringa predefinita".

$util.defaultIfNullOrBlank(String, String) : String

Restituisce la prima stringa se non è null o vuota. In caso contrario, restituisce la seconda stringa come "stringa predefinita".

$util.isString(Object) : Boolean

Restituisce true se l'oggetto è una stringa.

$util.isNumber(Object) : Boolean

Restituisce true se l'oggetto è un numero.

$util.isBoolean(Object) : Boolean

Restituisce true se l'oggetto è un valore booleano.

$util.isList(Object) : Boolean

Restituisce true se l'oggetto è un elenco.

$util.isMap(Object) : Boolean

Restituisce true se l'oggetto è una mappa.

$util.typeOf(Object) : String

Restituisce una stringa che descrive il tipo di oggetto. Le identificazioni di tipi supportate sono: "Null", "Number", "String", "Map", "List", "Boolean". Se un tipo non può essere identificato, il tipo restituito è "Object".

$util.matches(String, String) : Boolean

Restituisce true se il modello specificato nel primo argomento corrisponde ai dati forniti nel secondo argomento. Il modello deve essere un'espressione regolare, ad esempio $util.matches("a*b", "aaaaab"). La funzionalità si basa sulla classe Pattern che puoi consultare per ottenere altre informazioni.

$util.authType() : String

Restituisce una stringa che descrive il tipo di autenticazione multipla utilizzato da una richiesta, restituendo «IAM Authorization», «User Pool Authorization», «Open ID Connect Authorization» o «API Key Authorization».

$util.log.info(Object) : Void

Registra la rappresentazione in formato String dell'oggetto fornito nel flusso di registro richiesto quando la registrazione a livello di richiesta e di campo è abilitata con il livello di log su CloudWatch un'API. ALL

$util.log.info(String, Object...) : Void

Registra la rappresentazione String degli oggetti forniti nel flusso di registro richiesto quando la registrazione a livello di richiesta e di campo è CloudWatch abilitata con il livello di log su un'API. ALL Questa utilità sostituirà tutte le variabili indicate da «{}» nella prima stringa di formato di input con la rappresentazione String degli oggetti forniti nell'ordine.

$util.log.error(Object) : Void

Registra la rappresentazione String dell'oggetto fornito nel flusso di log richiesto quando la CloudWatch registrazione a livello di campo è abilitata con livello di registro ERROR o livello di registro su un'API. ALL

$util.log.error(String, Object...) : Void

Registra la rappresentazione String degli oggetti forniti nel flusso di registro richiesto quando la registrazione a livello di campo è abilitata con livello di CloudWatch registro o livello di registro su un'API. ERROR ALL Questa utilità sostituirà tutte le variabili indicate da «{}» nella prima stringa di formato di input con la rappresentazione String degli oggetti forniti nell'ordine.

$util.escapeJavaScript(String) : String

Restituisce la stringa di input come stringa JavaScript di escape.

Autorizzazione Resolver

Elenco di autorizzazioni del resolver

$util.unauthorized()

Genera Unauthorized per il campo in fase di risoluzione. Utilizzalo nei modelli di mappatura delle richieste o delle risposte per determinare se consentire al chiamante di risolvere il campo.