Utilitários auxiliares em $util

nota

Agora, oferecemos suporte principalmente ao tempo de execução APPSYNC _JS e sua documentação. Considere usar o tempo de execução APPSYNC _JS e seus guias aqui.

A variável $util contém métodos utilitários gerais para ajudar você a trabalhar com dados.​ A menos que especificado de outra forma, todos os utilitários usam o conjunto UTF de caracteres -8.

JSONutilitários de análise

JSONlista de utilitários de análise

$util.parseJson(String) : Object

Toma “stringified” JSON e retorna uma representação do objeto do resultado.

$util.toJson(Object) : String

Pega um objeto e retorna uma JSON representação “sequencial” desse objeto.

Utilitários de codificação

Lista de utilitários de codificação

$util.urlEncode(String) : String

Retorna a string de entrada como uma string codificada application/x-www-form-urlencoded.

$util.urlDecode(String) : String

Decodifica uma string codificada application/x-www-form-urlencoded de volta ao seu formato não codificado.

$util.base64Encode( byte[] ) : String

Codifica a entrada em uma string codificada em base64.

$util.base64Decode(String) : byte[]

Decodifica os dados de uma string codificada em base64.

Utilitários de geração de ID

Lista de utilitários de geração de ID

$util.autoId() : String

Retorna um arquivo de 128 bits gerado aleatoriamente. UUID

$util.autoUlid() : String

Retorna um identificador de 128 bits gerado aleatoriamente ULID (identificador lexicograficamente classificável universalmente exclusivo).

$util.autoKsuid() : String

Retorna uma base62 de 128 bits gerada aleatoriamente KSUID (K-Sortable Unique Identifier) codificada como uma string com um comprimento de 27.

Utilitários de erro

Lista de utilitários de erro

$util.error(String)

Lança um erro personalizado. Use em modelos de mapeamento de solicitação ou resposta para detectar um erro na solicitação ou no resultado da invocação.

$util.error(String, String)

Lança um erro personalizado. Use em modelos de mapeamento de solicitação ou resposta para detectar um erro na solicitação ou no resultado da invocação. Também é possível especificar um errorType.

$util.error(String, String, Object)

Lança um erro personalizado. Use em modelos de mapeamento de solicitação ou resposta para detectar um erro na solicitação ou no resultado da invocação. Você também pode especificar um errorType e um campo data. O valor data será adicionado ao bloco error correspondente em errors na resposta do GraphQL.

nota

data será filtrado com base no conjunto de seleção da consulta.

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

Lança um erro personalizado. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Além disso, é possível especificar os campos errorType, data e errorInfo. O valor data será adicionado ao bloco error correspondente em errors na resposta do GraphQL.

nota

data será filtrado com base no conjunto de seleção da consulta. O valor errorInfo será adicionado ao bloco error correspondente em errors na resposta do GraphQL.

errorInfoNOTserá filtrado com base no conjunto de seleção da consulta.

$util.appendError(String)

Anexa um erro personalizado no final. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Diferente de $util.error(String), a avaliação do modelo não será interrompida para que os dados possam ser retornados ao chamador.

$util.appendError(String, String)

Anexa um erro personalizado no final. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Além disso, um errorType pode ser especificado. Diferente de $util.error(String, String), a avaliação do modelo não será interrompida para que os dados possam ser retornados ao chamador.

$util.appendError(String, String, Object)

Anexa um erro personalizado no final. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Além disso, um errorType e um campo data podem ser especificados. Diferente de $util.error(String, String, Object), a avaliação do modelo não será interrompida para que os dados possam ser retornados ao chamador. O valor data será adicionado ao bloco error correspondente em errors na resposta do GraphQL.

nota

data será filtrado com base no conjunto de seleção da consulta.

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

Anexa um erro personalizado no final. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Além disso, é possível especificar os campos errorType, data e errorInfo. Diferente de $util.error(String, String, Object, Object), a avaliação do modelo não será interrompida para que os dados possam ser retornados ao chamador. O valor data será adicionado ao bloco error correspondente em errors na resposta do GraphQL.

nota

data será filtrado com base no conjunto de seleção da consulta. O valor errorInfo será adicionado ao bloco error correspondente em errors na resposta do GraphQL.

errorInfoNOTserá filtrado com base no conjunto de seleção da consulta.

Utilitários de validação de condições

Lista de utilitários de validação de condição

$util.validate(Boolean, String) : void

Se a condição for falsa, lance um CustomTemplateException com a mensagem especificada.

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

Se a condição for falsa, lance um CustomTemplateException com a mensagem e o tipo de erro especificados.

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

Se a condição for falsa, lance um CustomTemplateException com a mensagem e o tipo de erro especificados, bem como os dados a serem retornados na resposta.

Utilitários de comportamento nulo

Lista de utilitários de comportamento nulo

$util.isNull(Object) : Boolean

Retorna verdadeiro se o objeto fornecido for nulo.

$util.isNullOrEmpty(String) : Boolean

Retorna verdadeiro, se os dados fornecidos forem nulos ou uma string vazia. Caso contrário, retornará falso.

$util.isNullOrBlank(String) : Boolean

Retorna verdadeiro, se os dados fornecidos forem nulos ou uma string em branco. Caso contrário, retornará falso.

$util.defaultIfNull(Object, Object) : Object

Retorna o primeiro Objeto que não seja nulo. Caso contrário, retorna o segundo objeto como um "Objeto padrão".

$util.defaultIfNullOrEmpty(String, String) : String

Retorna a primeira String se não for nula ou vazia. Caso contrário, retorna a segunda String como uma "String padrão".

$util.defaultIfNullOrBlank(String, String) : String

Retorna a primeira String se não for nula ou em branco. Caso contrário, retorna a segunda String como uma "String padrão".

Utilitários de correspondência de padrões

Lista de utilitários de correspondência de tipos e padrões

$util.typeOf(Object) : String

Retorna uma String que descreve o tipo do Objeto. As identificações de tipo compatíveis são: "Nulo", "Número", "String", "Mapa", "Lista", "Booliano". Se um tipo não puder ser identificado, o tipo de retorno é "Objeto".

$util.matches(String, String) : Boolean

Retorna verdadeiro se o padrão especificado no primeiro argumento corresponde aos dados fornecidos no segundo argumento. O padrão deve ser uma expressão regular, como $util.matches("a*b", "aaaaab"). A funcionalidade se baseia em Padrão, que você pode consultar para obter documentação adicional.

$util.authType() : String

Retorna uma string descrevendo o tipo de autenticação múltipla que está sendo usado por uma solicitação, retornando “IAMAutorização”, “Autorização do grupo de usuários”, “Autorização do Open ID Connect” ou “Autorização da API chave”.

Utilitários de validação de objetos

Lista de utilitários de validação de objeto

$util.isString(Object) : Boolean

Retorna verdadeiro se o Objeto for uma String.

$util.isNumber(Object) : Boolean

Retorna verdadeiro se o Objeto for um Número.

$util.isBoolean(Object) : Boolean

Retorna verdadeiro se o Objeto for um Booliano.

$util.isList(Object) : Boolean

Retorna verdadeiro se o Objeto for uma Lista.

$util.isMap(Object) : Boolean

Retorna verdadeiro se o Objeto for um Mapa.

CloudWatch utilitários de registro

CloudWatch lista de utilitários de registro

$util.log.info(Object) : Void

Registra a representação de string do objeto fornecido no fluxo de registro solicitado quando o registro em nível de solicitação e em nível de campo é ativado com o nível de CloudWatch registro em um. ALL API

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

Registra a representação de string dos objetos fornecidos no fluxo de log solicitado quando o registro em nível de solicitação e em nível de campo é ativado com o nível CloudWatch de log em um. ALL API Esse utilitário substituirá todas as variáveis indicadas por "{}" no primeiro formato de entrada String pela representação String dos objetos fornecidos em ordem.

$util.log.error(Object) : Void

Registra a representação de string do objeto fornecido no fluxo de log solicitado quando o registro em nível de campo CloudWatch é habilitado com nível de log ERROR ou nível de log ALL em um. API

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

Registra a representação de string dos objetos fornecidos no fluxo de log solicitado quando o registro em nível de campo CloudWatch é habilitado com nível de log ERROR ou nível de log ALL em um. API Esse utilitário substituirá todas as variáveis indicadas por "{}" no primeiro formato de entrada String pela representação String dos objetos fornecidos em ordem.

Utilitários de comportamento do valor de retorno

Lista de utilitários de comportamento de valor de retorno​

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

Executa uma VTL instrução enquanto suprime o valor retornado. Isso é útil para executar métodos sem usar espaços reservados temporários, como adicionar itens a um mapa. Por exemplo: .

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

Se torna:

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

$util.escapeJavaScript(String) : String

Retorna a string de entrada como uma string JavaScript de escape.

$util.urlEncode(String) : String

Retorna a string de entrada como uma string codificada application/x-www-form-urlencoded.

$util.urlDecode(String) : String

Decodifica uma string codificada application/x-www-form-urlencoded de volta ao seu formato não codificado.

$util.base64Encode( byte[] ) : String

Codifica a entrada em uma string codificada em base64.

$util.base64Decode(String) : byte[]

Decodifica os dados de uma string codificada em base64.

$util.parseJson(String) : Object

Toma “stringified” JSON e retorna uma representação do objeto do resultado.

$util.toJson(Object) : String

Pega um objeto e retorna uma JSON representação “sequencial” desse objeto.

$util.autoId() : String

Retorna um arquivo de 128 bits gerado aleatoriamente. UUID

$util.autoUlid() : String

Retorna um identificador de 128 bits gerado aleatoriamente ULID (identificador lexicograficamente classificável universalmente exclusivo).

$util.autoKsuid() : String

Retorna uma base62 de 128 bits gerada aleatoriamente KSUID (K-Sortable Unique Identifier) codificada como uma string com um comprimento de 27.

$util.unauthorized()

Lança Unauthorized para o campo a ser resolvido. Use em modelos de mapeamento de solicitação ou resposta para determinar se é preciso ou não permitir que o chamador resolva o campo.

$util.error(String)

Lança um erro personalizado. Use em modelos de mapeamento de solicitação ou resposta para detectar um erro na solicitação ou no resultado da invocação.

$util.error(String, String)

Lança um erro personalizado. Use em modelos de mapeamento de solicitação ou resposta para detectar um erro na solicitação ou no resultado da invocação. Também é possível especificar um errorType.

$util.error(String, String, Object)

Lança um erro personalizado. Use em modelos de mapeamento de solicitação ou resposta para detectar um erro na solicitação ou no resultado da invocação. Você também pode especificar um errorType e um campo data. O valor data será adicionado ao bloco error correspondente em errors na resposta do GraphQL. Observação: data será filtrado com base no conjunto de seleção da consulta.

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

Lança um erro personalizado. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Além disso, um campo errorType, um campo data e um campo errorInfo podem ser especificados. O valor data será adicionado ao bloco error correspondente em errors na resposta do GraphQL. Observação: data será filtrado com base no conjunto de seleção da consulta. O valor errorInfo será adicionado ao bloco error correspondente em errors na resposta do GraphQL. Nota: errorInfo NOTserá filtrado com base no conjunto de seleção da consulta.

$util.appendError(String)

Anexa um erro personalizado no final. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Diferente de $util.error(String), a avaliação do modelo não será interrompida para que os dados possam ser retornados ao chamador.

$util.appendError(String, String)

Anexa um erro personalizado no final. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Além disso, um errorType pode ser especificado. Diferente de $util.error(String, String), a avaliação do modelo não será interrompida para que os dados possam ser retornados ao chamador.

$util.appendError(String, String, Object)

Anexa um erro personalizado no final. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Além disso, um errorType e um campo data podem ser especificados. Diferente de $util.error(String, String, Object), a avaliação do modelo não será interrompida para que os dados possam ser retornados ao chamador. O valor data será adicionado ao bloco error correspondente em errors na resposta do GraphQL. Observação: data será filtrado com base no conjunto de seleção da consulta.

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

Anexa um erro personalizado no final. Isso pode ser usado em modelos de mapeamento da solicitação ou resposta se o modelo detectar um erro com a solicitação ou com o resultado da invocação. Além disso, um campo errorType, um campo data e um campo errorInfo podem ser especificados. Diferente de $util.error(String, String, Object, Object), a avaliação do modelo não será interrompida para que os dados possam ser retornados ao chamador. O valor data será adicionado ao bloco error correspondente em errors na resposta do GraphQL. Observação: data será filtrado com base no conjunto de seleção da consulta. O valor errorInfo será adicionado ao bloco error correspondente em errors na resposta do GraphQL. Nota: errorInfo NOTserá filtrado com base no conjunto de seleção da consulta.

$util.validate(Boolean, String) : void

Se a condição for falsa, lance um CustomTemplateException com a mensagem especificada.

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

Se a condição for falsa, lance um CustomTemplateException com a mensagem e o tipo de erro especificados.

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

Se a condição for falsa, lance um CustomTemplateException com a mensagem e o tipo de erro especificados, bem como os dados a serem retornados na resposta.

$util.isNull(Object) : Boolean

Retorna verdadeiro se o objeto fornecido for nulo.

$util.isNullOrEmpty(String) : Boolean

Retorna verdadeiro, se os dados fornecidos forem nulos ou uma string vazia. Caso contrário, retornará falso.

$util.isNullOrBlank(String) : Boolean

Retorna verdadeiro, se os dados fornecidos forem nulos ou uma string em branco. Caso contrário, retornará falso.

$util.defaultIfNull(Object, Object) : Object

Retorna o primeiro Objeto que não seja nulo. Caso contrário, retorna o segundo objeto como um "Objeto padrão".

$util.defaultIfNullOrEmpty(String, String) : String

Retorna a primeira String se não for nula ou vazia. Caso contrário, retorna a segunda String como uma "String padrão".

$util.defaultIfNullOrBlank(String, String) : String

Retorna a primeira String se não for nula ou em branco. Caso contrário, retorna a segunda String como uma "String padrão".

$util.isString(Object) : Boolean

Retorna verdadeiro se o Objeto for uma String.

$util.isNumber(Object) : Boolean

Retorna verdadeiro se o Objeto for um Número.

$util.isBoolean(Object) : Boolean

Retorna verdadeiro se o Objeto for um Booliano.

$util.isList(Object) : Boolean

Retorna verdadeiro se o Objeto for uma Lista.

$util.isMap(Object) : Boolean

Retorna verdadeiro se o Objeto for um Mapa.

$util.typeOf(Object) : String

Retorna uma String que descreve o tipo do Objeto. As identificações de tipo compatíveis são: "Nulo", "Número", "String", "Mapa", "Lista", "Booliano". Se um tipo não puder ser identificado, o tipo de retorno é "Objeto".

$util.matches(String, String) : Boolean

Retorna verdadeiro se o padrão especificado no primeiro argumento corresponde aos dados fornecidos no segundo argumento. O padrão deve ser uma expressão regular, como $util.matches("a*b", "aaaaab"). A funcionalidade se baseia em Padrão, que você pode consultar para obter documentação adicional.

$util.authType() : String

Retorna uma string descrevendo o tipo de autenticação múltipla que está sendo usado por uma solicitação, retornando “IAMAutorização”, “Autorização do grupo de usuários”, “Autorização do Open ID Connect” ou “Autorização da API chave”.

$util.log.info(Object) : Void

Registra a representação de string do objeto fornecido no fluxo de registro solicitado quando o registro em nível de solicitação e em nível de campo é ativado com o nível de CloudWatch registro em um. ALL API

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

Registra a representação de string dos objetos fornecidos no fluxo de log solicitado quando o registro em nível de solicitação e em nível de campo é ativado com o nível CloudWatch de log em um. ALL API Esse utilitário substituirá todas as variáveis indicadas por "{}" no primeiro formato de entrada String pela representação String dos objetos fornecidos em ordem.

$util.log.error(Object) : Void

Registra a representação de string do objeto fornecido no fluxo de log solicitado quando o registro em nível de campo CloudWatch é habilitado com nível de log ERROR ou nível de log ALL em um. API

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

Registra a representação de string dos objetos fornecidos no fluxo de log solicitado quando o registro em nível de campo CloudWatch é habilitado com nível de log ERROR ou nível de log ALL em um. API Esse utilitário substituirá todas as variáveis indicadas por "{}" no primeiro formato de entrada String pela representação String dos objetos fornecidos em ordem.

$util.escapeJavaScript(String) : String

Retorna a string de entrada como uma string JavaScript de escape.

Autorização do resolvedor

Lista de autorização do resolvedor

$util.unauthorized()

Lança Unauthorized para o campo a ser resolvido. Use em modelos de mapeamento de solicitação ou resposta para determinar se é preciso ou não permitir que o chamador resolva o campo.