Item

import type { Item } from "https://googleapis.deno.dev/v1/cloudsearch:v1.ts";

Represents a single object that is an item in the search index, such as a file, folder, or a database record.

interface Item {

acl?: ItemAcl;

content?: ItemContent;

itemType?:

| "UNSPECIFIED"

| "CONTENT_ITEM"

| "CONTAINER_ITEM"

| "VIRTUAL_CONTAINER_ITEM";

metadata?: ItemMetadata;

name?: string;

payload?: Uint8Array;

queue?: string;

status?: ItemStatus;

structuredData?: ItemStructuredData;

version?: Uint8Array;

}

§Properties

acl?: ItemAcl

[src]

Access control list for this item.

content?: ItemContent

[src]

Item content to be indexed and made text searchable.

itemType?: "UNSPECIFIED" | "CONTENT_ITEM" | "CONTAINER_ITEM" | "VIRTUAL_CONTAINER_ITEM"

[src]

The type for this item.

metadata?: ItemMetadata

[src]

The metadata information.

name?: string

[src]

The name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.

payload?: Uint8Array

[src]

Additional state connector can store for this item. The maximum length is 10000 bytes.

queue?: string

[src]

Queue this item belongs to. The maximum length is 100 characters.

status?: ItemStatus

[src]

Status of the item. Output only field.

structuredData?: ItemStructuredData

[src]

The structured data for the item that should conform to a registered object definition in the schema for the data source.

version?: Uint8Array

[src]

Required. The indexing system stores the version from the datasource as a byte string and compares the Item version in the index to the version of the queued Item using lexical ordering. Cloud Search Indexing won't index or delete any queued item with a version value that is less than or equal to the version of the currently indexed item. The maximum length for this field is 1024 bytes. For information on how item version affects the deletion process, refer to Handle revisions after manual deletes.