Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
GET /v1/group
字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
code |
整数 |
int32 |
|||
message |
字符串 |
||||
details |
ProtobufAny 列表 |
Any
包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 URL。
Protobuf 库提供实用函数或 Any 类型的附加生成方法来支持打包/解包 Any 值。
示例 1:在 C++ 中打包和解包消息。
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
示例 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"。
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 表示,则该表示将被嵌入,除了 @type
字段外,还会添加一个包含自定义 JSON 的 value
字段。示例(对于消息 [google.protobuf.Duration][])
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
@type |
字符串 |
唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的完全限定名称(如 |
Group 是 GroupProperties:角色映射。
字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
props |
|||||
roleName |
字符串 |
这是将应用于此组中用户的角色的名称。 |
GroupProperties 定义组的属性。当用户的属性匹配时,组将应用于用户。例如:- 如果 GroupProperties 只有 auth_provider_id,则该组将应用于使用该身份提供程序登录的所有用户。- 如果 GroupProperties 还具有声明密钥,则它将应用于具有该身份提供程序和声明密钥的所有用户,依此类推。注意:GroupProperties 的更改可能需要更改 v1.DeleteGroupRequest。
字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
id |
字符串 |
组属性和组的唯一标识符。 |
|||
traits |
|||||
authProviderId |
字符串 |
||||
键 |
字符串 |
||||
值 |
字符串 |
字段名称 | 必填 | 可空 | 类型 | 描述 | 格式 |
---|---|---|---|---|---|
mutabilityMode |
ALLOW_MUTATE, ALLOW_MUTATE_FORCED, |
||||
visibility |
VISIBLE, HIDDEN, |
||||
origin |
IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED, |
实验性。注意:请暂时避免使用MutabilityMode。它将在未来被替换(ROX-14276)。MutabilityMode 指定对象是否以及如何修改。默认为 ALLOW_MUTATE,表示没有修改限制;这等效于没有 MutabilityMode 说明。ALLOW_MUTATE_FORCED 禁止所有修改操作,除非强制位开启的对象删除。
更改此字段的状态时要小心。例如,将对象从 ALLOW_MUTATE 修改为 ALLOW_MUTATE_FORCED 是允许的,但会禁止对其进行任何进一步更改,包括将其修改回 ALLOW_MUTATE。
枚举值 |
---|
ALLOW_MUTATE |
ALLOW_MUTATE_FORCED |
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 |