REST Resource: sites.channels

リソース: Channel

Channel は、サイトのリリースのストリームを表します。すべてのサイトにはデフォルトの live チャネルがあり、Firebase から提供されたサブドメインと接続されたカスタム ドメインにコンテンツを配信します。

JSON 表現
{
  "name": string,
  "url": string,
  "release": {
    object (Release)
  },
  "createTime": string,
  "updateTime": string,
  "retainedReleaseCount": integer,
  "labels": {
    string: string,
    ...
  },

  // Union field expiration can be only one of the following:
  "expireTime": string,
  "ttl": string
  // End of list of possible types for union field expiration.
}
フィールド
name

string

チャネルの完全修飾リソース名。形式は次のとおりです。

sites/SITE_ID/channels/CHANNEL_ID

url

string

出力専用。このチャンネルの現在のリリースのコンテンツを表示できる URL。この URL は Firebase が提供する web.app のサブドメインです。

このチャンネルの現在のリリースのコンテンツは、Firebase が提供するサブドメイン(firebaseapp.com)でも表示できます。

このチャネルが Hosting サイトの live チャネルである場合、このチャネルの現在のリリースのコンテンツは、接続されたカスタム ドメインでも表示できます。

release

object (Release)

出力専用。チャンネルの現在のリリース(ある場合)。

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"

retainedReleaseCount

integer

ロールバックやその他の目的でチャンネルに保持される過去のリリースの数。

1 ~ 100 の数字で指定する必要があります。新しいチャネルのデフォルトは 10 です。

labels

map (key: string, value: string)

追加のメタデータやフィルタリングに使用されるテキストラベル。

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

共用体フィールド expiration

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

expireTime

string (Timestamp format)

チャンネルが自動的に削除される時刻。

null の場合、チャンネルは自動的に削除されません。このフィールドは、直接設定されるか ttl フィールドを介して設定されるかにかかわらず、出力に存在します。

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

ttl

string (Duration format)

入力のみのこのチャンネルの有効期間です。expireTime を、リクエストの時点から指定された期間に設定します。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

メソッド

create

指定されたサイトに新しいチャネルを作成します。

delete

指定したサイトの指定したチャネルを削除します。

get

指定したサイトの指定したチャネルの情報を取得します。

list

指定したサイトのチャネルを一覧表示します。

patch

指定したサイトの指定したチャネルの情報を更新します。