REST Resource: projects.locations.backends.builds

リソース: ビルド

特定のポイント コードベースの参照タグと特定の時点でのバックエンドの単一のビルド。Artifact Registry コンテナ イメージ、イメージをビルドした Cloud Build の呼び出し、そのイメージを使用する Cloud Run リビジョンなど、複数のリソースをカプセル化します。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "state": enum (State),
  "error": {
    object (Status)
  },
  "environment": string,
  "config": {
    object (Config)
  },
  "image": string,
  "source": {
    object (BuildSource)
  },
  "buildLogsUri": string,
  "reconciling": boolean,
  "createTime": string,
  "updateTime": string,
  "deleteTime": string,
  "labels": {
    string: string,
    ...
  },
  "annotations": {
    string: string,
    ...
  },
  "uid": string,
  "etag": string
}
フィールド
name

string

ID。ビルドのリソース名。

形式:

projects/{project}/locations/{locationId}/backends/{backendId}/builds/{buildId}。
displayName

string

省略可。人が読める形式の名前。最大 63 文字。
state

enum (State)

出力専用。ビルドの状態。
error

object (Status)

出力専用。FAILED 状態の場合、ビルドのステータスと（人が読める形式の）エラー メッセージ。
environment

string

出力専用。このビルドが作成されたときのバックエンドの環境名。
config

object (Config)

省略可。サービスの追加構成。
image

string

出力専用。このビルドの Cloud Run revision で使用される Artifact Registry コンテナ イメージ URI。
source

object (BuildSource)

必須。変更不可。ビルドのソース。
buildLogsUri

string

出力専用。ビルドプロセスの Cloud Build ログの場所。
reconciling

boolean

出力専用。true の場合、ビルドに進行中の LRO があることを示すフィールド。
createTime

string (Timestamp format)

出力専用。ビルドが作成された時間。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
updateTime

string (Timestamp format)

出力専用。ビルドが最後に更新された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
deleteTime

string (Timestamp format)

出力専用。ビルドが削除された時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。
labels

map (key: string, value: string)

省略可。オブジェクトの整理と分類に使用できる非構造化 Key-Value マップ。

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

map (key: string, value: string)

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

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

string

出力専用。システムによって割り当てられた一意の識別子。
etag

string

出力専用。他の値に基づいてサーバーが計算したチェックサム想定されるリソースでオペレーションが実行されるようにするために、更新時または削除時に送信されることがあります。

状態

ビルドの状態。

列挙型
STATE_UNSPECIFIED ビルドの状態が不明です。
BUILDING ビルド中です。
BUILT ビルドが完了し、次のステップを待っています。App Hosting によるインフラストラクチャのセットアップが開始すると、この段階は「デプロイ中」に移行する可能性があります。
DEPLOYING このビルドのインフラストラクチャを設定しています。
READY このビルドのインフラストラクチャの準備が整いました。ビルドがトラフィックを処理しているかどうかはさまざまです。現在の状態については Backend.traffic を、望ましい状態については Backend.traffic_statuses を参照してください。
FAILED ビルドに失敗しました。

Config

このビルドのバックエンドの追加構成。

JSON 表現 
{
  "runConfig": {
    object (RunConfig)
  }
}
フィールド
runConfig

object (RunConfig)

省略可。Cloud Run service の追加構成。

RunConfig

Cloud Run service に適用する追加の構成。

JSON 表現 
{
  "cpu": number,
  "memoryMib": integer,
  "concurrency": integer,
  "maxInstances": integer,
  "minInstances": integer
}
フィールド
cpu

number

省略可。サービスを提供するインスタンスごとに使用される CPU の数。

デフォルトでは、CPU は Cloud Run のデフォルトの 1.0 に設定されています。

CPU には、1、2、4、6、または 8 CPU の値を設定できます。CPU が 1 未満の場合は、0.08 から 1.00 までの値を 0.01 単位で設定します。

1 CPU 未満の値を設定する場合は、同時実行を 1 に設定する必要があります。設定すると、リクエストの処理中のみ CPU が割り当てられます。

CPU の上限を引き上げると、メモリの上限を引き上げることが必要になる場合があります。

  • 4 CPU: 2 GiB 以上
  • 6 CPU: 4 GiB 以上
  • 8 CPU: 4 GiB 以上
memoryMib

integer

省略可。サービスを提供する各インスタンスに割り当てられたメモリ量（MiB 単位）。

デフォルトでは、メモリは Cloud Run のデフォルトであり、各インスタンスに 512 MiB のメモリが割り当てられます。

メモリには 128 ～ 32768 の任意の整数値を設定できます。

メモリ上限を引き上げると、CPU 上限の引き上げが必要になる場合があります。

  • 4 GiB 超: 少なくとも 2 個の CPU
  • 8 GiB 超: 4 個以上の CPU
  • 16 GiB 超: 6 個以上の CPU
  • 24 GiB 超: 8 個以上の CPU
concurrency

integer

省略可。各 Cloud Run インスタンスが受信できるリクエストの最大数。

デフォルトでは、各インスタンスは Cloud Run のデフォルトである最大 80 件のリクエストを同時に受信できます。

同時実行には、1,000 までの任意の整数値を設定できます。
maxInstances

integer

省略可。リビジョンごとに維持する Cloud Run インスタンスの最大数。

デフォルトでは、各 Cloud Run service は、Cloud Run のデフォルトの最大インスタンス数 100 にスケールアウトします。maxInstances の上限は割り当てに基づきます。https://cloud.google.com/run/docs/configure/max-instances#limits をご覧ください。
minInstances

integer

省略可。Cloud Run サービスごとに維持する Cloud Run インスタンスの最小数。

デフォルトでは、最小値はありません。

サービスがトラフィックを複数のリビジョンに分割しても、サービスの合計インスタンス数はこの値に制限されます。

BuildSource

ビルドのソース。

JSON 表現 
{

  // Union field source can be only one of the following:
  "codebase": {
    object (CodebaseSource)
  },
  "container": {
    object (ContainerSource)
  }
  // End of list of possible types for union field source.
}
フィールド
共用体フィールド source。ビルドの入力ソース。通常、ソース リポジトリ内の commit を参照します。コンテナ イメージを参照することもできます。source は次のいずれかになります。
codebase

object (CodebaseSource)

コードベースのソース。
container

object (ContainerSource)

Artifact Registry コンテナ イメージのソース。

コードベースのソース

ビルドが作成されるコードベースの状態を表すコードベース ソース。

JSON 表現 
{
  "displayName": string,
  "hash": string,
  "commitMessage": string,
  "uri": string,
  "author": {
    object (UserMetadata)
  },
  "commitTime": string,

  // Union field reference can be only one of the following:
  "branch": string,
  "commit": string
  // End of list of possible types for union field reference.
}
フィールド
displayName

string

出力専用。ビルドを表示するときに、このコードベースに使用するわかりやすい名前。GitHub.com の SHA-1 ハッシュの最初の 8 文字を使用します。
hash

string

出力専用。Git commit の完全な SHA-1 ハッシュ（利用可能な場合）。
commitMessage

string

出力専用。コードベース変更のメッセージ。
uri

string

出力専用。ホスティング プロバイダのウェブサイト上のコードベースにリンクする URI。リンクされたリポジトリに commit がリベースされたり、強制的に push されなくなったりした場合、有効でない場合があります。
author

object (UserMetadata)

出力専用。バージョン管理の変更のメタデータに含まれる作成者。
commitTime

string (Timestamp format)

出力専用。変更が行われた時刻。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"。

共用体フィールド reference。

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

string

最新の commit によるビルド元となるコードベース内のブランチ。
commit

string

ビルド元のコードベース内の commit。

UserMetadata

解決されたコードベースに関連付けられているユーザーのバージョン管理メタデータ。現在は Git ユーザーを想定しています。

JSON 表現 
{
  "displayName": string,
  "email": string,
  "imageUri": string
}
フィールド
displayName

string

出力専用。「name」git.config で指定する必要があります。Git で必要です。
email

string

出力専用。「メール」このフィールドを git.config に追加します。
imageUri

string

出力専用。外部のソース コントロール プロバイダでユーザーのアカウントに関連付けられている画像ファイルの URI（利用可能な場合）。

ContainerSource

ビルドソースとして使用する Artifact Registry コンテナ イメージの URI。

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

string

必須。バックエンドが使用するコンテナを表す URI。

メソッド

create

 バックエンドの新しいビルドを作成します。

delete

 単一のビルドを削除します。

get

 ビルドに関する情報を取得します。

list

 指定したプロジェクト、ロケーション、バックエンドのビルドを一覧表示します。