Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
×
BatchUpdate
POST /v1/groupsbatch
参数 (Parameters)
响应 (Responses)
| 代码 (Code) | 消息 (Message) | 数据类型 (Datatype) |
|---|---|---|
200 |
成功的响应。(A successful response.) |
|
0 |
意外的错误响应。(An unexpected error response.) |
常用对象引用 (Common object reference)
GooglerpcStatus
| 字段名称 (Field Name) | 必填 (Required) | 可为空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
|---|---|---|---|---|---|
代码 (code) |
整数 (Integer) |
int32 |
|||
消息 (message) |
字符串 (String) |
||||
详情 (details) |
ProtobufAny 列表 (List of ProtobufAny) |
ProtobufAny
Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 URL。
Protobuf 库提供支持，以实用程序函数或 Any 类型的附加生成方法的形式打包/解包 Any 值。
示例 1：在 C++ 中打包和解包消息。
示例 2：在 Java 中打包和解包消息。
Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
foo = any.unpack(Foo.getDefaultInstance());
}
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
Example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
...
}
Protobuf 库提供的打包方法默认使用“type.googleapis.com/full.type.name”作为类型 URL，解包方法仅使用类型 URL 中最后一个“/”后的全限定类型名称，例如“foo.bar.com/x/y.z”将产生类型名称“y.z”。
JSON 表示 (JSON representation)
Any 值的 JSON 表示使用反序列化的嵌入式消息的常规表示，以及包含类型 URL 的附加字段@type。示例 (Example)
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
如果嵌入式消息类型是众所周知的并且具有自定义 JSON 表示，则该表示将被嵌入，添加一个包含自定义 JSON 的字段value以及@type字段。示例（对于消息[google.protobuf.Duration][]）(Example (for message [google.protobuf.Duration][]))
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| 字段名称 (Field Name) | 必填 (Required) | 可为空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
|---|---|---|---|---|---|
@type |
字符串 (String) |
一个 URL/资源名称，用于唯一标识序列化协议缓冲区消息的类型。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名称（如 |
StorageGroup
Group 是 GroupProperties 与角色的映射。
| 字段名称 (Field Name) | 必填 (Required) | 可为空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
|---|---|---|---|---|---|
属性 |
|||||
角色名称 |
字符串 (String) |
这是将应用于此组中用户的角色名称。 |
StorageGroupProperties
GroupProperties 定义组的属性。当用户的属性匹配时，组将应用于用户。例如：- 如果 GroupProperties 只有 auth_provider_id，则该组将应用于使用该身份验证提供程序登录的所有用户。- 如果 GroupProperties 还具有声明键，则它将应用于具有该身份验证提供程序和声明键的所有用户，等等。注意：GroupProperties 的更改可能需要更改 v1.DeleteGroupRequest。
| 字段名称 (Field Name) | 必填 (Required) | 可为空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
|---|---|---|---|---|---|
ID |
字符串 (String) |
组属性和相应组的唯一标识符。 |
|||
特征 |
|||||
身份验证提供程序 ID |
字符串 (String) |
||||
键 |
字符串 (String) |
||||
值 |
字符串 (String) |
StorageTraits
| 字段名称 (Field Name) | 必填 (Required) | 可为空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
|---|---|---|---|---|---|
可变性模式 |
ALLOW_MUTATE，ALLOW_MUTATE_FORCED， |
||||
可见性 |
VISIBLE，HIDDEN， |
||||
来源 |
IMPERATIVE，DEFAULT，DECLARATIVE，DECLARATIVE_ORPHANED， |
TraitsMutabilityMode
实验性。注意：请暂时避免使用 MutabilityMode。它将在未来被替换 (ROX-14276)。MutabilityMode 指定对象是否以及如何修改。默认为 ALLOW_MUTATE，表示没有修改限制；这等同于没有 MutabilityMode 说明。ALLOW_MUTATE_FORCED 禁止所有修改操作，除了强制位开启的对象删除。
更改此字段的状态时要小心。例如，将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED 是允许的，但会禁止对其进行任何进一步的更改，包括将其修改回 ALLOW_MUTATE。
| 枚举值 |
|---|
ALLOW_MUTATE |
ALLOW_MUTATE_FORCED |
TraitsOrigin
Origin 指定对象的来源。对象可以有四种不同的来源：- IMPERATIVE：对象是通过 API 创建的。这是默认假设。- DEFAULT：对象是默认对象，例如默认角色、访问范围等。- DECLARATIVE：对象是通过声明式配置创建的。- DECLARATIVE_ORPHANED：对象是通过声明式配置创建的，然后未能成功删除（例如，因为它被另一个对象引用）。根据来源，不同的规则适用于对象。不允许通过 API 修改具有 DECLARATIVE 来源的对象，只能通过声明式配置修改。此外，它们可能不会引用具有 IMPERATIVE 来源的对象。不允许通过 API 或声明式配置修改具有 DEFAULT 来源的对象。它们可以被所有其他对象引用。允许通过 API 修改具有 IMPERATIVE 来源的对象，不能通过声明式配置修改。它们可以引用所有其他对象。不允许通过 API 或声明式配置修改具有 DECLARATIVE_ORPHANED 来源的对象。如果在声明式配置中重新定义，DECLARATIVE_ORPHANED 资源可以再次成为 DECLARATIVE。这些来源的对象在其不再被其他资源引用后将立即从系统中清除。它们可以被所有其他对象引用。
| 枚举值 |
|---|
IMPERATIVE |
DEFAULT |
DECLARATIVE |
DECLARATIVE_ORPHANED |
V1GroupBatchUpdateRequest
GroupBatchUpdateRequest is an in transaction batch update to the groups present. Next Available Tag: 3
| 字段名称 (Field Name) | 必填 (Required) | 可为空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
|---|---|---|---|---|---|
之前的组 |
StorageGroup 列表 |
之前的组是在存储中预期存在的组。对 previous_groups 和 required_groups 中存在的 GroupProperties 执行差异比较：1) 如果在 previous_groups 中但在 required_groups 中不存在，则将其删除。2) 如果在 previous_groups 和 required_groups 中都存在，则将其更新。3) 如果不在 previous_groups 中但在 required_groups 中存在，则将其添加。 |
|||
所需组 |
StorageGroup 列表 |
所需组是我们希望将之前的组更改为的组。 |
|||
强制 |
布尔值 |