如需了解此资源的方法列表,请参阅本页结尾部分。
资源表示法
用于描述由服务支持的类型的类型提供程序。
{ "name": string, "id": unsigned long, "insertTime": string, "description": string, "selfLink": string, "operation": operations Resource, "labels": [ { "key": string, "value": string } ], "descriptorUrl": string, "credential": { "basicAuth": { "user": string, "password": string }, "serviceAccount": { "email": string }, "useProjectDefault": boolean }, "options": { "inputMappings": [ { "fieldName": string, "methodMatch": string, "value": string, "location": string } ], "validationOptions": { "undeclaredProperties": string, "schemaValidation": string }, "virtualProperties": string, "asyncOptions": [ { "methodMatch": string, "pollingOptions": { "finishCondition": string, "failCondition": string, "targetLink": string, "pollingLink": string, "diagnostics": [ { "field": string, "level": string } ] } } ] }, "collectionOverrides": [ { "collection": string, "options": { "inputMappings": [ { "fieldName": string, "methodMatch": string, "value": string, "location": string } ], "validationOptions": { "undeclaredProperties": string, "schemaValidation": string }, "virtualProperties": string, "asyncOptions": [ { "methodMatch": string, "pollingOptions": { "finishCondition": string, "failCondition": string, "targetLink": string, "pollingLink": string, "diagnostics": [ { "field": string, "level": string } ] } } ] } } ], "customCertificateAuthorityRoots": [ string ] }
属性名称 | 值 | 说明 | 备注 |
---|---|---|---|
collectionOverrides[] |
list |
允许为特定集合替换资源处理 | |
collectionOverrides[].collection |
string |
用于在其服务中标识此资源的集合。 | |
collectionOverrides[].options |
nested object |
要应用于此资源级替换项的选项 | |
collectionOverrides[].options.asyncOptions[] |
list |
有关如何将异步请求串行处理的选项。 | |
collectionOverrides[].options.asyncOptions[].methodMatch |
string |
此政策适用的方法正则表达式。 | |
collectionOverrides[].options.asyncOptions[].pollingOptions |
nested object |
部署管理器将轮询此 API 资源的实例,并将状态设置为 RUNNING,并在轮询条件表明资源是已完成还是已失败之前进行阻塞。 | |
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] |
list |
要由 Deployment Manager 收集的诊断信息数组,这些诊断信息将显示给用户。 | |
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].field |
string |
资源上的 JsonPath 表达式,如果不为空,则表示需要将此字段提取为诊断信息。 | |
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level |
string |
用于记录此诊断信息的级别。 | |
collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition |
string |
用于确定请求是否失败的 JsonPath 表达式。 | |
collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition |
string |
用于确定请求是否已完成的 JsonPath 表达式。 | |
collectionOverrides[].options.asyncOptions[].pollingOptions.pollingLink |
string |
一个求值为字符串的 JsonPath 表达式,用于指明要轮询的位置。 | |
collectionOverrides[].options.asyncOptions[].pollingOptions.targetLink |
string |
轮询完成后,JsonPath 表达式会指明要从何处提取资源。 | |
collectionOverrides[].options.inputMappings[] |
list |
适用于请求的映射。 | |
collectionOverrides[].options.inputMappings[].fieldName |
string |
要注入的字段的名称。 | |
collectionOverrides[].options.inputMappings[].location |
string |
此映射的适用位置。 | |
collectionOverrides[].options.inputMappings[].methodMatch |
string |
用于对方法进行评估以确定输入是否适用的正则表达式。 | |
collectionOverrides[].options.inputMappings[].value |
string |
用于选择元素的 JSONPath 表达式。 | |
collectionOverrides[].options.validationOptions |
nested object |
用于验证和处理资源属性的方法选项。 | |
collectionOverrides[].options.validationOptions.schemaValidation |
string |
自定义 Deployment Manager 如何针对架构错误验证资源。 | |
collectionOverrides[].options.validationOptions.undeclaredProperties |
string |
指定在执行请求时如何处理额外属性。 | |
collectionOverrides[].options.virtualProperties |
string |
额外的属性块描述为 jsonSchema,这些属性绝不会成为 json 载荷的一部分,但可以由 InputMappings 使用,这必须是有效的 json 架构草稿-04。此处指定的属性将在其他部分解耦。此架构将合并到架构验证中,此处的属性将从载荷中提取,并由 InputMappings 明确使用。例如:field1: type: string field2: type: number | |
credential |
nested object |
与此类型交互时使用的凭据。 | |
credential.basicAuth |
nested object |
基本身份验证凭据,仅供 TypeProvider 使用。 | |
credential.basicAuth.password |
string |
||
credential.basicAuth.user |
string |
||
credential.serviceAccount |
nested object |
服务账号凭据,仅供部署使用。 | |
credential.serviceAccount.email |
string |
IAM 服务账号电子邮件地址,例如 test@myproject.iam.gserviceaccount.com | |
credential.useProjectDefault |
boolean |
指定使用项目默认凭据,仅限部署支持。 | |
customCertificateAuthorityRoots[] |
list |
最多 2 个自定义证书授权机构根证书的列表,用于在代表此类型提供程序进行调用时进行 TLS 身份验证。如果设置了此参数,TLS 身份验证在验证 TLS 证书的真实性时将仅使用这些根证书,而不是依赖于可信的公共证书授权机构。证书必须采用 base64 编码的 PEM 格式。每个证书的大小不得超过 10KB。 | |
description |
string |
资源的可选文本描述;创建资源时由客户提供。 | |
descriptorUrl |
string |
此类型提供程序的描述符网址。 | |
id |
unsigned long |
仅限输出。服务器定义的资源的唯一标识符。 | |
insertTime |
string |
仅限输出。创建时间戳,采用 RFC3339 文本格式。 | |
labels[] |
list |
标签映射;由客户端在创建或更新资源时提供。具体而言:标签键的长度必须介于 1 到 63 个字符之间,并且必须符合以下正则表达式:`[a-z]([-a-z0-9]*[a-z0-9])?`。标签值的长度必须介于 0 到 63 个字符之间,并且必须符合正则表达式 `([a-z]([-a-z0-9]*[a-z0-9])?)?`。 |
|
labels[].key |
string |
||
labels[].value |
string |
||
name |
string |
资源的名称;由客户端在创建资源时提供。名称的长度必须为 1-63 个字符,并且符合 RFC1035 的要求。具体而言,名称长度必须介于 1-63 个字符之间,并且与正则表达式 `[a-z]([-a-z0-9]*[a-z0-9])?` 匹配。这意味着第一个字符必须是小写字母,后面所有字符必须是短划线、小写字母或数字,但最后一个字符不能是短划线。 | |
operation |
nested object |
仅限输出。在此类型提供程序上最近运行或正在运行的操作。 | |
options |
nested object |
处理此服务中的任何资源时要应用的选项。 | |
options.asyncOptions[] |
list |
有关如何将异步请求串行处理的选项。 | |
options.asyncOptions[].methodMatch |
string |
此政策适用的方法正则表达式。 | |
options.asyncOptions[].pollingOptions |
nested object |
部署管理器将轮询此 API 资源的实例,并将状态设置为 RUNNING,并在轮询条件表明资源是已完成还是已失败之前进行阻塞。 | |
options.asyncOptions[].pollingOptions.diagnostics[] |
list |
要由 Deployment Manager 收集的诊断信息数组,这些诊断信息将显示给用户。 | |
options.asyncOptions[].pollingOptions.diagnostics[].field |
string |
资源上的 JsonPath 表达式,如果不为空,则表示需要将此字段提取为诊断信息。 | |
options.asyncOptions[].pollingOptions.diagnostics[].level |
string |
用于记录此诊断信息的级别。 | |
options.asyncOptions[].pollingOptions.failCondition |
string |
用于确定请求是否失败的 JsonPath 表达式。 | |
options.asyncOptions[].pollingOptions.finishCondition |
string |
用于确定请求是否已完成的 JsonPath 表达式。 | |
options.asyncOptions[].pollingOptions.pollingLink |
string |
一个求值为字符串的 JsonPath 表达式,用于指明要轮询的位置。 | |
options.asyncOptions[].pollingOptions.targetLink |
string |
轮询完成后,JsonPath 表达式会指明要从何处提取资源。 | |
options.inputMappings[] |
list |
适用于请求的映射。 | |
options.inputMappings[].fieldName |
string |
要注入的字段的名称。 | |
options.inputMappings[].location |
string |
此映射的适用位置。 | |
options.inputMappings[].methodMatch |
string |
用于对方法进行评估以确定输入是否适用的正则表达式。 | |
options.inputMappings[].value |
string |
用于选择元素的 JSONPath 表达式。 | |
options.validationOptions |
nested object |
用于验证和处理资源属性的方法选项。 | |
options.validationOptions.schemaValidation |
string |
自定义 Deployment Manager 如何针对架构错误验证资源。 | |
options.validationOptions.undeclaredProperties |
string |
指定在执行请求时如何处理额外属性。 | |
options.virtualProperties |
string |
额外的属性块描述为 jsonSchema,这些属性绝不会成为 json 载荷的一部分,但可以由 InputMappings 使用,这必须是有效的 json 架构草稿-04。此处指定的属性将在其他部分解耦。此架构将合并到架构验证中,此处的属性将从载荷中提取,并由 InputMappings 明确使用。例如:field1: type: string field2: type: number | |
selfLink |
string |
仅限输出。类型提供程序的自链接。 |