Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
×
GetGroups
GET /v1/groups
常用对象引用
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表示
Any值的JSON表示使用反序列化、嵌入式消息的常规表示，以及包含类型URL的附加字段@type。示例
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表示，则该表示将被嵌入，并添加一个字段value，该字段除了@type字段外还包含自定义JSON。示例（对于消息[google.protobuf.Duration][]）
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| 字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
@type |
字符串 |
一个 URL/资源名称，唯一标识序列化 Protocol Buffer 消息的类型。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名称（例如，`path/google.protobuf.Duration`）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会预先编译二进制文件中他们期望在 Any 上下文中使用的所有类型。但是，对于使用方案 `http`、`https` 或无方案的 URL，可以选择设置一个类型服务器，如下所示将类型 URL 映射到消息定义：* 如果未提供方案，则假定为 `https`。* 对 URL 的 HTTP GET 请求必须产生二进制格式的 [google.protobuf.Type][] 值，否则会产生错误。* 应用程序可以根据 URL 缓存查找结果，或将其预编译到二进制文件中以避免任何查找。因此，需要在类型更改时保留二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能当前在官方 protobuf 版本中不可用，并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月，没有广泛使用的类型服务器实现，也没有计划实现一个。除了 `http`、`https`（或空方案）之外的方案可能与特定于实现的语义一起使用。 |
StorageGroupProperties
GroupProperties 定义组的属性。当用户的属性匹配时，组将应用于用户。例如：- 如果 GroupProperties 只包含 auth_provider_id，则该组将应用于使用该身份验证提供程序登录的所有用户。- 如果 GroupProperties 还包含声明密钥，则它将应用于具有该身份验证提供程序和声明密钥的所有用户，依此类推。注意：GroupProperties 的更改可能需要更改 v1.DeleteGroupRequest。
| 字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
ID |
字符串 |
组属性以及相应的组的唯一标识符。 |
|||
特征 |
|||||
authProviderId |
字符串 |
||||
键 |
字符串 |
||||
值 |
字符串 |
StorageTraits
| 字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
可变性模式 |
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 |
V1GetGroupsResponse
API for updating Groups and getting users. Next Available Tag: 2
| 字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
|---|---|---|---|---|---|
组 |
StorageGroup 列表 |