Method: projects.locations.identityMappingStores.purgeIdentityMappings

Menghapus semua atau Entri Pemetaan Identitas tertentu dari Penyimpanan Pemetaan Identitas.

Permintaan HTTP


POST https://discoveryengine.googleapis.com/v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:purgeIdentityMappings

URL ini menggunakan sintaksis gRPC Transcoding.

Parameter jalur

Parameter
identityMappingStore

string

Wajib. Nama Identity Mapping Store untuk menghapus Entri Pemetaan Identitas. Format: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

Isi permintaan

Isi permintaan memuat data dengan struktur berikut:

Representasi JSON 
{
  "filter": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "inlineSource": {
    object (InlineSource)
  }
  // End of mutually exclusive fields.
  "force": boolean
}
Kolom
filter

string

Memfilter pemetaan identitas yang cocok untuk dihapus. Kolom yang memenuhi syarat untuk pemfilteran adalah:

  • updateTime: dalam format "zulu" ISO 8601.
  • externalId

Contoh:

  • Menghapus semua pemetaan identitas yang diperbarui dalam rentang waktu: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • Menghapus semua pemetaan identitas untuk externalId tertentu: externalId = "id1"
  • Menghapus semua pemetaan identitas di dalam penyimpanan pemetaan identitas: *

Kolom pemfilteran diasumsikan memiliki AND implisit. Tidak boleh digunakan dengan sumber. Error akan ditampilkan jika keduanya diberikan.
Sumber input. Berikut adalah daftar kolom yang bersifat eksklusif satu sama lain. Maksimal satu kolom akan ditetapkan dalam respons:
inlineSource

object (InlineSource)

Sumber inline untuk menghapus entri pemetaan identitas.
Akhir kolom yang saling eksklusif.
force

boolean

Benar-benar melakukan penghapusan permanen. Jika force disetel ke false, fungsi ini akan menampilkan perkiraan jumlah penghapusan tanpa menghapus pemetaan identitas apa pun. Kolom ini hanya didukung untuk penghapusan dengan filter. Untuk sumber input, kolom ini diabaikan dan data akan dihapus terlepas dari nilai kolom ini.

Isi respons

Jika berhasil, isi respons akan memuat instance Operation.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite
  • https://www.googleapis.com/auth/discoveryengine.serving.readwrite

Untuk mengetahui informasi selengkapnya, lihat Authentication Overview.

Izin IAM

Memerlukan izin IAM berikut pada resource identityMappingStore:

  • discoveryengine.identityMappingStores.purgeIdentityMappings

Untuk mengetahui informasi selengkapnya, lihat dokumentasi IAM.

InlineSource

Sumber inline untuk menghapus entri pemetaan identitas.

Representasi JSON 
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
Kolom
identityMappingEntries[]

object (IdentityMappingEntry)

Maksimum 10.000 entri dapat dihapus sekaligus