Method: projects.locations.identityMappingStores.purgeIdentityMappings

ID 매핑 스토어에서 지정된 또는 모든 ID 매핑 항목을 영구 삭제합니다.

HTTP 요청


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

URL은 gRPC 트랜스코딩 구문을 사용합니다.

경로 매개변수

매개변수
identityMappingStore

string

필수 항목. ID 매핑 항목을 영구 삭제할 ID 매핑 스토어의 이름입니다. 형식: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

요청 본문

요청 본문에는 다음과 같은 구조의 데이터가 포함됩니다.

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
}
필드
filter

string

영구 삭제할 일치하는 ID 매핑을 필터링합니다. 필터링할 수 있는 필드는 다음과 같습니다.

  • updateTime: ISO 8601 'zulu' 형식입니다.
  • externalId

예:

  • 특정 기간에 업데이트된 모든 ID 매핑 삭제: updateTime > "2012-04-23T18:25:43.511Z" AND updateTime < "2012-04-23T18:30:43.511Z"
  • 지정된 externalId의 모든 ID 매핑 삭제: externalId = "id1"
  • ID 매핑 스토어 내 모든 ID 매핑 삭제: *

필터링 필드에는 암시적 AND가 있다고 가정됩니다. 소스와 함께 사용해서는 안 됩니다. 두 파라미터가 모두 제공되면 오류가 발생합니다.

입력 소스입니다. 다음은 상호 배타적인 필드의 목록입니다. 응답에는 다음 필드 중 최대 하나가 설정됩니다.
inlineSource

object (InlineSource)

ID 매핑 항목을 영구 삭제할 인라인 소스입니다.

상호 배타적 필드의 끝입니다.
force

boolean

실제로 영구 삭제를 수행합니다. force가 false로 설정되면 ID 매핑을 삭제하지 않고 예상되는 영구 삭제 횟수를 반환합니다. 이 필드는 필터로 영구 삭제하는 경우에만 지원됩니다. 입력 소스의 경우 이 필드는 무시되며 이 필드 값과 관계없이 데이터가 영구 삭제됩니다.

응답 본문

성공한 경우 응답 본문에 Operation의 인스턴스가 포함됩니다.

승인 범위

다음 OAuth 범위 중 하나가 필요합니다.

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

자세한 내용은 Authentication Overview에서 확인하세요.

IAM 권한

identityMappingStore 리소스에 대해서는 다음 IAM 권한이 필요합니다.

  • discoveryengine.identityMappingStores.purgeIdentityMappings

자세한 내용은 IAM 문서를 참고하세요.

InlineSource

ID 매핑 항목을 영구 삭제할 인라인 소스입니다.

JSON 표현
{
  "identityMappingEntries": [
    {
      object (IdentityMappingEntry)
    }
  ]
}
필드
identityMappingEntries[]

object (IdentityMappingEntry)

한 번에 항목 최대 10,000개까지 영구 삭제할 수 있습니다.