REST Resource: projects.locations.units

リソース: Unit

基盤となるアクチュエーション エンジン（Terraform、Helm、サービス プロデューサーが提供するカスタム実装など）を使用して CRUD API を介してライフサイクルを持つデプロイ単位。SaaS テナントのビルディング ブロック。

JSON 表現 
{
  "name": string,
  "unitKind": string,
  "release": string,
  "tenant": string,
  "ongoingOperations": [
    string
  ],
  "pendingOperations": [
    string
  ],
  "scheduledOperations": [
    string
  ],
  "dependents": [
    {
      object (UnitDependency)
    }
  ],
  "dependencies": [
    {
      object (UnitDependency)
    }
  ],
  "inputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "outputVariables": [
    {
      object (UnitVariable)
    }
  ],
  "maintenance": {
    object (MaintenanceSettings)
  },
  "state": enum (UnitState),
  "conditions": [
    {
      object (UnitCondition)
    }
  ],
  "managementMode": enum (ManagementMode),
  "systemManagedState": enum (SystemManagedState),
  "systemCleanupAt": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string,
  "satisfiesPzs": boolean,
  "satisfiesPzi": boolean
}
フィールド
name

string

ID。標準の命名スキームに沿ったリソース名（リソースの完全な URI）。

"projects/{project}/locations/{location}/units/{unit}"
unitKind

string

省略可。この Unit が属する UnitKind への参照。設定後は変更不可。
release

string

省略可。出力専用。この Unit の現在の Release オブジェクト。
tenant

string

省略可。このユニットが属する Saas テナント リソースへの参照。たとえば、ユニットの今後のアップデートのスケジュール設定に使用するメンテナンス ポリシーを通知します。（省略可。作成後は変更不可）
ongoingOperations[]

string

省略可。出力専用。この Unit で動作している同時 UnitOperation のリスト。
pendingOperations[]

string

省略可。出力専用。このユニットの保留中の（実行待ちの）UnitOperation のリスト。
scheduledOperations[]

string

省略可。出力専用。このユニットのスケジュール設定された UnitOperation のリスト。
dependents[]

object (UnitDependency)

省略可。出力専用。このユニットに依存するユニットのリスト。このリストが空の場合にのみ、ユニットのプロビジョニングを解除できます。最大 1,000。
dependencies[]

object (UnitDependency)

省略可。出力専用。このユニットの依存関係のセット。最大 10 個。
inputVariables[]

object (UnitVariable)

省略可。出力専用。ユニットによってデプロイされた現在の入力変数を示します
outputVariables[]

object (UnitVariable)

省略可。出力専用。アクチュエーション テンプレートの実行からの出力変数に対応する Key-Value ペアのセット。変数はアクチュエーション構成（helm チャートや terraform など）で宣言され、値は実行の完了時にアクチュエーション エンジンによって取得されて返されます。
maintenance

object (MaintenanceSettings)

省略可。ユニットの今後のメンテナンスの実行についてリクエストされた指示をキャプチャします。これには、ユニットが一定期間メンテナンスをスキップして現在のリリースに固定されるようにするリクエストや、今後予定されているメンテナンスを延期するための制御が含まれます。
state

enum (UnitState)

省略可。出力専用。リソースの現在のライフサイクル状態（作成中か使用可能かなど）。
conditions[]

object (UnitCondition)

省略可。出力専用。このリソースが持つ可能性のあるさまざまな条件を示す一連の条件。
managementMode

enum (ManagementMode)

省略可。変更不可。ユニットのライフサイクルがユーザーによって制御されるか、システムによって制御されるかを示します。作成後は変更できません。
systemManagedState

enum (SystemManagedState)

省略可。出力専用。ユニットのシステム管理状態を示します。
systemCleanupAt

string (Timestamp format)

省略可。出力専用。設定されている場合、システムがユニットの削除を開始する時刻を示します。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
labels

map (key: string, value: string)

省略可。リソースのラベル。分類に使用できます。Kubernetes リソースラベルに似ています。

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
annotations

map (key: string, value: string)

省略可。アノテーションは、任意のメタデータを保存して取得するため、外部ツールによって設定される可能性のあるリソースとともに保存される非構造化 Key-Value マップです。クエリは実行可能ではなく、オブジェクトを変更する際に保持する必要があります。

詳細: https://kubernetes.io/docs/user-guide/annotations

"key": value ペアのリストを含むオブジェクト。例: { "name": "wrench", "mass": "1.3kg", "count": "3" }
uid

string

出力専用。リソースの一意の識別子。UID は、サービスのスコープ内で、このリソースの時間と場所において一意性を持ちます。通常は、リソースの作成時にサーバーによって生成され、変更されることはありません。UID は、リソース名が再利用される場合でも一意にリソースを識別するために使用されます。UUID4 であることが必要です。
etag

string

出力専用。リソースのバージョンまたは世代を一意に識別する、不透明な値です。書き込まれるリソースの順序についてクライアントとサーバーの間で確実に同意するために使用できます。
createTime

string (Timestamp format)

出力専用。リソース作成時のタイムスタンプ。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
updateTime

string (Timestamp format)

出力専用。リソース最終更新時のタイムスタンプ。ユーザーがリソースを変更した場合は、この値を更新する必要があります。サービスがリソースを変更した場合は、この値を更新する必要があります。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
satisfiesPzs

boolean

出力専用。リソース ロケーションがゾーン分割の制約を満たしているかどうかを示します。デフォルトでは false です。
satisfiesPzi

boolean

出力専用。リソースのロケーションがゾーン分離の制約を満たしているかどうかを示します。デフォルトでは false です。

UnitDependency

このユニットの依存関係のセット。最大 10 個。

JSON 表現 
{
  "alias": string,
  "unit": string
}
フィールド
alias

string

出力専用。依存関係の名前のエイリアス。
unit

string

出力専用。Unit オブジェクトへの参照。

MaintenanceSettings

ユニットの今後のメンテナンスの実行についてリクエストされた指示をキャプチャします。これには、ユニットが一定期間メンテナンスをスキップして現在のリリースに固定されるようにするリクエストや、今後予定されているメンテナンスを延期するための制御が含まれます。

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

string (Timestamp format)

省略可。オンにすると、指定した時刻までユニットのリリースが固定されます。つまり、リリース フィールドの変更が拒否されます。ロールアウトでも、アップグレードをリクエストしないことでこの設定が遵守されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。

UnitState

UnitState は、ユニット自体の現在の状態をアノテーションします。

列挙型
UNIT_STATE_UNSPECIFIED 未指定の状態
UNIT_STATE_NOT_PROVISIONED ユニットがプロビジョニングされていません。
UNIT_STATE_PROVISIONING ユニットをプロビジョニングしています。
UNIT_STATE_UPDATING ユニットを更新しています。通常、これはユニットが新しいリリースにアップグレードされるとき、またはユニットの入力変数のいずれかが変更されるときに発生します。特定の種類のアップデートでは、アップデートの進行中にユニットが使用できなくなることがあります。
UNIT_STATE_DEPROVISIONING ユニットを削除しています。
UNIT_STATE_READY ユニットがプロビジョニングされ、使用できる状態になりました
UNIT_STATE_ERROR ユニットが準備できていないときにエラー オペレーションが発生した場合、ユニットにエラーが発生する

UnitCondition

UnitCondition は、Unit のステータスを表します。UnitCondition は、全体的な状態に影響する個々のコンポーネントです。

JSON 表現 
{
  "status": enum (Status),
  "type": enum (Type),
  "lastTransitionTime": string,
  "message": string,
  "reason": string
}
フィールド
status

enum (Status)

必須。条件のステータス。
type

enum (Type)

必須。条件のタイプ。
lastTransitionTime

string (Timestamp format)

必須。ある状態から別の状態に遷移した最後の時刻。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
message

string

必須。最後の移行の詳細を示す人間が読めるメッセージ。
reason

string

必須。条件の最後の遷移の簡単な理由。

ステータス

条件ステータスの列挙。

列挙型
STATUS_UNSPECIFIED 条件のステータスが指定されていません。
STATUS_UNKNOWN 条件が不明です。
STATUS_TRUE 条件が true の場合。
STATUS_FALSE 条件が false です。

タイプ

条件タイプの列挙。

列挙型
TYPE_UNSPECIFIED 条件タイプが指定されていません。
TYPE_READY 条件タイプが準備完了。
TYPE_UPDATING 条件タイプを更新しています。
TYPE_PROVISIONED 条件タイプがプロビジョニングされます。
TYPE_OPERATION_ERROR 条件タイプは operationError です。最後のユニット オペレーションが無視できないエラーで失敗した場合に true。

ManagementMode

ManagementMode は、ユニットの管理を担当するユーザーを示します。

列挙型
MANAGEMENT_MODE_UNSPECIFIED
MANAGEMENT_MODE_USER ユニットのライフサイクルはユーザーが管理します。
MANAGEMENT_MODE_SYSTEM ユニットのプロビジョニング解除と削除のタイミングはシステムによって決定されます。ユーザーは、ユニットのプロビジョニング解除または削除を手動で行うことができます。

SystemManagedState

列挙型
SYSTEM_MANAGED_STATE_UNSPECIFIED
SYSTEM_MANAGED_STATE_ACTIVE ユニットに依存関係が設定されています。
SYSTEM_MANAGED_STATE_INACTIVE ユニットに依存関係は付いていませんが、アタッチメントは許可されています。
SYSTEM_MANAGED_STATE_DECOMMISSIONED ユニットに依存関係が設定されておらず、添付ファイルが許可されていません。

メソッド

create

 新しいユニットを作成します。

delete

 1 つのユニットを削除します。

get

 単一のユニットを取得します。

list

 単位のコレクションを取得します。

patch

 単一のユニットを更新します。