REST Resource: projects.locations.targets

Resource: Target

Resource Target di Cloud Deploy API.

Target menentukan lokasi tempat konfigurasi Skaffold dapat di-deploy.

Representasi JSON 
{
  "name": string,
  "targetId": string,
  "uid": string,
  "description": string,
  "annotations": {
    string: string,
    ...
  },
  "labels": {
    string: string,
    ...
  },
  "requireApproval": boolean,
  "createTime": string,
  "updateTime": string,
  "etag": string,
  "executionConfigs": [
    {
      object (ExecutionConfig)
    }
  ],
  "deployParameters": {
    string: string,
    ...
  },

  // Union field deployment_target can be only one of the following:
  "gke": {
    object (GkeCluster)
  },
  "anthosCluster": {
    object (AnthosCluster)
  },
  "run": {
    object (CloudRunLocation)
  },
  "multiTarget": {
    object (MultiTarget)
  },
  "customTarget": {
    object (CustomTarget)
  }
  // End of list of possible types for union field deployment_target.
}
Kolom
name

string

Opsional. Nama Target. Formatnya adalah projects/{project}/locations/{location}/targets/{target}. Komponen target harus cocok dengan [a-z]([a-z0-9-]{0,61}[a-z0-9])?
targetId

string

Hanya output. ID resource Target.
uid

string

Hanya output. ID unik Target.
description

string

Opsional. Deskripsi Target. Panjang maksimal adalah 255 karakter.
annotations

map (key: string, value: string)

Opsional. 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)

Opsional. 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" }.
requireApproval

boolean

Opsional. Apakah Target memerlukan persetujuan atau tidak.
createTime

string (Timestamp format)

Hanya output. Waktu pembuatan Target.

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

string (Timestamp format)

Hanya output. Waktu terakhir saat Target diperbarui.

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

string

Opsional. 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.
executionConfigs[]

object (ExecutionConfig)

Konfigurasi untuk semua eksekusi yang terkait dengan Target ini. Setiap nilai ExecutionEnvironmentUsage hanya dapat digunakan dalam satu konfigurasi; menggunakan nilai yang sama beberapa kali akan menyebabkan error. Saat satu atau beberapa konfigurasi ditentukan, konfigurasi tersebut harus menyertakan nilai ExecutionEnvironmentUsage RENDER dan DEPLOY. Jika tidak ada konfigurasi yang ditentukan, eksekusi akan menggunakan default yang ditentukan di DefaultPool.
deployParameters

map (key: string, value: string)

Opsional. Parameter deploy yang akan digunakan untuk target ini.

Objek yang berisi daftar pasangan "key": value. Contoh: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Kolom union deployment_target. Tujuan tempat konfigurasi Skaffold diterapkan selama peluncuran. deployment_target hanya ada berupa salah satu diantara berikut:
gke

object (GkeCluster)

Opsional. Informasi yang menentukan Cluster GKE.
anthosCluster

object (AnthosCluster)

Opsional. Informasi yang menentukan Cluster Anthos.
run

object (CloudRunLocation)

Opsional. Informasi yang menentukan target deployment Cloud Run.
multiTarget

object (MultiTarget)

Opsional. Informasi yang menentukan multiTarget.
customTarget

object (CustomTarget)

Opsional. Informasi yang menentukan Target Kustom.

GkeCluster

Informasi yang menentukan Cluster GKE.

Representasi JSON 
{
  "cluster": string,
  "internalIp": boolean
}
Kolom
cluster

string

Opsional. Informasi yang menentukan Cluster GKE. Formatnya adalah projects/{projectId}/locations/{locationId}/clusters/{cluster_id}.
internalIp

boolean

Opsional. Jika benar, cluster akan diakses menggunakan alamat IP pribadi dari endpoint bidang kontrol. Jika tidak, alamat IP default dari endpoint bidang kontrol akan digunakan. Alamat IP default adalah alamat IP pribadi untuk cluster dengan endpoint bidang kontrol pribadi dan alamat IP publik sebaliknya.

Hanya tentukan opsi ini jika cluster adalah cluster GKE pribadi.

AnthosCluster

Informasi yang menentukan Cluster Anthos.

Representasi JSON 
{
  "membership": string
}
Kolom
membership

string

Opsional. Keanggotaan cluster yang terdaftar di GKE Hub tempat konfigurasi Skaffold akan diterapkan. Formatnya adalah projects/{project}/locations/{location}/memberships/{membership_name}.

CloudRunLocation

Informasi yang menentukan tempat men-deploy Layanan Cloud Run.

Representasi JSON 
{
  "location": string
}
Kolom
location

string

Wajib. Lokasi untuk Layanan Cloud Run. Format harus projects/{project}/locations/{location}.

MultiTarget

Informasi yang menentukan multiTarget.

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

string

Wajib. ID target multiTarget ini.

CustomTarget

Informasi yang menentukan Target Kustom.

Representasi JSON 
{
  "customTargetType": string
}
Kolom
customTargetType

string

Wajib. Nama CustomTargetType. Format harus projects/{project}/locations/{location}/customTargetTypes/{customTargetType}.

ExecutionConfig

Konfigurasi lingkungan yang akan digunakan saat memanggil Skaffold.

Representasi JSON 
{
  "usages": [
    enum (ExecutionEnvironmentUsage)
  ],
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string,
  "executionTimeout": string,
  "verbose": boolean,

  // Union field execution_environment can be only one of the following:
  "defaultPool": {
    object (DefaultPool)
  },
  "privatePool": {
    object (PrivatePool)
  }
  // End of list of possible types for union field execution_environment.
}
Kolom
usages[]

enum (ExecutionEnvironmentUsage)

Wajib. Penggunaan saat konfigurasi ini harus diterapkan.
workerPool

string

Opsional. Nama resource WorkerPool, dengan format projects/{project}/locations/{location}/workerPools/{workerPool}. Jika kolom opsional ini tidak ditentukan, kumpulan Cloud Build default akan digunakan.
serviceAccount

string

Opsional. Akun layanan Google yang akan digunakan untuk eksekusi. Jika tidak ditentukan, akun layanan eksekusi project (-compute@developer.gserviceaccount.com) akan digunakan.
artifactStorage

string

Opsional. Lokasi Cloud Storage tempat untuk menyimpan output eksekusi. ID ini dapat berupa bucket ("gs://my-bucket") atau jalur dalam bucket ("gs://my-bucket/my-dir"). Jika tidak ditentukan, bucket default yang terletak di region yang sama akan digunakan.
executionTimeout

string (Duration format)

Opsional. Waktu tunggu eksekusi untuk Eksekusi Cloud Build habis. Ini harus antara 10 mnt dan 24 jam dalam format detik. Jika tidak ditentukan, waktu tunggu default selama 1 jam akan digunakan.

Durasi dalam detik dengan maksimal sembilan digit pecahan, diakhiri dengan 's'. Contoh: "3.5s".
verbose

boolean

Opsional. Jika true (benar), logging tambahan akan diaktifkan untuk eksekusi Cloud Build yang berjalan di lingkungan eksekusi ini.
Kolom union execution_environment. Detail lingkungan. execution_environment hanya ada berupa salah satu diantara berikut:
defaultPool

object (DefaultPool)

Opsional. Gunakan kumpulan Cloud Build default.
privatePool

object (PrivatePool)

Opsional. Menggunakan kumpulan Cloud Build pribadi.

ExecutionEnvironmentUsage

Kemungkinan penggunaan konfigurasi ini.

Enum
EXECUTION_ENVIRONMENT_USAGE_UNSPECIFIED Nilai default. Nilai ini tidak digunakan.
RENDER Gunakan untuk rendering.
DEPLOY Digunakan untuk hook deployment dan deployment.
VERIFY Gunakan untuk verifikasi deployment.
PREDEPLOY Digunakan untuk eksekusi tugas pra-deployment.
POSTDEPLOY Digunakan untuk eksekusi tugas pasca-deployment.

DefaultPool

Eksekusi menggunakan kumpulan Cloud Build default.

Representasi JSON 
{
  "serviceAccount": string,
  "artifactStorage": string
}
Kolom
serviceAccount

string

Opsional. Akun layanan Google yang akan digunakan untuk eksekusi. Jika tidak ditentukan, akun layanan eksekusi project (-compute@developer.gserviceaccount.com) akan digunakan.
artifactStorage

string

Opsional. Lokasi Cloud Storage tempat output eksekusi akan disimpan. ID ini dapat berupa bucket ("gs://my-bucket") atau jalur dalam bucket ("gs://my-bucket/my-dir"). Jika tidak ditentukan, bucket default yang terletak di region yang sama akan digunakan.

PrivatePool

Eksekusi menggunakan kumpulan Cloud Build pribadi.

Representasi JSON 
{
  "workerPool": string,
  "serviceAccount": string,
  "artifactStorage": string
}
Kolom
workerPool

string

Wajib. Nama resource kumpulan pekerja Cloud Build yang akan digunakan. Formatnya adalah projects/{project}/locations/{location}/workerPools/{pool}.
serviceAccount

string

Opsional. Akun layanan Google yang akan digunakan untuk eksekusi. Jika tidak ditentukan, akun layanan eksekusi project (-compute@developer.gserviceaccount.com) akan digunakan.
artifactStorage

string

Opsional. Lokasi Cloud Storage tempat output eksekusi akan disimpan. ID ini dapat berupa bucket ("gs://my-bucket") atau jalur dalam bucket ("gs://my-bucket/my-dir"). Jika tidak ditentukan, bucket default yang terletak di region yang sama akan digunakan.

Metode

create

 Membuat Target baru di project dan lokasi tertentu.

delete

 Menghapus satu Target.

get

 Mendapatkan detail satu Target.

getIamPolicy

 Mendapatkan kebijakan kontrol akses untuk resource.

list

 Mencantumkan Target di project dan lokasi tertentu.

patch

 Memperbarui parameter satu Target.

setIamPolicy

 Menetapkan kebijakan kontrol akses pada resource yang ditentukan.

testIamPermissions

 Menampilkan izin yang dimiliki pemanggil atas resource yang ditentukan.