REST Resource: sites.versions

Resource: Versi

Version adalah konfigurasi dan kumpulan file statis yang menentukan cara situs ditampilkan.

Representasi JSON 
{
  "name": string,
  "status": enum (VersionStatus),
  "config": {
    object (ServingConfig)
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "createUser": {
    object (ActingUser)
  },
  "finalizeTime": string,
  "finalizeUser": {
    object (ActingUser)
  },
  "deleteTime": string,
  "deleteUser": {
    object (ActingUser)
  },
  "fileCount": string,
  "versionBytes": string
}
Kolom
name

string

Nama resource yang sepenuhnya memenuhi syarat untuk versi, dalam format:

sites/SITE_ID/versions/VERSION_ID

Nama ini diberikan dalam isi respons saat Anda memanggil versions.create.
status

enum (VersionStatus)

Status deployment versi.

Agar deployment berhasil, panggil versions.create untuk membuat versi baru (status CREATED), upload semua file yang diinginkan ke versi, lalu update versi ke status FINALIZED.

Perlu diperhatikan bahwa jika Anda membiarkan versi dalam status CREATED selama lebih dari 12 jam, sistem akan otomatis menandai versi tersebut sebagai ABANDONED.

Anda juga dapat mengubah status versi menjadi DELETED dengan memanggil versions.delete.
config

object (ServingConfig)

Konfigurasi untuk perilaku situs. Konfigurasi ini ada di file firebase.json.
labels

map (key: string, value: string)

Label yang digunakan untuk metadata dan/atau pemfilteran tambahan.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
createTime

string (Timestamp format)

Hanya output. Waktu saat versi dibuat.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
createUser

object (ActingUser)

Hanya output. Mengidentifikasi pengguna yang membuat versi.
finalizeTime

string (Timestamp format)

Hanya output. Waktu saat versi FINALIZED.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
finalizeUser

object (ActingUser)

Hanya output. Mengidentifikasi pengguna yang FINALIZED versi.
deleteTime

string (Timestamp format)

Hanya output. Waktu saat versi DELETED.

Stempel waktu dalam RFC3339 UTC "Zulu" , dengan resolusi nanodetik dan hingga sembilan digit pecahan. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
deleteUser

object (ActingUser)

Hanya output. Mengidentifikasi pengguna yang DELETED versi.
fileCount

string (int64 format)

Hanya output. Jumlah total file yang terkait dengan versi.

Nilai ini dihitung setelah versi FINALIZED.
versionBytes

string (int64 format)

Hanya output. Total ukuran byte tersimpan dari versi ini.

Nilai ini dihitung setelah versi FINALIZED.

VersionStatus

Status yang diketahui saat ini dari versi tertentu dalam siklus proses penerapan.

Enumerasi
VERSION_STATUS_UNSPECIFIED Status default; tidak boleh digunakan secara sengaja.
CREATED Versi telah dibuat, dan konten sedang ditambahkan ke versi.
FINALIZED Semua konten telah ditambahkan ke versi, dan versi tidak dapat diubah lagi.
DELETED Versi telah dihapus.
ABANDONED Versi tidak diupdate ke FINALIZED dalam 12 jam dan otomatis dihapus.
EXPIRED Versi ini di luar batas yang dikonfigurasikan oleh situs untuk jumlah versi yang dipertahankan, sehingga konten versi dijadwalkan untuk dihapus.
CLONING Versi ini sedang di-clone dari versi lain. Semua konten masih sedang disalin.

ServingConfig

Konfigurasi terkait bagaimana permintaan masuk ke situs harus dirutekan dan diproses sebelum menayangkan konten. Jalur permintaan URL dicocokkan dengan pola URL yang ditentukan dalam konfigurasi, lalu Hosting menerapkan konfigurasi yang berlaku sesuai dengan urutan prioritas tertentu.

Representasi JSON 
{
  "headers": [
    {
      object (Header)
    }
  ],
  "redirects": [
    {
      object (Redirect)
    }
  ],
  "rewrites": [
    {
      object (Rewrite)
    }
  ],
  "cleanUrls": boolean,
  "trailingSlashBehavior": enum (TrailingSlashBehavior),
  "i18n": {
    object (I18nConfig)
  }
}
Kolom
headers[]

object (Header)

Array objek, dengan setiap objek menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk menerapkan header respons kustom yang ditentukan.
redirects[]

object (Redirect)

Array objek (disebut aturan pengalihan), dengan setiap aturan menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk merespons dengan pengalihan ke jalur tujuan yang ditentukan.
rewrites[]

object (Rewrite)

Array objek (disebut aturan penulisan ulang), dengan setiap aturan menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk merespons seolah-olah layanan diberi URL tujuan yang ditentukan.
cleanUrls

boolean

Menentukan apakah ekstensi file akan dihapus dari file yang diupload.
trailingSlashBehavior

enum (TrailingSlashBehavior)

Menentukan cara menangani garis miring penutup pada jalur URL.
i18n

object (I18nConfig)

Opsional. Menentukan perilaku penulisan ulang i18n.

Header menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk menerapkan header respons kustom yang ditentukan.

Representasi JSON 
{
  "headers": {
    string: string,
    ...
  },

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
Kolom
headers

map (key: string, value: string)

Wajib diisi. Header tambahan untuk ditambahkan ke respons.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Kolom union pattern.
Wajib diisi. Pola URL string yang akan dicocokkan dengan jalur URL permintaan untuk menentukan apakah akan menerapkan header respons kustom ini atau tidak. Dapat berupa glob bergaya Bash atau ekspresi reguler RE2.

pattern hanya dapat berupa salah satu dari yang berikut:
glob

string

glob yang disediakan pengguna agar dicocokkan dengan jalur URL permintaan.
regex

string

Ekspresi reguler RE2 yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.

Pengalihan

Redirect menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk merespons dengan pengalihan ke jalur tujuan yang ditentukan.

Representasi JSON 
{
  "statusCode": integer,
  "location": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.
}
Kolom
statusCode

integer

Wajib diisi. Kode HTTP status untuk ditampilkan dalam respons. Kode ini harus berupa kode status 3xx yang valid.
location

string

Wajib ada. Nilai yang akan dimasukkan ke dalam header lokasi HTTP pada respons.

Lokasi dapat berisi nilai grup tangkapan dari pola yang menggunakan awalan : untuk mengidentifikasi segmen dan * opsional untuk mengambil sisa URL. Contoh:

"glob": "/:capture*",
"statusCode": 301,
"location": "https://example.com/foo/:capture"
Kolom union pattern.
Wajib diisi. Pola URL string yang akan dicocokkan dengan jalur URL permintaan untuk menentukan apakah akan menerapkan pengalihan ini atau tidak. Dapat berupa glob bergaya Bash atau ekspresi reguler RE2.

pattern hanya dapat berupa salah satu dari yang berikut:
glob

string

glob yang disediakan pengguna agar dicocokkan dengan jalur URL permintaan.
regex

string

Ekspresi reguler RE2 yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.

Menulis ulang

Rewrite menentukan pola URL yang, jika cocok dengan jalur URL permintaan, akan memicu Hosting untuk merespons seolah-olah layanan diberi URL tujuan yang ditentukan.

Representasi JSON 
{
  "functionRegion": string,

  // Union field pattern can be only one of the following:
  "glob": string,
  "regex": string
  // End of list of possible types for union field pattern.

  // Union field behavior can be only one of the following:
  "path": string,
  "function": string,
  "run": {
    object (CloudRunRewrite)
  }
  // End of list of possible types for union field behavior.
}
Kolom
functionRegion

string

Opsional. Tentukan region Cloud untuk pemanggilan Functions yang ditulis ulang. Jika tidak diberikan, defaultnya adalah us-central1.
Kolom union pattern.
Wajib diisi. Pola URL string yang akan dicocokkan dengan jalur URL permintaan untuk menentukan apakah akan menerapkan penulisan ulang ini atau tidak. Dapat berupa glob bergaya Bash atau ekspresi reguler RE2.

pattern hanya dapat berupa salah satu dari yang berikut:
glob

string

glob yang disediakan pengguna agar dicocokkan dengan jalur URL permintaan.
regex

string

Ekspresi reguler RE2 yang disediakan pengguna untuk dicocokkan dengan jalur URL permintaan.
Kolom union behavior.
Wajib diisi. Perilaku penulisan ulang.

behavior hanya dapat berupa salah satu dari yang berikut:
path

string

Jalur URL yang menjadi tujuan penulisan ulang permintaan.
function

string

Fungsi yang menjadi tujuan proxy permintaan. Harus sama persis dengan nama fungsi yang diekspor.
run

object (CloudRunRewrite)

Permintaan akan diteruskan ke Cloud Run.

CloudRunRewrite

Penulisan ulang yang dikonfigurasi dan mengarahkan permintaan ke layanan Cloud Run. Jika layanan Cloud Run tidak tersedia saat mengatur atau memperbarui konfigurasi Firebase Hosting Anda, maka permintaan akan gagal. Setiap error yang muncul di layanan Cloud Run akan diteruskan ke pengguna akhir (misalnya, jika Anda menghapus suatu layanan, setiap permintaan yang diarahkan ke layanan tersebut akan menerima error 404).

Representasi JSON 
{
  "serviceId": string,
  "region": string,
  "tag": string
}
Kolom
serviceId

string

Wajib ada. ID yang ditentukan pengguna dari layanan Cloud Run.
region

string

Opsional. Region yang diisi oleh pengguna, tempat layanan Cloud Run dihosting.

Jika tidak disediakan, setelan defaultnya adalah us-central1.
tag

string

Opsional. Tag TrafficConfig yang disediakan pengguna sebagai tujuan pengiriman traffic.

Jika dihilangkan, traffic akan dikirim ke URI seluruh layanan

TrailingSlashBehavior

Menentukan apakah garis miring penutup harus ditambahkan atau dihapus dari jalur URL permintaan.

Enumerasi
TRAILING_SLASH_BEHAVIOR_UNSPECIFIED

Tidak ada perilaku yang ditentukan.

File hanya ditampilkan di lokasi persisnya, dan garis miring penutup hanya ditambahkan ke indeks direktori.
ADD Garis miring penutup ditambahkan ke indeks direktori serta ke setiap jalur URL yang tidak diakhiri dengan ekstensi file.
REMOVE Garis miring penutup dihapus dari indeks direktori serta dari setiap jalur URL yang tidak diakhiri dengan ekstensi file.

I18nConfig

Jika disediakan, penulisan ulang i18n akan diaktifkan.

Representasi JSON 
{
  "root": string
}
Kolom
root

string

Wajib diisi. Jalur yang disediakan pengguna tempat konten yang spesifik per negara dan bahasa akan dicari dalam direktori publik.

Metode

clone

 Membuat versi baru di situs target yang ditentukan menggunakan konten versi yang ditentukan.

create

 Membuat versi baru untuk situs yang ditentukan.

delete

 Menghapus versi yang ditentukan.

get

 Mendapatkan versi tertentu yang telah dibuat untuk situs tertentu.

list

 Mencantumkan versi yang telah dibuat untuk situs tertentu.

patch

 Mengupdate metadata yang ditentukan untuk versi yang ditentukan.

populateFiles

 Menambahkan file konten ke versi yang ditentukan.