更新字段配置。目前,字段更新仅适用于单字段索引配置。但是,对FirestoreAdmin.UpdateField
调用应提供字段掩码,以避免更改调用者不知道的任何配置。字段掩码应指定为: { paths: "indexConfig" }
。
此调用返回google.longrunning.Operation
,可用于跟踪字段更新的状态。操作的元数据将是FieldOperationMetadata
类型。
要配置数据库的默认字段设置,请使用具有资源名称的特殊Field
: projects/{projectId}/databases/{databaseId}/collectionGroups/__default__/fields/*
。
HTTP请求
PATCH https://firestore.googleapis.com/v1/{field.name=projects/*/databases/*/collectionGroups/*/fields/*}
URL 使用gRPC 转码语法。
路径参数
参数 | |
---|---|
field.name | 必需的。 字段路径可以是简单的字段名称,例如 字段路径可以使用 示例:(注意:这里的注释是用 markdown 语法写的,所以多了一层反引号来表示代码块) 特殊 |
查询参数
参数 | |
---|---|
updateMask | 掩模,相对于场。如果指定,则只有此 field_mask 指定的配置才会在字段中更新。 这是一个以逗号分隔的字段完全限定名称列表。示例: |
请求正文
请求正文包含Field
的实例。
响应体
如果成功,响应正文将包含一个Operation
实例。
授权范围
需要以下 OAuth 范围之一:
-
https://www.googleapis.com/auth/datastore
-
https://www.googleapis.com/auth/cloud-platform
有关详细信息,请参阅身份验证概述。