12.7. CreateCollection
POST /v1/collections
12.7.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
12.7.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
12.7.2.1. ボディパラメーター リンクのコピーリンクがクリップボードにコピーされました!
| 名前 | 説明 | 必須 | デフォルト | Pattern |
|---|---|---|---|---|
| body | X |
12.7.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
12.7.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
12.7.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
| コード | メッセージ | データタイプ |
|---|---|---|
| 200 | 正常な応答。 | |
| 0 | 予期しないエラーの応答です。 |
12.7.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
12.7.7. 共通のオブジェクト参照 リンクのコピーリンクがクリップボードにコピーされました!
12.7.7.1. ProtobufAny リンクのコピーリンクがクリップボードにコピーされました!
any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。
Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または 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 として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。
12.7.7.1.1. 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 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド 値 が追加されます。例(メッセージ [google.protobuf.Duration][] の場合):
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| typeUrl | String |
シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( | |||
| value | byte[] | 上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。 | byte |
12.7.7.2. ResourceCollectionEmbeddedResourceCollection リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| id | String |
12.7.7.3. RuntimeError リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| error | String | ||||
| code | Integer | int32 | |||
| message | String | ||||
| details | ProtobufAnyのリスト |
12.7.7.4. StorageBooleanOperator リンクのコピーリンクがクリップボードにコピーされました!
| Enum 値 |
|---|
| OR |
| AND |
12.7.7.5. StorageMatchType リンクのコピーリンクがクリップボードにコピーされました!
| Enum 値 |
|---|
| EXACT |
| REGEX |
12.7.7.6. StorageResourceCollection リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| id | String | ||||
| name | String | ||||
| description | String | ||||
| createdAt | Date | date-time | |||
| lastUpdated | Date | date-time | |||
| createdBy | |||||
| updatedBy | |||||
| resourceSelectors |
| ||||
| embeddedCollections |
12.7.7.7. StorageResourceSelector リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| rules |
|
12.7.7.8. StorageRuleValue リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| value | String | ||||
| matchType | EXACT, REGEX, |
12.7.7.9. StorageSelectorRule リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| fieldName | String | ||||
| operator | または、AND | ||||
| values |
|
12.7.7.10. StorageSlimUser リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| id | String | ||||
| name | String |
12.7.7.11. V1CreateCollectionRequest リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| name | String | ||||
| description | String | ||||
| resourceSelectors | |||||
| embeddedCollectionIds |
|
12.7.7.12. V1CreateCollectionResponse リンクのコピーリンクがクリップボードにコピーされました!
| フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
|---|---|---|---|---|---|
| コレクション |