REST Resource: projects.locations.unitKinds

リソース: UnitKind

単位の定義。同じ UnitKind に属するユニットはまとめて管理されます。たとえば、同じリリースモデル(ブループリント、バージョンなど)に従い、通常は一緒にロールアウトされます。

JSON 表現
{
  "name": string,
  "defaultRelease": string,
  "dependencies": [
    {
      object (Dependency)
    }
  ],
  "inputVariableMappings": [
    {
      object (VariableMapping)
    }
  ],
  "outputVariableMappings": [
    {
      object (VariableMapping)
    }
  ],
  "defaultFlagRevisions": [
    string
  ],
  "saas": string,
  "applicationTemplateComponent": {
    object (ComponentRef)
  },
  "appParams": {
    object (AppParams)
  },
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string,
  "createTime": string,
  "updateTime": string
}
フィールド
name

string

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

"projects/{project}/locations/{location}/unitKinds/{unitKind}"

defaultRelease

string

省略可。この UnitKind の新しい単位を作成する際のデフォルトとして使用する Release オブジェクトへの参照(省略可)。

指定されていない場合、新しいユニットは、作成に使用するリリースを明示的に参照する必要があります。

dependencies[]

object (Dependency)

省略可。変更不可。このリリースが依存する他のユニットの種類のリスト。依存関係が見つからない場合は、自動的にプロビジョニングされます。最大 10 個。

inputVariableMappings[]

object (VariableMapping)

省略可。このリリースの inputVariables のリスト。依存関係の outputVariables から取得されるか、依存関係の inputVariables に渡されます。最大 100。

outputVariableMappings[]

object (VariableMapping)

省略可。このユニット種類の outputVariables のリストが、このユニットの outputVariables に渡されます。最大 100。

defaultFlagRevisions[]

string

省略可。この UnitKind のフラグのデフォルト リビジョン。新しく作成されたユニットは、作成時に存在するフラグ defaultFlagRevisions を使用します。

saas

string

必須。変更不可。プロデューサーが App Lifecycle Manager で管理するプロダクト(マネージド サービス)を定義する Saas への参照。App Lifecycle Manager の共通データモデルの一部。設定後は変更不可。

applicationTemplateComponent

object (ComponentRef)

出力専用。複合 ApplicationTemplate のコンポーネントとリビジョンの参照。

appParams

object (AppParams)

AppParams には、AppHub アプリケーションを作成するためのパラメータが含まれています。

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"

依存関係

依存関係は、エイリアスによる別のユニットの種類の単一の依存関係を表します。

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

string

必須。変更不可。依存関係の単位の種類。

alias

string

必須。依存関係のエイリアス。入力変数のマッピングに使用されます。

VariableMapping

依存関係の入力変数とそれぞれの出力変数のマッピング

JSON 表現
{
  "variable": string,

  // Union field mapping_type can be only one of the following:
  "from": {
    object (FromMapping)
  },
  "to": {
    object (ToMapping)
  }
  // End of list of possible types for union field mapping_type.
}
フィールド
variable

string

必須。変数の名前

共用体フィールド mapping_type

mapping_type は次のいずれかになります。

from

object (FromMapping)

省略可。依存関係から値を取得する出力変数

to

object (ToMapping)

省略可。値を依存関係に渡す入力変数。

FromMapping

値が依存関係に渡される出力変数

JSON 表現
{
  "dependency": string,
  "outputVariable": string
}
フィールド
dependency

string

必須。outputVariable が値を渡す依存関係のエイリアス

outputVariable

string

必須。依存関係の outputVariable の名前

ToMapping

値を依存関係に渡す入力変数

JSON 表現
{
  "dependency": string,
  "inputVariable": string,
  "ignoreForLookup": boolean
}
フィールド
dependency

string

必須。inputVariable が値を渡す依存関係のエイリアス

inputVariable

string

必須。依存関係の inputVariable の名前

ignoreForLookup

boolean

省略可。このマッピングをルックアップ中に使用するかどうかを App Lifecycle Manager に伝えます

AppParams

AppParams には、AppHub アプリケーションを作成するためのパラメータが含まれています。

JSON 表現
{
  "group": string,
  "scope": {
    object (Scope)
  }
}
フィールド
group

string

AppHub アプリケーションの名前の作成に使用されるグループ。複数の UnitKind で同じグループを指定して、それぞれのユニットで同じ Application を使用できます。ADC 複合 ApplicationTemplate の app_boundary_id に対応します。デフォルトは UnitKind.name

scope

object (Scope)

ADC 複合 ApplicationTemplate のスコープに対応します。デフォルトは REGIONAL です。

範囲

アプリケーションのスコープ。

JSON 表現
{
  "type": enum (Type)
}
フィールド
type

enum (Type)

必須。スコープのタイプ。

タイプ

スコープのタイプ。

列挙型
TYPE_UNSPECIFIED 未指定のタイプ。
REGIONAL

非推奨: TYPE_REGIONAL を使用します。

GLOBAL

非推奨: TYPE_GLOBAL を使用してください。

TYPE_REGIONAL リージョン タイプ。
TYPE_GLOBAL グローバル タイプ。

メソッド

create

新しい単位の種類を作成します。

delete

単一のユニットの種類を削除します。

get

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

list

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

patch

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