Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
GET /v1/roles
代码 (Code) | 消息 (Message) | 数据类型 (Datatype) |
---|---|---|
200 |
成功的响应。 (A successful response.) |
|
0 |
意外的错误响应。 (An unexpected error response.) |
字段名称 (Field Name) | 必填 (Required) | 可空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
---|---|---|---|---|---|
code |
整数 (Integer) |
int32 |
|||
message |
字符串 (String) |
||||
details |
ProtobufAny列表 (ProtobufAny List) |
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
。示例 (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 表示,则该表示将被嵌入,并添加一个value
字段,该字段除了@type
字段外还包含自定义 JSON。示例(对于消息[google.protobuf.Duration][])
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
字段名称 (Field Name) | 必填 (Required) | 可空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
---|---|---|---|---|---|
@type |
字符串 (String) |
一个唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一个段必须表示类型的完全限定名称(如 |
角色指定允许对哪些集群对象的子集执行哪些操作。权限可以通过同时设置 resource_to_access 和 global_access 来直接指定,也可以通过在 permission_set_name 中引用其 ID 来引用权限集。
字段名称 (Field Name) | 必填 (Required) | 可空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
---|---|---|---|---|---|
name |
字符串 (String) |
|
|||
description |
字符串 (String) |
||||
permissionSetId |
字符串 (String) |
此角色关联的 PermissionSet 和 AccessScope。 |
|||
accessScopeId |
字符串 (String) |
||||
globalAccess |
NO_ACCESS, READ_ACCESS, READ_WRITE_ACCESS, |
||||
resourceToAccess |
StorageAccess 的映射 |
2021-04-20 已弃用,建议使用 |
|||
traits |
字段名称 (Field Name) | 必填 (Required) | 可空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
---|---|---|---|---|---|
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 |
字段名称 (Field Name) | 必填 (Required) | 可空 (Nullable) | 类型 (Type) | 描述 (Description) | 格式 (Format) |
---|---|---|---|---|---|
roles |
StorageRole 列表 |