26.2. BatchUpdate
POST /v1/groupsbatch
26.2.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
26.2.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
26.2.2.1. ボディパラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | Pattern |
---|---|---|---|---|
body | X |
26.2.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
Object
26.2.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
26.2.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データタイプ |
---|---|---|
200 | 正常な応答。 |
|
0 | 予期しないエラーの応答です。 |
26.2.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
26.2.7. 共通のオブジェクト参照 リンクのコピーリンクがクリップボードにコピーされました!
26.2.7.1. ProtobufAny リンクのコピーリンクがクリップボードにコピーされました!
any
には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。
Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。
例 1: C++ のメッセージをパックして展開します。
例 2: Java でメッセージをパックして解凍します。
Example 3: Pack and unpack a message in Python.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
Example 4: Pack and unpack a message in Go
protobuf ライブラリーが提供するパックメソッドは、デフォルトで type.googleapis.com/full.type.name をタイプ URL として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。
26.2.7.1.1. JSON 表現 リンクのコピーリンクがクリップボードにコピーされました!
Any
値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type
を使用します。以下に例を示します。
package google.profile; message Person { string first_name = 1; string last_name = 2; }
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> }
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type
フィールドに加えてカスタム JSON を保持するフィールド 値
が追加されます。例(メッセージ [google.protobuf.Duration][] の場合):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
typeUrl | String |
シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( | |||
value | byte[] | 上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。 | byte |
26.2.7.2. RuntimeError リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
error | String | ||||
code | Integer | int32 | |||
message | String | ||||
details | ProtobufAnyのリスト |
26.2.7.3. StorageGroup リンクのコピーリンクがクリップボードにコピーされました!
Group は GroupProperties: Role mapping です。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
props | |||||
roleName | String | これは、このグループのユーザーに適用されるロールの名前です。 |
26.2.7.4. StorageGroupProperties リンクのコピーリンクがクリップボードにコピーされました!
GroupProperties は、グループのプロパティーを定義します。プロパティーが一致する場合、グループはユーザーに適用されます。たとえば、GroupProperties に auth_provider_id のみがある場合、そのグループは、その認証プロバイダーでログインしたすべてのユーザーに適用されます。さらに GroupProperties にクレームキーがある場合は、その認証プロバイダーとクレームキーを持つすべてのユーザーに適用されます。注記:GroupProperties への変更には、v1.DeleteGroupRequest への変更が必要になる場合があります。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
id | String | グループプロパティーとグループの一意識別子。 | |||
traits | |||||
authProviderId | String | ||||
key | String | ||||
value | String |
26.2.7.5. StorageTraits リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
mutabilityMode | ALLOW_MUTATE, ALLOW_MUTATE_FORCED, | ||||
visibility | VISIBLE、HIDDEN、 | ||||
origin | 命令、デフォルト、宣言的、DECLARATIVE_ORPHANED |
26.2.7.6. TraitsMutabilityMode リンクのコピーリンクがクリップボードにコピーされました!
実験的注記:当面は、MutabilityMode の使用を参照してください。これは今後置き換えられる予定です(ROX-14276)。MutabilityMode は、オブジェクトを変更するかどうか、およびその方法を指定します。デフォルトは ALLOW_MUTATE であり、変更制限がないことを意味します。これは、MutabilityMode 仕様がないことと同等です。ALLOW_MUTATE_FORCED は、force ビットでのオブジェクト削除以外のすべての変更操作を禁止します。
このフィールドの状態を変更するときは注意してください。たとえば、オブジェクトを ALLOW_MUTATE から ALLOW_MUTATE_FORCED に変更することは許可されますが、これを変更すると、ALLOW_MUTATE に戻すなど、それ以降の変更はできなくなります。
Enum 値 |
---|
ALLOW_MUTATE |
ALLOW_MUTATE_FORCED |
26.2.7.7. TraitsOrigin リンクのコピーリンクがクリップボードにコピーされました!
origin は、オブジェクトの発信元を指定します。オブジェクトには、発信元を 4 つ持つことができます:- IMPERATIVE: オブジェクトは API 経由で作成されました。これはデフォルトで仮定されます。- DEFAULT: オブジェクトは、デフォルトのロール、アクセススコープなどのデフォルトオブジェクトです。DECLARATIVE: オブジェクトは宣言型設定を使用して作成されます。- DECLARATIVE_ORPHANED: オブジェクトは宣言型設定によって作成され、(たとえば、別のオブジェクトで参照されるため)作成元に基づいて別のルールがオブジェクトに適用されます。DECLARATIVE オリジンを持つオブジェクトは、宣言的設定を介してのみ API 経由で変更することはできません。さらに、IMPERATIVE オリジンを使用してオブジェクトを参照することはできません。DEFAULT オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更することはできません。それらは他のすべてのオブジェクトで参照できます。IMPERATIVE オリジンを持つオブジェクトは、宣言的設定ではなく、API を介して変更できます。これらは他のすべてのオブジェクトを参照することができます。DECLARATIVE_ORPHANED オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更できません。DECLARATIVE_ORPHANED リソースは、宣言的な設定で再定義されると、DECLARATIVE が再び DECLARATIVE になる可能性があります。この元のオブジェクトでは、他のリソースが参照されていない直後にシステムからクリーンアップされます。それらは他のすべてのオブジェクトで参照できます。
Enum 値 |
---|
命令 |
デフォルト |
宣言的 |
DECLARATIVE_ORPHANED |
26.2.7.8. TraitsVisibility リンクのコピーリンクがクリップボードにコピーされました!
EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。
Enum 値 |
---|
VISIBLE |
HIDDEN |
26.2.7.9. V1GroupBatchUpdateRequest リンクのコピーリンクがクリップボードにコピーされました!
GroupBatchUpdateRequest is an in transaction batch update to the groups present. Next Available Tag: 3
GroupBatchUpdateRequest is an in transaction batch update to the groups present. Next Available Tag: 3
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
previousGroups | StorageGroupのリスト | 以前のグループは、そのグループがストアに存在することが予想されています。previous_groups に存在していても、required_groups に存在しない場合に、previous_groups と required_groups: 1)にある GroupProperties で diff を実行します。2)previous_groups と required_groups の場合、これは更新されます。3)previous_groups にはなく、required_groups の場合は、追加されます。 | |||
requiredGroups | StorageGroupのリスト | 必要なグループは、以前のグループを切り替えたいグループです。 | |||
force | Boolean |