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

Resource: JobRun

Resource JobRun di Cloud Deploy API.

JobRun berisi informasi dari satu evaluasi tugas Rollout.

Representasi JSON
{
  "name": string,
  "uid": string,
  "phaseId": string,
  "jobId": string,
  "createTime": string,
  "startTime": string,
  "endTime": string,
  "state": enum (State),
  "etag": string,

  // Union field job_run can be only one of the following:
  "deployJobRun": {
    object (DeployJobRun)
  },
  "verifyJobRun": {
    object (VerifyJobRun)
  },
  "predeployJobRun": {
    object (PredeployJobRun)
  },
  "postdeployJobRun": {
    object (PostdeployJobRun)
  },
  "createChildRolloutJobRun": {
    object (CreateChildRolloutJobRun)
  },
  "advanceChildRolloutJobRun": {
    object (AdvanceChildRolloutJobRun)
  }
  // End of list of possible types for union field job_run.
}
Kolom
name

string

Opsional. Nama JobRun. Formatnya adalah projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{releases}/rollouts/{rollouts}/jobRuns/{uuid}.

uid

string

Hanya output. ID unik JobRun.

phaseId

string

Hanya output. ID fase Rollout yang mencakup JobRun ini.

jobId

string

Hanya output. ID tugas Rollout yang terkait dengan JobRun ini.

createTime

string (Timestamp format)

Hanya output. Waktu pembuatan JobRun.

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".

startTime

string (Timestamp format)

Hanya output. Waktu saat JobRun dimulai.

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".

endTime

string (Timestamp format)

Hanya output. Waktu saat JobRun berakhir.

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".

state

enum (State)

Hanya output. Status JobRun saat ini.

etag

string

Hanya output. 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.

Kolom union job_run. Jenis JobRun dan informasi untuk jenis tersebut. job_run hanya dapat berupa salah satu dari yang berikut:
deployJobRun

object (DeployJobRun)

Hanya output. Informasi khusus untuk JobRun deploy.

verifyJobRun

object (VerifyJobRun)

Hanya output. Informasi khusus untuk JobRun verifikasi.

predeployJobRun

object (PredeployJobRun)

Hanya output. Informasi khusus untuk JobRun pra-deployment.

postdeployJobRun

object (PostdeployJobRun)

Hanya output. Informasi khusus untuk JobRun pasca-deployment.

createChildRolloutJobRun

object (CreateChildRolloutJobRun)

Hanya output. Informasi khusus untuk JobRun createChildLaunch.

advanceChildRolloutJobRun

object (AdvanceChildRolloutJobRun)

Hanya output. Informasi khusus untuk JobRun advancedChildlaunch

Negara bagian/Provinsi

Status JobRun yang valid.

Enum
STATE_UNSPECIFIED JobRun memiliki status yang tidak ditentukan.
IN_PROGRESS JobRun sedang berlangsung.
SUCCEEDED JobRun berhasil.
FAILED JobRun gagal.
TERMINATING JobRun dihentikan.
TERMINATED JobRun dihentikan.

DeployJobRun

DeployJobRun berisi informasi khusus untuk JobRun deploy.

Representasi JSON
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string,
  "metadata": {
    object (DeployJobRunMetadata)
  },
  "artifact": {
    object (DeployArtifact)
  }
}
Kolom
build

string

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

failureCause

enum (FailureCause)

Hanya output. Alasan deployment gagal. Hal ini akan selalu tidak ditentukan saat deployment sedang berlangsung atau jika berhasil.

failureMessage

string

Hanya output. Informasi tambahan tentang kegagalan deployment, jika tersedia.

metadata

object (DeployJobRunMetadata)

Hanya output. Metadata yang berisi informasi tentang operasi tugas deploy.

artifact

object (DeployArtifact)

Hanya output. Artefak menjalankan tugas deployment, jika tersedia.

FailureCause

Kegagalan deploy yang umum diketahui.

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 Operasi tugas deploy tidak selesai dalam waktu yang dialokasikan.
MISSING_RESOURCES_FOR_CANARY Terdapat resource yang hilang di lingkungan runtime yang diperlukan untuk deployment canary. Periksa log Cloud Build untuk mengetahui informasi selengkapnya.
CLOUD_BUILD_REQUEST_FAILED Cloud Build gagal memenuhi permintaan Cloud Deploy. Lihat failedMessage untuk mengetahui detail selengkapnya.
DEPLOY_FEATURE_NOT_SUPPORTED Operasi deployment memiliki fitur yang dikonfigurasi tetapi tidak didukung.

DeployJobRunMetadata

DeployJobRunMetadata menampilkan informasi yang terkait dengan DeployJobRun kepada pengguna.

Representasi JSON
{
  "cloudRun": {
    object (CloudRunMetadata)
  },
  "customTarget": {
    object (CustomTargetDeployMetadata)
  },
  "custom": {
    object (CustomMetadata)
  }
}
Kolom
cloudRun

object (CloudRunMetadata)

Hanya output. Nama Layanan Cloud Run yang dikaitkan dengan DeployJobRun.

customTarget

object (CustomTargetDeployMetadata)

Hanya output. Metadata Target kustom yang terkait dengan DeployJobRun.

custom

object (CustomMetadata)

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

CustomTargetDeployMetadata

CustomTargetDeployMetadata berisi informasi dari operasi deploy Target Kustom.

Representasi JSON
{
  "skipMessage": string
}
Kolom
skipMessage

string

Hanya output. Lewati pesan yang diberikan dalam hasil operasi deploy kustom.

DeployArtifact

Artefak yang dihasilkan oleh operasi deployment.

Representasi JSON
{
  "artifactUri": string,
  "manifestPaths": [
    string
  ]
}
Kolom
artifactUri

string

Hanya output. URI direktori yang berisi artefak. Semua jalur relatif terhadap lokasi ini.

manifestPaths[]

string

Hanya output. Jalur file manifes yang diterapkan selama operasi deploy relatif terhadap URI.

VerifyJobRun

VerifyJobRun berisi informasi khusus untuk verifikasi JobRun.

Representasi JSON
{
  "build": string,
  "artifactUri": string,
  "eventLogPath": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Kolom
build

string

Hanya output. Nama resource objek Build Cloud Build yang digunakan untuk memverifikasi. Formatnya adalah projects/{project}/locations/{location}/builds/{build}.

artifactUri

string

Hanya output. URI direktori yang berisi artefak verifikasi. File ini berisi log peristiwa Skaffold.

eventLogPath

string

Hanya output. Jalur file log peristiwa Skaffold relatif terhadap URI artefak.

failureCause

enum (FailureCause)

Hanya output. Alasan verifikasi gagal. Hal ini akan selalu tidak ditentukan saat verifikasi sedang berlangsung atau jika berhasil.

failureMessage

string

Hanya output. Informasi tambahan tentang kegagalan verifikasi, jika tersedia.

FailureCause

Kegagalan verifikasi yang umum terjadi.

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 verifikasi tidak berhasil diselesaikan; periksa log Cloud Build.
DEADLINE_EXCEEDED Operasi tugas verifikasi tidak selesai dalam waktu yang dialokasikan.
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.

PredeployJobRun

PredeployJobRun berisi informasi khusus untuk JobRun pra-deployment.

Representasi JSON
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Kolom
build

string

Hanya output. Nama resource objek Build Cloud Build yang digunakan untuk menjalankan tindakan kustom yang terkait dengan Tugas pra-deploy. Formatnya adalah projects/{project}/locations/{location}/builds/{build}.

failureCause

enum (FailureCause)

Hanya output. Alasan pra-deployment gagal. Kolom ini akan selalu tidak ditentukan saat pra-deployment sedang berlangsung atau jika berhasil.

failureMessage

string

Hanya output. Informasi tambahan tentang kegagalan pra-deployment, jika tersedia.

FailureCause

Kegagalan pra-deployment yang umum terjadi.

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 pra-deployment tidak berhasil diselesaikan; periksa log Cloud Build.
DEADLINE_EXCEEDED Tugas pra-deployment tidak selesai dalam waktu yang ditentukan.
CLOUD_BUILD_REQUEST_FAILED Cloud Build gagal memenuhi permintaan Cloud Deploy. Lihat failedMessage untuk mengetahui detail selengkapnya.

PostdeployJobRun

PostdeployJobRun berisi informasi khusus untuk JobRun pasca-deployment.

Representasi JSON
{
  "build": string,
  "failureCause": enum (FailureCause),
  "failureMessage": string
}
Kolom
build

string

Hanya output. Nama resource objek Build Cloud Build yang digunakan untuk menjalankan tindakan kustom yang terkait dengan Tugas pasca-deployment. Formatnya adalah projects/{project}/locations/{location}/builds/{build}.

failureCause

enum (FailureCause)

Hanya output. Penyebab pasca-deployment gagal. Kolom ini akan selalu tidak ditentukan saat pasca-deployment sedang berlangsung atau jika berhasil.

failureMessage

string

Hanya output. Informasi tambahan tentang kegagalan pasca-deployment, jika tersedia.

FailureCause

Kegagalan pasca-deployment yang terkenal.

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 pasca-deployment tidak berhasil diselesaikan; periksa log Cloud Build.
DEADLINE_EXCEEDED Tugas pasca-deployment tidak selesai dalam waktu yang ditentukan.
CLOUD_BUILD_REQUEST_FAILED Cloud Build gagal memenuhi permintaan Cloud Deploy. Lihat failedMessage untuk mengetahui detail selengkapnya.

CreateChildRolloutJobRun

CreateChildLaunchJobRun berisi informasi khusus untuk JobRun createChild rollout.

Representasi JSON
{
  "rollout": string,
  "rolloutPhaseId": string
}
Kolom
rollout

string

Hanya output. Nama ChildRollout. Formatnya adalah projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

rolloutPhaseId

string

Hanya output. ID Fase turunanLaunch yang dimulai oleh JobRun ini.

AdvanceChildRolloutJobRun

AdvanceChildLaunchJobRun berisi informasi khusus untuk JobRun advancedChildPresence.

Representasi JSON
{
  "rollout": string,
  "rolloutPhaseId": string
}
Kolom
rollout

string

Hanya output. Nama ChildRollout. Formatnya adalah projects/{project}/locations/{location}/deliveryPipelines/{deliveryPipeline}/releases/{release}/rollouts/{rollout}.

rolloutPhaseId

string

Khusus output. ID Tahap Turunan Peluncuran.

Metode

get

Mendapatkan detail satu JobRun.

list

Mencantumkan JobRun di project dan lokasi tertentu.

terminate

Menghentikan Job Run di project dan lokasi tertentu.