Method: indexing.datasources.items.push

Đẩy một mục vào hàng đợi để thăm dò và cập nhật sau.

API này yêu cầu quản trị viên hoặc tài khoản dịch vụ để thực thi. Tài khoản dịch vụ được sử dụng là tài khoản có trong danh sách cho phép trong nguồn dữ liệu tương ứng.

Yêu cầu HTTP

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

URL sử dụng cú pháp Chuyển mã gRPC.

Tham số đường dẫn

Các tham số
item.name

string

Tên của item để đẩy vào hàng đợi lập chỉ mục.

Định dạng: datasources/{sourceId}/items/{ID}

Đây là trường bắt buộc. Độ dài tối đa là 1536 ký tự.

Nội dung yêu cầu

Nội dung yêu cầu chứa dữ liệu có cấu trúc sau:

Biểu diễn dưới dạng 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)
  }
}
Các trường
item.type

enum (PushItem.Type)

Loại thao tác đẩy xác định hành vi đẩy.
item.metadataHash

string

Hàm băm siêu dữ liệu của mục theo kho lưu trữ. Nếu được chỉ định, thuộc tính này dùng để xác định cách sửa đổi trạng thái của mục này. Việc đặt trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
item.structuredDataHash

string

Hàm băm dữ liệu có cấu trúc của mục theo kho lưu trữ. Nếu được chỉ định, thuộc tính này dùng để xác định cách sửa đổi trạng thái của mục này. Việc đặt trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
item.contentHash

string

Hàm băm nội dung của mục theo kho lưu trữ. Nếu được chỉ định, thuộc tính này dùng để xác định cách sửa đổi trạng thái của mục này. Việc đặt trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
item.payload

string (bytes format)

Cung cấp thông tin bổ sung về trạng thái tài liệu cho trình kết nối, chẳng hạn như mã kho lưu trữ thay thế và siêu dữ liệu khác. Độ dài tối đa là 8192 byte.

Chuỗi được mã hoá base64.
item.queue

string

Hàng đợi chứa mục này. Hàng đợi default được chọn nếu bạn không chỉ định trường này. Độ dài tối đa là 512 ký tự.
item.repositoryError

object (RepositoryError)

Điền sẵn trường này để lưu trữ thông tin chi tiết về Trình kết nối hoặc lỗi kho lưu trữ. Thông tin này xuất hiện trong Bảng điều khiển dành cho quản trị viên. Bạn chỉ có thể điền trường này khi type có giá trị là REPOSITORY_ERROR.
connectorName

string

Tên của trình kết nối thực hiện cuộc gọi này.

Định dạng: datasources/{sourceId}/Connectors/{ID}
debugOptions

object (DebugOptions)

Các tuỳ chọn gỡ lỗi phổ biến.

Nội dung phản hồi

Nếu thành công, nội dung phản hồi sẽ chứa một phiên bản của Item.

Phạm vi uỷ quyền

Yêu cầu một trong các phạm vi OAuth sau:

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

Để biết thêm thông tin, hãy xem Hướng dẫn uỷ quyền.

PushItem

Đại diện cho một mục sẽ được đẩy vào hàng đợi lập chỉ mục.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "type": enum (PushItem.Type),
  "metadataHash": string,
  "structuredDataHash": string,
  "contentHash": string,
  "payload": string,
  "queue": string,
  "repositoryError": {
    object (RepositoryError)
  }
}
Các trường
name

string

Tên của item để đẩy vào hàng đợi lập chỉ mục.

Định dạng: datasources/{sourceId}/items/{ID}

Đây là trường bắt buộc. Độ dài tối đa là 1536 ký tự.
type

enum (PushItem.Type)

Loại thao tác đẩy xác định hành vi đẩy.
metadataHash

string

Hàm băm siêu dữ liệu của mục theo kho lưu trữ. Nếu được chỉ định, thuộc tính này dùng để xác định cách sửa đổi trạng thái của mục này. Việc đặt trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
structuredDataHash

string

Hàm băm dữ liệu có cấu trúc của mục theo kho lưu trữ. Nếu được chỉ định, thuộc tính này dùng để xác định cách sửa đổi trạng thái của mục này. Việc đặt trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
contentHash

string

Hàm băm nội dung của mục theo kho lưu trữ. Nếu được chỉ định, thuộc tính này dùng để xác định cách sửa đổi trạng thái của mục này. Việc đặt trường này và trường type sẽ dẫn đến lỗi đối số. Độ dài tối đa là 2048 ký tự.
payload

string (bytes format)

Cung cấp thông tin bổ sung về trạng thái tài liệu cho trình kết nối, chẳng hạn như mã kho lưu trữ thay thế và siêu dữ liệu khác. Độ dài tối đa là 8192 byte.

Chuỗi được mã hoá base64.
queue

string

Hàng đợi chứa mục này. Hàng đợi default được chọn nếu bạn không chỉ định trường này. Độ dài tối đa là 512 ký tự.
repositoryError

object (RepositoryError)

Điền sẵn trường này để lưu trữ thông tin chi tiết về Trình kết nối hoặc lỗi kho lưu trữ. Thông tin này xuất hiện trong Bảng điều khiển dành cho quản trị viên. Bạn chỉ có thể điền trường này khi type có giá trị là REPOSITORY_ERROR.

PushItem.Type

Loại thao tác đẩy xác định hành vi đẩy.

Enum
UNSPECIFIED Mặc định là KHÔNG XÁC ĐỊNH. Chỉ định rằng thao tác đẩy không được sửa đổi ItemStatus
MODIFIED Cho biết tài liệu về kho lưu trữ đã được sửa đổi hoặc cập nhật kể từ lệnh gọi update trước đó. Thao tác này sẽ thay đổi trạng thái thành trạng thái MODIFIED cho một mục hiện có. Nếu phương thức này được gọi trên một mục không tồn tại, trạng thái sẽ thay đổi thành NEW_ITEM.
NOT_MODIFIED Mục trong kho lưu trữ chưa được sửa đổi kể từ lệnh gọi cập nhật gần đây nhất. Thao tác đẩy này sẽ đặt trạng thái thành ACCEPTED.
REPOSITORY_ERROR Trình kết nối đang gặp lỗi kho lưu trữ liên quan đến mục này. Thay đổi trạng thái sang trạng thái REPOSITORY_ERROR. Mục không được đặt trước và được lên lịch lại vào một thời điểm trong tương lai được xác định bằng thời gian đợi luỹ thừa.
REQUEUE Chỉ gửi thông báo phản hồi cuộc gọi có REđối với các mục đã được đặt trước. Thao tác này sẽ huỷ duy trì mục và đặt lại thời gian hiện có của mục thành thời gian theo đồng hồ treo tường.