TypeProviders

Untuk mengetahui daftar metode untuk resource ini, lihat bagian akhir halaman ini.

Representasi resource

Penyedia jenis yang mendeskripsikan Jenis yang didukung layanan.

{
  "name": string,
  "id": unsigned long,
  "insertTime": string,
  "description": string,
  "selfLink": string,
  "operation": operations Resource,
  "labels": [
    {
      "key": string,
      "value": string
    }
  ],
  "descriptorUrl": string,
  "credential": {
    "basicAuth": {
      "user": string,
      "password": string
    },
    "serviceAccount": {
      "email": string
    },
    "useProjectDefault": boolean
  },
  "options": {
    "inputMappings": [
      {
        "fieldName": string,
        "methodMatch": string,
        "value": string,
        "location": string
      }
    ],
    "validationOptions": {
      "undeclaredProperties": string,
      "schemaValidation": string
    },
    "virtualProperties": string,
    "asyncOptions": [
      {
        "methodMatch": string,
        "pollingOptions": {
          "finishCondition": string,
          "failCondition": string,
          "targetLink": string,
          "pollingLink": string,
          "diagnostics": [
            {
              "field": string,
              "level": string
            }
          ]
        }
      }
    ]
  },
  "collectionOverrides": [
    {
      "collection": string,
      "options": {
        "inputMappings": [
          {
            "fieldName": string,
            "methodMatch": string,
            "value": string,
            "location": string
          }
        ],
        "validationOptions": {
          "undeclaredProperties": string,
          "schemaValidation": string
        },
        "virtualProperties": string,
        "asyncOptions": [
          {
            "methodMatch": string,
            "pollingOptions": {
              "finishCondition": string,
              "failCondition": string,
              "targetLink": string,
              "pollingLink": string,
              "diagnostics": [
                {
                  "field": string,
                  "level": string
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "customCertificateAuthorityRoots": [
    string
  ]
}
Nama properti Nilai Deskripsi Catatan
collectionOverrides[] list Mengizinkan penggantian penanganan resource untuk koleksi tertentu
collectionOverrides[].collection string Koleksi yang mengidentifikasi resource ini dalam layanannya.
collectionOverrides[].options nested object Opsi yang akan diterapkan ke penggantian tingkat resource ini
collectionOverrides[].options.asyncOptions[] list Opsi terkait cara membuat thread permintaan asinkron.
collectionOverrides[].options.asyncOptions[].methodMatch string Regex metode tempat kebijakan ini akan berlaku.
collectionOverrides[].options.asyncOptions[].pollingOptions nested object Pengelola deployment akan melakukan polling instance untuk resource API ini yang menetapkan status RUNNING, dan memblokir hingga kondisi polling memberi tahu apakah resource selesai atau gagal.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[] list Array diagnostik yang akan dikumpulkan oleh Deployment Manager, diagnostik ini akan ditampilkan kepada pengguna.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].field string Ekspresi JsonPath pada resource yang jika tidak kosong, menunjukkan bahwa kolom ini perlu diekstrak sebagai diagnostik.
collectionOverrides[].options.asyncOptions[].pollingOptions.diagnostics[].level string Level untuk merekam diagnostik ini.
collectionOverrides[].options.asyncOptions[].pollingOptions.failCondition string Ekspresi JsonPath yang menentukan apakah permintaan gagal.
collectionOverrides[].options.asyncOptions[].pollingOptions.finishCondition string Ekspresi JsonPath yang menentukan apakah permintaan selesai.
collectionOverrides[].options.inputMappings[] list Pemetaan yang berlaku untuk permintaan.
collectionOverrides[].options.inputMappings[].fieldName string Nama kolom yang akan dimasukkan.
collectionOverrides[].options.inputMappings[].location string Lokasi tempat pemetaan ini berlaku.
collectionOverrides[].options.inputMappings[].methodMatch string Regex untuk dievaluasi pada metode guna memutuskan apakah input berlaku.
collectionOverrides[].options.inputMappings[].value string Ekspresi jsonPath untuk memilih elemen.
collectionOverrides[].options.validationOptions nested object Opsi untuk cara memvalidasi dan memproses properti di resource.
collectionOverrides[].options.validationOptions.schemaValidation string Menyesuaikan cara deployment manager memvalidasi resource terhadap error skema.
collectionOverrides[].options.validationOptions.undeclaredProperties string Tentukan tindakan yang akan dilakukan dengan properti tambahan saat menjalankan permintaan.
collectionOverrides[].options.virtualProperties string Blok properti tambahan yang dijelaskan sebagai jsonSchema, properti ini tidak akan pernah menjadi bagian dari payload json, tetapi dapat digunakan oleh InputMappings, ini harus berupa draf-04 skema json yang valid. Properti yang ditentukan di sini akan dipisahkan di bagian yang berbeda. Skema ini akan digabungkan ke validasi skema, dan properti di sini akan diekstrak dari payload dan digunakan secara eksplisit oleh InputMappings. contoh: field1: type: string field2: type: number
credential nested object Kredensial yang digunakan saat berinteraksi dengan jenis ini.
credential.basicAuth nested object Kredensial Autentikasi Dasar, hanya digunakan oleh TypeProvider.
credential.basicAuth.password string
credential.basicAuth.user string
credential.serviceAccount nested object Kredensial Akun Layanan, hanya digunakan oleh Deployment.
credential.serviceAccount.email string Alamat email akun layanan IAM seperti test@myproject.iam.gserviceaccount.com
credential.useProjectDefault boolean Tentukan untuk menggunakan kredensial default project, yang hanya didukung oleh Deployment.
customCertificateAuthorityRoots[] list Daftar hingga 2 root certificate authority kustom yang akan digunakan untuk autentikasi TLS saat melakukan panggilan atas nama penyedia jenis ini. Jika ditetapkan, autentikasi TLS akan secara eksklusif menggunakan root ini, bukan mengandalkan otoritas sertifikasi tepercaya secara publik saat memvalidasi keaslian sertifikat TLS. Sertifikat harus dalam format PEM yang dienkode dengan base64. Ukuran maksimum setiap sertifikat tidak boleh melebihi 10 KB.
description string Deskripsi tekstual opsional tentang resource; disediakan oleh klien saat resource dibuat.
descriptorUrl string URL Deskripsi untuk penyedia jenis ini.
id unsigned long Hanya output. ID unik untuk resource yang ditentukan oleh server.
insertTime string Hanya output. Stempel waktu pembuatan dalam format teks RFC3339.
labels[] list Peta label; disediakan oleh klien saat resource dibuat atau diperbarui. Secara khusus: Kunci label harus memiliki panjang antara 1 dan 63 karakter dan harus sesuai dengan ekspresi reguler berikut: `[a-z]([-a-z0-9]*[a-z0-9])?` Nilai label harus memiliki panjang antara 0 dan 63 karakter dan harus sesuai dengan ekspresi reguler `([a-z]([-a-z0-9]*[a-z0-9])?)?`.

labels[].key string
labels[].value string
name string Nama resource; diberikan oleh klien saat resource dibuat. Nama harus terdiri dari 1-63 karakter, dan mematuhi RFC1035. Secara khusus, nama harus memiliki panjang 1-63 karakter dan cocok dengan ekspresi reguler `[a-z]([-a-z0-9]*[a-z0-9])?` yang berarti karakter pertama harus berupa huruf kecil, dan semua karakter berikutnya harus berupa tanda hubung, huruf kecil, atau angka, kecuali karakter terakhir, yang tidak boleh berupa tanda hubung.
operation nested object Hanya output. Operasi yang terakhir dijalankan, atau saat ini sedang berjalan, di penyedia jenis ini.
options nested object Opsi yang akan diterapkan saat menangani resource apa pun di layanan ini.
options.asyncOptions[] list Opsi terkait cara membuat thread permintaan asinkron.
options.asyncOptions[].methodMatch string Regex metode tempat kebijakan ini akan berlaku.
options.asyncOptions[].pollingOptions nested object Pengelola deployment akan melakukan polling instance untuk resource API ini yang menetapkan status RUNNING, dan memblokir hingga kondisi polling memberi tahu apakah resource selesai atau gagal.
options.asyncOptions[].pollingOptions.diagnostics[] list Array diagnostik yang akan dikumpulkan oleh Deployment Manager, diagnostik ini akan ditampilkan kepada pengguna.
options.asyncOptions[].pollingOptions.diagnostics[].field string Ekspresi JsonPath pada resource yang jika tidak kosong, menunjukkan bahwa kolom ini perlu diekstrak sebagai diagnostik.
options.asyncOptions[].pollingOptions.diagnostics[].level string Level untuk merekam diagnostik ini.
options.asyncOptions[].pollingOptions.failCondition string Ekspresi JsonPath yang menentukan apakah permintaan gagal.
options.asyncOptions[].pollingOptions.finishCondition string Ekspresi JsonPath yang menentukan apakah permintaan selesai.
options.inputMappings[] list Pemetaan yang berlaku untuk permintaan.
options.inputMappings[].fieldName string Nama kolom yang akan dimasukkan.
options.inputMappings[].location string Lokasi tempat pemetaan ini berlaku.
options.inputMappings[].methodMatch string Regex untuk dievaluasi pada metode guna memutuskan apakah input berlaku.
options.inputMappings[].value string Ekspresi jsonPath untuk memilih elemen.
options.validationOptions nested object Opsi untuk cara memvalidasi dan memproses properti di resource.
options.validationOptions.schemaValidation string Menyesuaikan cara deployment manager memvalidasi resource terhadap error skema.
options.validationOptions.undeclaredProperties string Tentukan tindakan yang akan dilakukan dengan properti tambahan saat menjalankan permintaan.
options.virtualProperties string Blok properti tambahan yang dijelaskan sebagai jsonSchema, properti ini tidak akan pernah menjadi bagian dari payload json, tetapi dapat digunakan oleh InputMappings, ini harus berupa draf-04 skema json yang valid. Properti yang ditentukan di sini akan dipisahkan di bagian yang berbeda. Skema ini akan digabungkan ke validasi skema, dan properti di sini akan diekstrak dari payload dan digunakan secara eksplisit oleh InputMappings. contoh: field1: type: string field2: type: number

Metode

hapus
Menghapus penyedia jenis.
get
Mendapatkan informasi tentang penyedia jenis tertentu.
getType
Mendapatkan info jenis untuk jenis yang disediakan oleh TypeProvider.
insert
Membuat penyedia jenis.
list
Mencantumkan semua penyedia jenis resource untuk Deployment Manager.
listTypes
Mencantumkan semua info jenis untuk TypeProvider.
patch
Menerapkan patch pada penyedia jenis.
update
Memperbarui penyedia jenis.