REST Resource: projects.locations.backends

リソース: Backend

バックエンドは App Hosting の主要なリソースです。

JSON 表現 
{
  "name": string,
  "displayName": string,
  "servingLocality": enum (ServingLocality),
  "codebase": {
    object (Codebase)
  },
  "uri": string,
  "managedResources": [
    {
      object (ManagedResource)
    }
  ],
  "serviceAccount": string,
  "appId": string,
  "environment": 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}。
displayName

string

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

enum (ServingLocality)

必須。変更不可。App Hosting がこのバックエンドのコンテンツを提供する方法を指定します。これは、単一のリージョン（REGIONAL_STRICT）に格納されるか、App Hosting のグローバルに複製されたサービング インフラストラクチャ（GLOBAL_ACCESS）の使用が許可されます。
codebase

object (Codebase)

省略可。指定すると、バックエンドに対するイベント ドリブンの更新を監視するための外部ソース リポジトリへの接続。
uri

string

出力専用。バックエンドと通信するためのプライマリ URI。
managedResources[]

object (ManagedResource)

出力専用。このバックエンドによって管理されるリソースのリスト。
serviceAccount

string

必須。Cloud Build と Cloud Run に使用されるサービス アカウントの名前。roles/firebaseapphosting.googleapis.com/computeRunner または同等の権限が必要です。
appId

string

省略可。バックエンドに関連付けられたウェブアプリの ID。
environment

string

省略可。バックエンドの環境名。環境固有の構成から環境変数を読み込むために使用されます。
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

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

ServingLocality

App Hosting がバックエンドのデータを複製して提供する方法を指定します。

列挙型
SERVING_LOCALITY_UNSPECIFIED 指定なし。使用するとエラーが返されます。
REGIONAL_STRICT このモードでは、App Hosting は選択した親リージョンからバックエンドのコンテンツを提供します。App Hosting は、選択されたリージョン内でデータとサービスを提供するインフラストラクチャのみを維持し、データを他のリージョンに複製しません。
GLOBAL_ACCESS このモードでは、App Hosting は世界中の複数のポイント オブ プレゼンス（POP）からバックエンドのコンテンツを提供します。App Hosting はバックエンドの構成とキャッシュ データをこれらの POP に複製し、グローバル CDN を使用してレスポンスのレイテンシをさらに短縮します。プロジェクト上で App Hosting によって維持される Cloud リソース（Cloud Run サービス、Cloud Build ビルド、Artifact Registry イメージなど）は、引き続きバックエンドの親リージョンに限定されます。CDN によってキャッシュに保存されたレスポンスは、キャッシュの TTL の間、POP に保存されることがあります。

コードベース

バックエンドに対するイベント ドリブンな更新を監視するための外部ソース リポジトリへの接続。

JSON 表現 
{
  "repository": string,
  "rootDirectory": string
}
フィールド
repository

string

必須。このバックエンドに接続されている Developer Connect gitRepositoryLink のリソース名。形式:

projects/{project}/locations/{location}/connections/{connection}/gitRepositoryLinks/{repositoryLink}

gitRepositoryLink の接続には、Firebase コンソールから Firebase App Hosting GitHub アプリを使用する必要があります。
rootDirectory

string

省略可。repository が指定されている場合は、デプロイされたウェブアプリのルートとして使用するリポジトリのルートからの相対ディレクトリ。

マネージド リソース

プロジェクトで App Hosting によって管理される外部リソース。

JSON 表現 
{

  // Union field managed_resource can be only one of the following:
  "runService": {
    object (RunService)
  }
  // End of list of possible types for union field managed_resource.
}
フィールド

共用体フィールド managed_resource。

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

object (RunService)

App Hosting によって管理される Cloud Run service。

RunService

マネージド Cloud Run service。

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

string

省略可。Cloud Run service の名前。形式は次のとおりです。

projects/{project}/locations/{location}/services/{serviceId}

メソッド

create

 指定されたプロジェクトとロケーションに新しいバックエンドを作成します。

delete

 単一のバックエンドを削除します。

get

 バックエンドに関する情報を取得します。

getTraffic

 バックエンドのトラフィックに関する情報を取得します。

list

 指定されたプロジェクトとロケーションにあるバックエンドを一覧表示します。

patch

 単一のバックエンドの情報を更新します。

updateTraffic

 バックエンドのトラフィックを更新します。