Show / Hide Table of Contents

Class Item

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

Inheritance
object
Item
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.CloudSearch.v1.Data
Assembly: Google.Apis.CloudSearch.v1.dll
Syntax
public class Item : IDirectResponseSchema

Properties

Acl

Access control list for this item.

Declaration
[JsonProperty("acl")]
public virtual ItemAcl Acl { get; set; }
Property Value
Type Description
ItemAcl

Content

Item content to be indexed and made text searchable.

Declaration
[JsonProperty("content")]
public virtual ItemContent Content { get; set; }
Property Value
Type Description
ItemContent

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

ItemType

The type for this item.

Declaration
[JsonProperty("itemType")]
public virtual string ItemType { get; set; }
Property Value
Type Description
string

Metadata

The metadata information.

Declaration
[JsonProperty("metadata")]
public virtual ItemMetadata Metadata { get; set; }
Property Value
Type Description
ItemMetadata

Name

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

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

Payload

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

Declaration
[JsonProperty("payload")]
public virtual string Payload { get; set; }
Property Value
Type Description
string

Queue

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

Declaration
[JsonProperty("queue")]
public virtual string Queue { get; set; }
Property Value
Type Description
string

Status

Status of the item. Output only field.

Declaration
[JsonProperty("status")]
public virtual ItemStatus Status { get; set; }
Property Value
Type Description
ItemStatus

StructuredData

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

Declaration
[JsonProperty("structuredData")]
public virtual ItemStructuredData StructuredData { get; set; }
Property Value
Type Description
ItemStructuredData

Version

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.

Declaration
[JsonProperty("version")]
public virtual string Version { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX