Method: indexing.datasources.items.push

항목을 나중에 폴링 및 업데이트할 수 있도록 대기열로 푸시합니다.

이 API를 실행하려면 관리자 또는 서비스 계정이 필요합니다. 사용된 서비스 계정이 해당 데이터 소스에서 허용된 계정입니다.

HTTP 요청

POST https://cloudsearch.googleapis.com/v1/indexing/{item.name=datasources/*/items/*}:push

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

경로 매개변수

매개변수
item.name

string

색인 생성 큐로 푸시할 item의 이름입니다.

형식: datasources/{sourceId}/items/{ID}

필수 입력란입니다. 최대 길이는 1,536자(영문 기준)입니다.

요청 본문

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

JSON 표현 
{
  "item": {
    "name": string,
    "type": enum (PushItem.Type),
    "metadataHash": string,
    "structuredDataHash": string,
    "contentHash": string,
    "payload": string,
    "queue": string,
    "repositoryError": {
      "type": enum (RepositoryError.Type),
      "httpStatusCode": integer,
      "errorMessage": string
    }
  },
  "connectorName": string,
  "debugOptions": {
    object (DebugOptions)
  }
}
필드
item.type

enum (PushItem.Type)

푸시 동작을 정의하는 푸시 작업의 유형입니다.
item.metadataHash

string

저장소에 따른 항목의 메타데이터 해시입니다. 지정된 경우 이 항목의 상태를 수정하는 방법을 결정하는 데 사용됩니다. 이 필드와 type 필드를 설정하면 인수 오류가 발생합니다. 최대 길이는 2,048자(영문 기준)입니다.
item.structuredDataHash

string

저장소에 따른 항목의 구조화된 데이터 해시입니다. 지정된 경우 이 항목의 상태를 수정하는 방법을 결정하는 데 사용됩니다. 이 필드와 type 필드를 설정하면 인수 오류가 발생합니다. 최대 길이는 2,048자(영문 기준)입니다.
item.contentHash

string

저장소에 따른 항목의 콘텐츠 해시입니다. 지정된 경우 이 항목의 상태를 수정하는 방법을 결정하는 데 사용됩니다. 이 필드와 type 필드를 설정하면 인수 오류가 발생합니다. 최대 길이는 2,048자(영문 기준)입니다.
item.payload

string (bytes format)

대체 저장소 ID 및 기타 메타데이터와 같은 커넥터에 대한 추가 문서 상태 정보를 제공합니다. 최대 길이는 8,192바이트입니다.

base64 인코딩 문자열입니다.
item.queue

string

이 항목이 속한 대기열입니다. 이 필드가 지정되지 않으면 default 큐가 선택됩니다. 최대 길이는 512자(영문 기준)입니다.
item.repositoryError

object (RepositoryError)

커넥터 또는 저장소 오류 세부정보를 저장하려면 이 필드를 입력하세요. 이 정보는 관리 콘솔에 표시됩니다. 이 필드는 type가 REPOSITORY_ERROR인 경우에만 채워질 수 있습니다.
connectorName

string

이 호출을 수행하는 커넥터의 이름입니다.

형식: datasources/{sourceId}/connectors/{ID}
debugOptions

object (DebugOptions)

일반적인 디버그 옵션입니다.

응답 본문

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

승인 범위

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

  • https://www.googleapis.com/auth/cloud_search.indexing
  • https://www.googleapis.com/auth/cloud_search

자세한 내용은 승인 가이드를 참조하세요.

PushItem

색인 생성 큐로 푸시할 항목을 나타냅니다.

JSON 표현 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
필드
name

string

색인 생성 큐로 푸시할 item의 이름입니다.

형식: datasources/{sourceId}/items/{ID}

필수 입력란입니다. 최대 길이는 1,536자(영문 기준)입니다.
type

enum (PushItem.Type)

푸시 동작을 정의하는 푸시 작업의 유형입니다.
metadataHash

string

저장소에 따른 항목의 메타데이터 해시입니다. 지정된 경우 이 항목의 상태를 수정하는 방법을 결정하는 데 사용됩니다. 이 필드와 type 필드를 설정하면 인수 오류가 발생합니다. 최대 길이는 2,048자(영문 기준)입니다.
structuredDataHash

string

저장소에 따른 항목의 구조화된 데이터 해시입니다. 지정된 경우 이 항목의 상태를 수정하는 방법을 결정하는 데 사용됩니다. 이 필드와 type 필드를 설정하면 인수 오류가 발생합니다. 최대 길이는 2,048자(영문 기준)입니다.
contentHash

string

저장소에 따른 항목의 콘텐츠 해시입니다. 지정된 경우 이 항목의 상태를 수정하는 방법을 결정하는 데 사용됩니다. 이 필드와 type 필드를 설정하면 인수 오류가 발생합니다. 최대 길이는 2,048자(영문 기준)입니다.
payload

string (bytes format)

대체 저장소 ID 및 기타 메타데이터와 같은 커넥터에 대한 추가 문서 상태 정보를 제공합니다. 최대 길이는 8,192바이트입니다.

base64 인코딩 문자열입니다.
queue

string

이 항목이 속한 대기열입니다. 이 필드가 지정되지 않으면 default 큐가 선택됩니다. 최대 길이는 512자(영문 기준)입니다.
repositoryError

object (RepositoryError)

커넥터 또는 저장소 오류 세부정보를 저장하려면 이 필드를 입력하세요. 이 정보는 관리 콘솔에 표시됩니다. 이 필드는 type가 REPOSITORY_ERROR인 경우에만 채워질 수 있습니다.

PushItem.Type

푸시 동작을 정의하는 푸시 작업의 유형입니다.

열거형
UNSPECIFIED 기본값은 UNSPECIFIED입니다. 푸시 작업이 ItemStatus를 수정하지 않도록 지정합니다.
MODIFIED 이전 update 호출 이후 저장소 문서가 수정되었거나 업데이트되었음을 나타냅니다. 이렇게 하면 기존 항목의 상태가 MODIFIED로 변경됩니다. 존재하지 않는 항목에서 이 메서드를 호출하면 상태가 NEW_ITEM로 변경됩니다.
NOT_MODIFIED 마지막 업데이트 호출 이후 저장소의 항목이 수정되지 않았습니다. 이 푸시 작업은 상태를 ACCEPTED 상태로 설정합니다.
REPOSITORY_ERROR 커넥터에 이 항목과 관련된 저장소 오류가 발생했습니다. 상태를 REPOSITORY_ERROR 상태로 변경합니다. 항목이 예약되지 않고 지수 백오프에 의해 결정된 미래 시간에 다시 예약됩니다.
REQUEUE 예약된 항목에 대해서만 REQUEUE로 푸시를 호출합니다. 이 작업을 수행하면 항목의 예약이 취소되고 사용 가능한 시간이 벽시계 시간으로 재설정됩니다.