Item (Cloud Search API v1 (Rev. 47) 1.25.0)

java.lang.Object
- java.util.AbstractMap<java.lang.String,java.lang.Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.cloudsearch.v1.model.Item

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Item
extends com.google.api.client.json.GenericJson
```
Represents a single object that is an item in the search index, such as a file, folder, or a database record.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Search API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  java.util.Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Item()

Constructors
Constructor and Description
`Item()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Item`	`clone()`
`byte[]`	`decodePayload()` Additional state connector can store for this item.
`byte[]`	`decodeVersion()` Required.
`Item`	`encodePayload(byte[] payload)` Additional state connector can store for this item.
`Item`	`encodeVersion(byte[] version)` Required.
`ItemAcl`	`getAcl()` Access control list for this item.
`ItemContent`	`getContent()` Item content to be indexed and made text searchable.
`java.lang.String`	`getItemType()` Type for this item.
`ItemMetadata`	`getMetadata()` Metadata information.
`java.lang.String`	`getName()` Name of the Item.
`java.lang.String`	`getPayload()` Additional state connector can store for this item.
`java.lang.String`	`getQueue()` Queue this item belongs to.
`ItemStatus`	`getStatus()` Status of the item.
`ItemStructuredData`	`getStructuredData()` The structured data for the item that should conform to a registered object definition in the schema for the data source.
`java.lang.String`	`getVersion()` Required.
`Item`	`set(java.lang.String fieldName, java.lang.Object value)`
`Item`	`setAcl(ItemAcl acl)` Access control list for this item.
`Item`	`setContent(ItemContent content)` Item content to be indexed and made text searchable.
`Item`	`setItemType(java.lang.String itemType)` Type for this item.
`Item`	`setMetadata(ItemMetadata metadata)` Metadata information.
`Item`	`setName(java.lang.String name)` Name of the Item.
`Item`	`setPayload(java.lang.String payload)` Additional state connector can store for this item.
`Item`	`setQueue(java.lang.String queue)` Queue this item belongs to.
`Item`	`setStatus(ItemStatus status)` Status of the item.
`Item`	`setStructuredData(ItemStructuredData structuredData)` The structured data for the item that should conform to a registered object definition in the schema for the data source.
`Item`	`setVersion(java.lang.String version)` Required.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - Item
```
public Item()
```
- Method Detail
  - getAcl
```
public ItemAcl getAcl()
```
    Access control list for this item.
    
    Returns:
    
    value or null for none
  - setAcl
```
public Item setAcl(ItemAcl acl)
```
    Access control list for this item.
    
    Parameters:
    
    acl - acl or null for none
  - getContent
```
public ItemContent getContent()
```
    Item content to be indexed and made text searchable.
    
    Returns:
    
    value or null for none
  - setContent
```
public Item setContent(ItemContent content)
```
    Item content to be indexed and made text searchable.
    
    Parameters:
    
    content - content or null for none
  - getItemType
```
public java.lang.String getItemType()
```
    Type for this item.
    
    Returns:
    
    value or null for none
  - setItemType
```
public Item setItemType(java.lang.String itemType)
```
    Type for this item.
    
    Parameters:
    
    itemType - itemType or null for none
  - getMetadata
```
public ItemMetadata getMetadata()
```
    Metadata information.
    
    Returns:
    
    value or null for none
  - setMetadata
```
public Item setMetadata(ItemMetadata metadata)
```
    Metadata information.
    
    Parameters:
    
    metadata - metadata or null for none
  - getName
```
public java.lang.String getName()
```
    Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
    
    Returns:
    
    value or null for none
  - setName
```
public Item setName(java.lang.String name)
```
    Name of the Item. Format: datasources/{source_id}/items/{item_id} This is a required field. The maximum length is 1536 characters.
    
    Parameters:
    
    name - name or null for none
  - getPayload
```
public java.lang.String getPayload()
```
    Additional state connector can store for this item. The maximum length is 10000 bytes.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodePayload()
  - decodePayload
```
public byte[] decodePayload()
```
    Additional state connector can store for this item. The maximum length is 10000 bytes.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getPayload()
  - setPayload
```
public Item setPayload(java.lang.String payload)
```
    Additional state connector can store for this item. The maximum length is 10000 bytes.
    
    Parameters:
    
    payload - payload or null for none
    
    See Also:
    
    #encodePayload()
  - encodePayload
```
public Item encodePayload(byte[] payload)
```
    Additional state connector can store for this item. The maximum length is 10000 bytes.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - getQueue
```
public java.lang.String getQueue()
```
    Queue this item belongs to. The maximum length is 100 characters.
    
    Returns:
    
    value or null for none
  - setQueue
```
public Item setQueue(java.lang.String queue)
```
    Queue this item belongs to. The maximum length is 100 characters.
    
    Parameters:
    
    queue - queue or null for none
  - getStatus
```
public ItemStatus getStatus()
```
    Status of the item. Output only field.
    
    Returns:
    
    value or null for none
  - setStatus
```
public Item setStatus(ItemStatus status)
```
    Status of the item. Output only field.
    
    Parameters:
    
    status - status or null for none
  - getStructuredData
```
public ItemStructuredData getStructuredData()
```
    The structured data for the item that should conform to a registered object definition in the schema for the data source.
    
    Returns:
    
    value or null for none
  - setStructuredData
```
public Item setStructuredData(ItemStructuredData structuredData)
```
    The structured data for the item that should conform to a registered object definition in the schema for the data source.
    
    Parameters:
    
    structuredData - structuredData or null for none
  - getVersion
```
public java.lang.String getVersion()
```
    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.
    
    Returns:
    
    value or null for none
    
    See Also:
    
    decodeVersion()
  - decodeVersion
```
public byte[] decodeVersion()
```
    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.
    
    Returns:
    
    Base64 decoded value or null for none
    
    Since:
    
    1.14
    
    See Also:
    
    getVersion()
  - setVersion
```
public Item setVersion(java.lang.String 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.
    
    Parameters:
    
    version - version or null for none
    
    See Also:
    
    #encodeVersion()
  - encodeVersion
```
public Item encodeVersion(byte[] 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.
    
    Since:
    
    1.14
    
    See Also:
    
    The value is encoded Base64 or {@code null} for none.
  - set
```
public Item set(java.lang.String fieldName,
                java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Item clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Search API v1 (revision 47)

Class Item

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Item

Method Detail

getAcl

setAcl

getContent

setContent

getItemType

setItemType

getMetadata

setMetadata

getName

setName

getPayload

decodePayload

setPayload

encodePayload

getQueue

setQueue

getStatus

setStatus

getStructuredData

setStructuredData

getVersion

decodeVersion

setVersion

encodeVersion

set

clone