REST Resource: projects.agentPools

リソース: AgentPool

エージェント プールを表します。

JSON 表現
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "bandwidthLimit": {
    object (BandwidthLimit)
  }
}
フィールド
name

string

必須。エージェント プールを識別する一意の文字列を指定します。

形式: projects/{projectId}/agentPools/{agentPoolId}

displayName

string

クライアント指定の AgentPool の説明を指定します。

state

enum (State)

出力専用。AgentPool の状態を指定します。

bandwidthLimit

object (BandwidthLimit)

帯域幅の上限の詳細を指定します。このフィールドを指定しない場合は、デフォルト値が「無制限」に設定されます。

AgentPool の状態。

列挙型
STATE_UNSPECIFIED デフォルト値。この値は使用されません。
CREATING これは初期化状態です。このステージでは、AgentPool にリソースが割り当てられます。
CREATED AgentPool が使用のために作成されていることを確認します。この状態で、エージェントは AgentPool に参加し、そのプールの転送ジョブに参加できます。
DELETING AgentPool の削除が開始され、すべてのリソースがクリーンアップされて解放されるようにスケジュールされていることを判断します。

BandwidthLimit

エージェント プールの帯域幅の上限を指定します。

JSON 表現
{
  "limitMbps": string
}
フィールド
limitMbps

string (int64 format)

帯域幅レート(1 秒あたりのメガバイト数)。プール内のすべてのエージェントに分散されます。

メソッド

create

エージェント プール リソースを作成します。

delete

エージェント プールを削除します。

get

エージェント プールを取得します。

list

エージェント プールを一覧表示します。

patch

既存のエージェント プール リソースを更新します。