Docs Menu
Docs Home
/ /

SP.listWORKspaceDefaults()(mongoshメソッド)

sp.listWorkspaceDefaults()

現在の Stream Processing ワークスペースのデフォルトおよび最大の階層構成を含むドキュメントを返します。この情報では、ワークスペースの階層サイズ設定機能について説明しています。

このメソッドは Atlas Stream Processing ワークスペース でサポートされています。

sp.listWorkspaceDefaults()メソッドの構文は次のとおりです。

sp.listWorkspaceDefaults()

sp.listWorkspaceDefaults() は、次のフィールドを含むドキュメントを返します。

フィールド
タイプ
説明

defaultTierSize

string

このワークスペース内のストリーム プロセッサに割り当てられたデフォルトの階層サイズ。ストリーム プロセッサは、作成または起動時に別の階層を明示的に指定しない限り、この階層を継承します。

maxTierSize

string

このワークスペース内のストリーム プロセッサで使用可能な最大階層サイズ。これは、任意のストリーム プロセッサに割り当てることができる最大の階層を表します。

sp.listWorkspaceDefaults() は、現在のストリーム処理ワークスペースのデフォルトと最大階層構成を説明する単一のドキュメントを STDOUT に返します。

sp.listWorkspaceDefaults()を実行するにはatlasAdmin ロールが必要です。

次の例えは、 sp.listWorkspaceDefaults()からの予想される応答を示しています。

sp.listWorkspaceDefaults()
1{
2 defaultTierSize: "T2",
3 maxTierSize: "T8"
4}

戻る

SP.listStreamProcessers

項目一覧