$util 中的实用程序帮助程序 - Amazon AppSync
Amazon Web Services 文档中描述的 Amazon Web Services 服务或功能可能因区域而异。要查看适用于中国区域的差异,请参阅中国的 Amazon Web Services 服务入门

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

$util 中的实用程序帮助程序

这些区域有:$util变量包含的通用实用程序方法可帮助您处理数据。

除非另行指定,否则所有实用程序均使用 UTF-8 字符集。

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

运行 VTL 语句,同时禁止返回的值。这对于运行方法而不使用临时占位符(例如添加项目到映射)非常有用。例如:

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

变为:

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

将输入字符串作为 JavaScript 转义字符串。

$util.urlEncode(String) : String

将输入字符串作为 application/x-www-form-urlencoded 编码字符串返回。

$util.urlDecode(String) : String

application/x-www-form-urlencoded 编码的字符串解码回未编码的形式。

$util.base64Encode( byte[] ) : String

将输入编码为 base64 编码字符串。

$util.base64Decode(String) : byte[]

对 base64 编码字符串中的数据进行解码。

$util.parseJson(String) : Object

获取“字符串化的”JSON 并返回结果的对象表示形式。

$util.toJson(Object) : String

获取对象并返回该对象“字符串化的”JSON 表示形式。

$util.autoId() : String

返回 128 位随机生成的 UUID。

$util.autoUlid() : String

返回 128 位随机生成的 ULID(通用唯一的字典顺序排序标识符)。

$util.autoKsuid() : String

返回一个 128 位随机生成的 KSUID(K-可排序唯一标识符)base62,编码为长度为 27 的字符串。

$util.unauthorized()

针对被解析的字段引发 Unauthorized。在请求或响应映射模板中使用此选项,确定是否允许调用者解析该字段。

$util.error(String)

引发自定义错误。在请求或响应映射模板中使用它可检测请求或调用结果的错误。

$util.error(String, String)

引发自定义错误。在请求或响应映射模板中使用它可检测请求或调用结果的错误。您也可以指定errorType.

$util.error(String, String, Object)

引发自定义错误。在请求或响应映射模板中使用它可检测请求或调用结果的错误。您也可以指定errorTypedata字段中返回的子位置类型。将在 GraphQL 响应中 data 内部对应的 error 块中添加 errors 值。注意:将根据查询选择集筛选 data

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

引发自定义错误。如果模板检测到请求或调用结果的错误,可用于请求或响应映射模板中。此外,还可指定 errorTypedataerrorInfo 字段。将在 GraphQL 响应中 data 内部对应的 error 块中添加 errors 值。注意:将根据查询选择集筛选 data。将在 GraphQL 响应中 errorInfo 内部对应的 error 块中添加 errors 值。注意errorInfo不会根据查询选择集筛选

$util.appendError(String)

追加自定义错误。如果模板检测到请求或调用结果的错误,可用于请求或响应映射模板中。与 $util.error(String) 不同,不会中断模板评估,所以数据可以返回调用者。

$util.appendError(String, String)

追加自定义错误。如果模板检测到请求或调用结果的错误,可用于请求或响应映射模板中。此外,还可指定 errorType。与 $util.error(String, String) 不同,不会中断模板评估,所以数据可以返回调用者。

$util.appendError(String, String, Object)

追加自定义错误。如果模板检测到请求或调用结果的错误,可用于请求或响应映射模板中。此外,还可指定 errorTypedata 字段。与 $util.error(String, String, Object) 不同,不会中断模板评估,所以数据可以返回调用者。将在 GraphQL 响应中 data 内部对应的 error 块中添加 errors 值。注意:将根据查询选择集筛选 data

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

追加自定义错误。如果模板检测到请求或调用结果的错误,可用于请求或响应映射模板中。此外,还可指定 errorTypedataerrorInfo 字段。与 $util.error(String, String, Object, Object) 不同,不会中断模板评估,所以数据可以返回调用者。将在 GraphQL 响应中 data 内部对应的 error 块中添加 errors 值。注意:将根据查询选择集筛选 data。将在 GraphQL 响应中 errorInfo 内部对应的 error 块中添加 errors 值。注意errorInfo不会根据查询选择集筛选

$util.validate(Boolean, String) : void

如果条件为 false,抛出 CustomTemplateException 带有指定消息。

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

如果条件为 false,抛出 CustomTemplateException 具有指定的消息和错误类型。

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

如果条件为 false,抛出 CustomTemplateException 具有指定消息和错误类型,以及响应中返回的数据的数据。

$util.isNull(Object) : Boolean

如果提供的对象为 null 则返回 true。

$util.isNullOrEmpty(String) : Boolean

如果提供的数据为 null 或空字符串,则返回 true。否则返回 false。

$util.isNullOrBlank(String) : Boolean

如果提供的数据为 null 或空白字符串,则返回 true。否则返回 false。

$util.defaultIfNull(Object, Object) : Object

如果首个对象非 null,则返回它。否则返回第二个对象,作为“默认对象”。

$util.defaultIfNullOrEmpty(String, String) : String

如果首个字符串非 null 也非空,则返回它。否则返回第二个字符串,作为“默认字符串”。

$util.defaultIfNullOrBlank(String, String) : String

如果首个字符串非 null 也非空白,则返回它。否则返回第二个字符串,作为“默认字符串”。

$util.isString(Object) : Boolean

如果对象是字符串,则返回 true。

$util.isNumber(Object) : Boolean

如果对象是数字,则返回 true。

$util.isBoolean(Object) : Boolean

如果对象是布尔值.

$util.isList(Object) : Boolean

如果对象是列表,则返回 true。

$util.isMap(Object) : Boolean

如果对象是映射,则返回 true。

$util.typeOf(Object) : String

返回字符串,描述对象的类型。支持的类型标识包括:“Null"、"Number"、"Number"(Number ")"。布尔值“。如果无法识别类型,则返回 "Object" 类型。

$util.matches(String, String) : Boolean

如果在第一个参数中指定的模式与第二个参数中提供的数据匹配,则返回 true。模式必须为正则表达式,例如 $util.matches("a*b", "aaaaab")。此功能以模式为基础,您可参考其他文档,进一步了解此内容。

$util.authType() : String

返回描述请求使用的多身份验证类型的字符串,返回 “IAM 授权”、“用户池授权”、“开放 ID Connect 授权” 或 “API 密钥授权”。

$util.log.info(Object) : Void

当请求级别和字段级别时,将所提供对象的字符串表示记录到请求的日志流 CloudWatch 使用日志级别启用了日志记录ALL在 API 上。

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

当请求级别和字段级别时,将所提供对象的字符串表示记录到请求的日志流 CloudWatch 使用日志级别启用了日志记录ALL在 API 上。此实用程序将按顺序将第一个输入格式 String 中由 “{}” 指示的所有变量替换为所提供对象的字符串表示形式。

$util.log.error(Object) : Void

当字段级别时,将所提供对象的字符串表示记录到请求的日志流 CloudWatch 使用日志级别启用了日志记录ERROR或日志级别ALL在 API 上。

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

在字段级别时,将所提供对象的字符串表示记录到请求的日志流 CloudWatch 使用日志级别启用了日志记录ERROR或日志级别ALL在 API 上。此实用程序将按顺序将第一个输入格式 String 中由 “{}” 指示的所有变量替换为所提供对象的字符串表示形式。