REST Resource: projects.locations.deliveryPipelines.releases.rollouts

Resource: Peluncuran

Resource Rollout di Cloud Deploy API.

Rollout berisi informasi seputar deployment tertentu untuk Target.

Representasi JSON 
{
  "name": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "createTime": string,
  "approveTime": string,
  "enqueueTime": string,
  "deployStartTime": string,
  "deployEndTime": string,
  "targetId": string,
  "approvalState": enum (ApprovalState),
  "state": enum (State),
  "failureReason": string,
  "deployingBuild": string,
  "etag": string,
  "deployFailureCause": enum (FailureCause),
  "phases": [
    {
      object (Phase)
    }
  ],
  "metadata": {
    object (Metadata)
  },
  "controllerRollout": string,
  "rollbackOfRollout": string,
  "rolledBackByRollouts": [
    string
  ]
}
Kolom
name

string

Opsional. Nama Rollout. Formatnya adalah projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}.
uid

string

Hanya output. ID unik Rollout.
description

string

Deskripsi Rollout untuk tujuan pengguna. Panjang maksimal adalah 255 karakter.
annotations

map (key: string, value: string)

Anotasi pengguna. Atribut ini hanya dapat ditetapkan dan digunakan oleh pengguna, bukan oleh Cloud Deploy. Lihat https://google.aip.dev/128#annotations untuk mengetahui detail selengkapnya seperti batasan format dan ukuran.

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

map (key: string, value: string)

Label adalah atribut yang dapat ditetapkan dan digunakan oleh pengguna dan oleh Cloud Deploy. Label harus memenuhi batasan berikut:

  • Kunci dan nilai hanya boleh berisi huruf kecil, karakter numerik, garis bawah, dan tanda hubung.
  • Semua karakter harus menggunakan encoding UTF-8, dan karakter internasional diperbolehkan.
  • Kunci harus diawali dengan huruf kecil atau karakter internasional.
  • Setiap resource dibatasi maksimum 64 label.

Kunci dan nilai juga dibatasi menjadi <= 128 byte.

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

string (Timestamp format)

Hanya output. Waktu pembuatan Rollout.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
approveTime

string (Timestamp format)

Hanya output. Waktu saat Rollout disetujui.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
enqueueTime

string (Timestamp format)

Hanya output. Waktu saat Rollout diantrekan.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
deployStartTime

string (Timestamp format)

Hanya output. Waktu Rollout mulai di-deploy.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
deployEndTime

string (Timestamp format)

Hanya output. Waktu saat Rollout selesai di-deploy.

Stempel waktu dalam format RFC3339 UTC "Zulu", dengan resolusi nanodetik dan maksimal sembilan digit fraksional. Contoh: "2014-10-02T15:01:23Z" dan "2014-10-02T15:01:23.045123456Z".
targetId

string

Wajib. ID Target yang menjadi tujuan deployment Rollout ini.
approvalState

enum (ApprovalState)

Hanya output. Status persetujuan Rollout.
state

enum (State)

Hanya output. Status Rollout saat ini.
failureReason

string

Hanya output. Informasi tambahan tentang kegagalan peluncuran, jika tersedia.
deployingBuild

string

Hanya output. Nama resource objek Build Cloud Build yang digunakan untuk men-deploy Peluncuran. Formatnya adalah projects/{project}/locations/{location}/builds/{build}.
etag

string

Checksum ini dihitung oleh server berdasarkan nilai kolom lain, dan dapat dikirim pada saat permintaan update dan penghapusan untuk memastikan klien memiliki nilai terbaru sebelum melanjutkan.
deployFailureCause

enum (FailureCause)

Hanya output. Alasan gagalnya peluncuran ini. Dukungan ini tidak akan selalu ditentukan saat peluncuran berlangsung.
phases[]

object (Phase)

Hanya output. Fase yang mewakili alur kerja Rollout ini.
metadata

object (Metadata)

Hanya output. Metadata berisi informasi tentang peluncuran.
controllerRollout

string

Hanya output. Nama ControllerRollout. Formatnya adalah projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/[a-z][a-z0-9\-]{0,62}.
rollbackOfRollout

string

Hanya output. Nama Rollout yang di-roll back oleh Rollout ini. Kosong jika Rollout ini tidak dibuat sebagai rollback.
rolledBackByRollouts[]

string

Hanya output. Nama Rollouts yang melakukan roll back Rollout ini.

ApprovalState

Status persetujuan Rollout yang valid.

Enum
APPROVAL_STATE_UNSPECIFIED Rollout memiliki status persetujuan yang belum ditetapkan.
NEEDS_APPROVAL Rollout memerlukan persetujuan.
DOES_NOT_NEED_APPROVAL Rollout tidak memerlukan persetujuan.
APPROVED Rollout telah disetujui.
REJECTED Rollout telah ditolak.

Negara bagian/Provinsi

Status Rollout yang valid.

Enum
STATE_UNSPECIFIED Rollout memiliki status yang tidak ditentukan.
SUCCEEDED Rollout berhasil diselesaikan.
FAILED Rollout gagal.
IN_PROGRESS Rollout sedang di-deploy.
PENDING_APPROVAL Rollout memerlukan persetujuan.
APPROVAL_REJECTED Pemberi persetujuan menolak Rollout.
PENDING Rollout sedang menunggu Peluncuran sebelumnya selesai pada Target ini.
PENDING_RELEASE Rollout menunggu Release dirender sepenuhnya.
CANCELLING Rollout sedang dalam proses dibatalkan.
CANCELLED Rollout telah dibatalkan.
HALTED Rollout dihentikan.

FailureCause

Kegagalan peluncuran umum.

Enum
FAILURE_CAUSE_UNSPECIFIED Tidak ada alasan kegagalan yang ditentukan.
CLOUD_BUILD_UNAVAILABLE Cloud Build tidak tersedia karena tidak diaktifkan atau karena Cloud Deploy tidak memiliki izin yang memadai. Lihat izin yang diperlukan.
EXECUTION_FAILED Operasi deployment tidak berhasil diselesaikan; periksa log Cloud Build.
DEADLINE_EXCEEDED Deployment tidak selesai dalam waktu yang ditentukan.
RELEASE_FAILED Rilis dalam status gagal.
RELEASE_ABANDONED Rilis diabaikan.
VERIFICATION_CONFIG_NOT_FOUND Tidak ditemukan konfigurasi verifikasi Skaffold.
CLOUD_BUILD_REQUEST_FAILED Cloud Build gagal memenuhi permintaan Cloud Deploy. Lihat failedMessage untuk mengetahui detail selengkapnya.
OPERATION_FEATURE_NOT_SUPPORTED Operasi Peluncuran memiliki fitur yang dikonfigurasi, tetapi tidak didukung.

Fase

Fase mewakili kumpulan tugas yang secara logis dikelompokkan bersama untuk Rollout.

Representasi JSON 
{
  "id": string,
  "state": enum (State),
  "skipMessage": string,

  // Union field jobs can be only one of the following:
  "deploymentJobs": {
    object (DeploymentJobs)
  },
  "childRolloutJobs": {
    object (ChildRolloutJobs)
  }
  // End of list of possible types for union field jobs.
}
Kolom
id

string

Hanya output. ID Fase.
state

enum (State)

Hanya output. Status Fase saat ini.
skipMessage

string

Hanya output. Informasi tambahan tentang alasan Fase dilewati, jika tersedia.
Kolom union jobs. Komposisi tugas Fase ini. jobs hanya ada berupa salah satu diantara berikut:
deploymentJobs

object (DeploymentJobs)

Hanya output. Komposisi tugas deployment.
childRolloutJobs

object (ChildRolloutJobs)

Hanya output. Komposisi tugas Peluncuran Turunan.

Negara bagian/Provinsi

Status Fase yang valid.

Enum
STATE_UNSPECIFIED Fase memiliki status yang tidak ditentukan.
PENDING Fase menunggu hingga Fase sebelumnya selesai.
IN_PROGRESS Tahap sedang berlangsung.
SUCCEEDED Fase telah berhasil.
FAILED Fase gagal.
ABORTED Fase dibatalkan.
SKIPPED Fase dilewati.

DeploymentJobs

Komposisi tugas deployment.

Representasi JSON 
{
  "deployJob": {
    object (Job)
  },
  "verifyJob": {
    object (Job)
  },
  "predeployJob": {
    object (Job)
  },
  "postdeployJob": {
    object (Job)
  }
}
Kolom
deployJob

object (Job)

Hanya output. Tugas deploy. Ini adalah tugas deploy dalam fase.
verifyJob

object (Job)

Hanya output. Tugas verifikasi. Berjalan setelah deploy jika deployment berhasil.
predeployJob

object (Job)

Hanya output. Tugas pra-deployment, yang merupakan tugas pertama pada fase.
postdeployJob

object (Job)

Hanya output. Tugas pasca-deployment, yang merupakan tugas terakhir di fase tersebut.

Tugas

Tugas mewakili operasi untuk Rollout.

Representasi JSON 
{
  "id": string,
  "state": enum (State),
  "skipMessage": string,
  "jobRun": string,

  // Union field job_type can be only one of the following:
  "deployJob": {
    object (DeployJob)
  },
  "verifyJob": {
    object (VerifyJob)
  },
  "predeployJob": {
    object (PredeployJob)
  },
  "postdeployJob": {
    object (PostdeployJob)
  },
  "createChildRolloutJob": {
    object (CreateChildRolloutJob)
  },
  "advanceChildRolloutJob": {
    object (AdvanceChildRolloutJob)
  }
  // End of list of possible types for union field job_type.
}
Kolom
id

string

Hanya output. ID Pekerjaan.
state

enum (State)

Hanya output. Status Pekerjaan saat ini.
skipMessage

string

Hanya output. Informasi tambahan tentang alasan Lowongan dilewati, jika tersedia.
jobRun

string

Hanya output. Nama JobRun yang bertanggung jawab atas pemanggilan Pekerjaan ini baru-baru ini.
Kolom union job_type. Jenis Pekerjaan. job_type hanya ada berupa salah satu diantara berikut:
deployJob

object (DeployJob)

Hanya output. Tugas deploy.
verifyJob

object (VerifyJob)

Hanya output. Pekerjaan verifikasi.
predeployJob

object (PredeployJob)

Hanya output. Tugas pra-deployment.
postdeployJob

object (PostdeployJob)

Hanya output. Tugas pasca-deployment.
createChildRolloutJob

object (CreateChildRolloutJob)

Hanya output. Tugas createChildLaunch.
advanceChildRolloutJob

object (AdvanceChildRolloutJob)

Hanya output. Pekerjaan advancedChildlaunch.

Negara bagian/Provinsi

Status Pekerjaan yang valid.

Enum
STATE_UNSPECIFIED Tugas memiliki status yang tidak ditentukan.
PENDING Pekerjaan sedang menunggu Fase atau Tugas sebelumnya untuk diselesaikan.
DISABLED Tugas dinonaktifkan.
IN_PROGRESS Tugas sedang dalam proses.
SUCCEEDED Tugas berhasil.
FAILED Tugas gagal.
ABORTED Pekerjaan dibatalkan.
SKIPPED Tugas dilewati.
IGNORED Tugas telah diabaikan.

DeployJob

Jenis ini tidak memiliki kolom.

Tugas deploy.

VerifyJob

Jenis ini tidak memiliki kolom.

Pekerjaan verifikasi.

PredeployJob

Tugas pra-deployment.

Representasi JSON 
{
  "actions": [
    string
  ]
}
Kolom
actions[]

string

Hanya output. Tindakan kustom yang dijalankan Tugas pra-deployment.

PostdeployJob

Tugas pasca-deployment.

Representasi JSON 
{
  "actions": [
    string
  ]
}
Kolom
actions[]

string

Hanya output. Tindakan kustom yang dijalankan Tugas pasca-deployment.

CreateChildRolloutJob

Jenis ini tidak memiliki kolom.

Tugas createChildLaunch.

AdvanceChildRolloutJob

Jenis ini tidak memiliki kolom.

Pekerjaan advancedChildlaunch.

ChildRolloutJobs

Komposisi tugas Childlaunchs

Representasi JSON 
{
  "createRolloutJobs": [
    {
      object (Job)
    }
  ],
  "advanceRolloutJobs": [
    {
      object (Job)
    }
  ]
}
Kolom
createRolloutJobs[]

object (Job)

Hanya output. Daftar CreateChildLaunchJobs
advanceRolloutJobs[]

object (Job)

Hanya output. Daftar AdvanceChildLaunchJobs

Metadata

Metadata mencakup informasi yang terkait dengan Rollout.

Representasi JSON 
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "automation": {
    object (AutomationRolloutMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Kolom
cloudRun

object (CloudRunMetadata)

Hanya output. Nama Layanan Cloud Run yang dikaitkan dengan Rollout.
automation

object (AutomationRolloutMetadata)

Hanya output. AutomationLaunchMetadata berisi informasi tentang interaksi antara layanan Automation dan peluncuran ini.
custom

object (CustomMetadata)

Hanya output. Metadata kustom yang disediakan oleh operasi Rollout yang ditentukan pengguna.

AutomationRolloutMetadata

AutomationLaunchMetadata berisi tindakan terkait Automation yang dilakukan pada peluncuran.

Representasi JSON 
{
  "promoteAutomationRun": string,
  "advanceAutomationRuns": [
    string
  ],
  "repairAutomationRuns": [
    string
  ],
  "currentRepairAutomationRun": string
}
Kolom
promoteAutomationRun

string

Hanya output. ID AutomationRun yang dimulai oleh aturan rilis promosi.
advanceAutomationRuns[]

string

Hanya output. ID AutomationRuns yang dimulai oleh aturan peluncuran awal.
repairAutomationRuns[]

string

Hanya output. ID AutomationRuns yang dimulai oleh aturan peluncuran perbaikan.
currentRepairAutomationRun

string

Hanya output. AutomationRun saat ini memperbaiki peluncuran.

Metode

advance

 Memajukan Peluncuran di project dan lokasi tertentu.

approve

 Menyetujui Peluncuran.

cancel

 Membatalkan Peluncuran di project dan lokasi tertentu.

create

 Membuat Peluncuran baru di project dan lokasi tertentu.

get

 Mendapatkan detail satu Peluncuran.

ignoreJob

 Mengabaikan Tugas yang ditentukan dalam Peluncuran.

list

 Mencantumkan Peluncuran di project dan lokasi tertentu.

retryJob

 Mencoba kembali Tugas yang ditentukan dalam Peluncuran.