12.2. DryRunCollection


POST /v1/collections/dryrun

12.2.1. 説明

12.2.2. パラメーター

12.2.2.1. ボディパラメーター

Expand
名前説明必須デフォルトPattern

body

V1DryRunCollectionRequest

X

  

12.2.3. 戻り値のタイプ

V1DryRunCollectionResponse

12.2.4. コンテンツタイプ

  • application/json

12.2.5. レスポンス

Expand
表12.2 HTTP 応答コード
コードメッセージデータタイプ

200

正常な応答。

V1DryRunCollectionResponse

0

予期しないエラーの応答です。

RuntimeError

12.2.6. サンプル

12.2.7. 共通のオブジェクト参照

12.2.7.1. ProtobufAny

any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。

Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
Copy to Clipboard Toggle word wrap

例 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());
}
Copy to Clipboard Toggle word wrap
Example 3: Pack and unpack a message in Python.
Copy to Clipboard Toggle word wrap
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Copy to Clipboard Toggle word wrap
Example 4: Pack and unpack a message in Go
Copy to Clipboard Toggle word wrap
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}
Copy to Clipboard Toggle word wrap

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.2.7.1.1. JSON 表現

Any 値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type を使用します。以下に例を示します。

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}
Copy to Clipboard Toggle word wrap

埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド が追加されます。例(メッセージ [google.protobuf.Duration][] の場合):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Copy to Clipboard Toggle word wrap
Expand
フィールド名必須Null 許容型説明形式

typeUrl

  

String

シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( path/google.protobuf.Durationにあるように)を表す必要があります。名前は正規の形式である必要があります(たとえば、先頭 \".\" は受け入れられません)。実際には、チームは通常、バイナリーにプリコンパイルして、任意 のコンテキストで使用することを期待しているすべてのタイプにプレコンパイルします。ただし、スキーム httphttps、またはスキームを使用しない URL の場合、以下のようにタイプ URL をメッセージ定義にマップするタイプサーバーを設定できます。* スキームが指定されていない場合、https は想定されます。* URL の HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成するか、エラーを生成する必要があります。* アプリケーションは、URL に基づいてルックアップ結果をキャッシュするか、ルックアップを回避するためにバイナリーにプリコンパイルして使用できます。したがって、タイプへの変更時にバイナリー互換性を保持する必要があります。(バージョン付けされたタイプ名を使用して、重大な変更を管理します。)注記:この機能は現在、公式の protobuf リリースでは利用できないため、type.googleapis.com で始まるタイプ URL には使用されません。2023 年 5 月時点では、広く使用されているタイプサーバー実装はもう 1 つも実装する予定はありません。http 以外のスキーム、https (または空のスキーム)は、実装固有のセマンティクスで使用できます。

 

value

  

byte[]

上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。

byte

12.2.7.2. RuntimeError

Expand
フィールド名必須Null 許容型説明形式

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAnyのリスト

  

12.2.7.3. StorageBooleanOperator

Expand
Enum 値

OR

AND

12.2.7.4. StorageListDeployment

Next available tag: 9
Copy to Clipboard Toggle word wrap
Expand
フィールド名必須Null 許容型説明形式

id

  

String

  

ハッシュ

  

String

 

uint64

name

  

String

  

cluster

  

String

  

clusterId

  

String

  

namespace

  

String

  

created

  

Date

 

date-time

priority

  

String

 

int64

12.2.7.5. StorageMatchType

Expand
Enum 値

EXACT

REGEX

12.2.7.6. StorageResourceSelector

Expand
フィールド名必須Null 許容型説明形式

rules

  

StorageSelectorRuleの一覧

ルール は接続詞(AND)として解決されます。

 

12.2.7.7. StorageRuleValue

Expand
フィールド名必須Null 許容型説明形式

value

  

String

  

matchType

  

StorageMatchType

 

EXACT, REGEX,

12.2.7.8. StorageSelectorRule

Expand
フィールド名必須Null 許容型説明形式

fieldName

  

String

  

operator

  

StorageBooleanOperator

 

または、AND

values

  

StorageRuleValueの一覧

は、演算子に応じて結合(AND)またはアンジェット(OR)として解決されます。MVP の場合、OR のみが UX の観点からサポートされています。

 

12.2.7.9. V1AggregateBy

Expand
フィールド名必須Null 許容型説明形式

aggrFunc

  

V1Aggregation

 

UNSET、COUNT、MIN、MAX

一意

  

Boolean

  

12.2.7.10. V1Aggregation

Expand
Enum 値

UNSET

カウント

最小

最大

12.2.7.11. V1CollectionDeploymentMatchOptions

Expand
フィールド名必須Null 許容型説明形式

withMatches

  

Boolean

  

filterQuery

  

V1RawQuery

  

12.2.7.12. V1DryRunCollectionRequest

Expand
フィールド名必須Null 許容型説明形式

name

  

String

  

id

  

String

  

description

  

String

  

resourceSelectors

  

StorageResourceSelectorの一覧

  

embeddedCollectionIds

  

string のリスト

  

options

  

V1CollectionDeploymentMatchOptions

  

12.2.7.13. V1DryRunCollectionResponse

Expand
フィールド名必須Null 許容型説明形式

デプロイメント

  

StorageListDeploymentのリスト

  

12.2.7.14. V1Pagination

Expand
フィールド名必須Null 許容型説明形式

limit

  

Integer

 

int32

offset

  

Integer

 

int32

sortOption

  

V1SortOption

  

sortOptions

  

V1SortOptionのリスト

このフィールドは開発中です。REST API ではサポートされていません。

 

12.2.7.15. V1RawQuery

RawQuery は検索クエリー文字列を表します。クエリー文字列の形式は "<field name>:<value,value,…​><field name>:<value, value,..>…​" です。例:namespace "stackrox" で "central" および "sensor" という名前のデプロイメントを検索するには、クエリー文字列は "Deployment:central,sensor+Namespace:stackrox" RawQuery is be Listapis で特定のオブジェクトを検索します。

Expand
フィールド名必須Null 許容型説明形式

query

  

String

  

ページネーション

  

V1Pagination

  

12.2.7.16. V1SortOption

Expand
フィールド名必須Null 許容型説明形式

field

  

String

  

reversed

  

Boolean

  

aggregateBy

  

V1AggregateBy

  
トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat