Method: projects.tenants.patch

更新指定的租户。

HTTP 请求

PATCH https://jobs.googleapis.com/v4beta1/{tenant.name=projects/*/tenants/*}

网址采用 gRPC 转码语法。

路径参数

参数
tenant.name

string

更新租户期间需要执行此操作。

租户的资源名称。此名称由服务在创建租户时生成。

格式为“projects/{projectId}/tenants/{tenantId}”，例如“projects/foo/tenants/bar”。

请求正文

请求正文中包含结构如下的数据：

JSON 表示法 
{
  "tenant": {
    "name": string,
    "externalId": string,
    "usageType": enum (DataUsageType),
    "keywordSearchableProfileCustomAttributes": [
      string
    ]
  },
  "updateMask": string
}
字段
tenant.externalId

string

必需。客户端租户标识符，用于唯一标识租户。

允许的最大字符数为 255。
tenant.usageType

enum (DataUsageType)

指明此租户所拥有的数据是否可以用于为其他租户提供产品改进。

如果未设置，则默认行为为 DataUsageType.ISOLATED。
tenant.keywordSearchableProfileCustomAttributes[]

string

可过滤 Profile.custom_attributes 的键列表，其对应的 stringValues 用于关键字搜索。如果有任何值与搜索关键字匹配，则返回这些指定字段键下包含 stringValues 的个人资料。带圆括号、方括号和特殊符号的自定义字段值不能按原样搜索，必须用引号括起来。
updateMask

string (FieldMask format)

强烈建议提供，以获得最佳服务体验。

如果提供了 updateMask，则仅更新 tenant 中的指定字段。否则更新所有字段。

用于指定要更新的租户字段的字段掩码。仅支持 Tenant 的顶级字段。

以逗号分隔的完全限定字段名称列表。示例："user.displayName,photo"。

响应正文

如果成功，则响应正文包含一个 Tenant 实例。

授权范围

需要以下 OAuth 范围之一：

  • https://www.googleapis.com/auth/jobs
  • https://www.googleapis.com/auth/cloud-platform

如需了解详情，请参阅身份验证概览。