ItemMetadata (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.ItemMetadata

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class ItemMetadata
extends com.google.api.client.json.GenericJson
```
Available metadata fields for the item.
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

ItemMetadata()

Constructors
Constructor and Description
`ItemMetadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ItemMetadata`	`clone()`
`java.lang.String`	`getContainerName()` The name of the container for this item.
`java.lang.String`	`getContentLanguage()` The BCP-47 language code for the item, such as "en-US" or "sr-Latn".
`java.lang.String`	`getCreateTime()` The time when the item was created in the source repository.
`java.lang.String`	`getHash()` Hashing value provided by the API caller.
`java.util.List<Interaction>`	`getInteractions()` A list of interactions for the item.
`java.util.List<java.lang.String>`	`getKeywords()` Additional keywords or phrases that should match the item.
`java.lang.String`	`getMimeType()` The original mime-type of ItemContent.content in the source repository.
`java.lang.String`	`getObjectType()` The type of the item.
`SearchQualityMetadata`	`getSearchQualityMetadata()` Additional search quality metadata of the item
`java.lang.String`	`getSourceRepositoryUrl()` Link to the source repository serving the data.
`java.lang.String`	`getTitle()` The title of the item.
`java.lang.String`	`getUpdateTime()` The time when the item was last modified in the source repository.
`ItemMetadata`	`set(java.lang.String fieldName, java.lang.Object value)`
`ItemMetadata`	`setContainerName(java.lang.String containerName)` The name of the container for this item.
`ItemMetadata`	`setContentLanguage(java.lang.String contentLanguage)` The BCP-47 language code for the item, such as "en-US" or "sr-Latn".
`ItemMetadata`	`setCreateTime(java.lang.String createTime)` The time when the item was created in the source repository.
`ItemMetadata`	`setHash(java.lang.String hash)` Hashing value provided by the API caller.
`ItemMetadata`	`setInteractions(java.util.List<Interaction> interactions)` A list of interactions for the item.
`ItemMetadata`	`setKeywords(java.util.List<java.lang.String> keywords)` Additional keywords or phrases that should match the item.
`ItemMetadata`	`setMimeType(java.lang.String mimeType)` The original mime-type of ItemContent.content in the source repository.
`ItemMetadata`	`setObjectType(java.lang.String objectType)` The type of the item.
`ItemMetadata`	`setSearchQualityMetadata(SearchQualityMetadata searchQualityMetadata)` Additional search quality metadata of the item
`ItemMetadata`	`setSourceRepositoryUrl(java.lang.String sourceRepositoryUrl)` Link to the source repository serving the data.
`ItemMetadata`	`setTitle(java.lang.String title)` The title of the item.
`ItemMetadata`	`setUpdateTime(java.lang.String updateTime)` The time when the item was last modified in the source repository.

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
  - ItemMetadata
```
public ItemMetadata()
```
- Method Detail
  - getContainerName
```
public java.lang.String getContainerName()
```
    The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
    
    Returns:
    
    value or null for none
  - setContainerName
```
public ItemMetadata setContainerName(java.lang.String containerName)
```
    The name of the container for this item. Deletion of the container item leads to automatic deletion of this item. Note: ACLs are not inherited from a container item. To provide ACL inheritance for an item, use the inheritAclFrom field. The maximum length is 1536 characters.
    
    Parameters:
    
    containerName - containerName or null for none
  - getContentLanguage
```
public java.lang.String getContentLanguage()
```
    The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
    
    Returns:
    
    value or null for none
  - setContentLanguage
```
public ItemMetadata setContentLanguage(java.lang.String contentLanguage)
```
    The BCP-47 language code for the item, such as "en-US" or "sr-Latn". For more information, see http://www.unicode.org/reports/tr35/#Unicode_locale_identifier. The maximum length is 32 characters.
    
    Parameters:
    
    contentLanguage - contentLanguage or null for none
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    The time when the item was created in the source repository.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public ItemMetadata setCreateTime(java.lang.String createTime)
```
    The time when the item was created in the source repository.
    
    Parameters:
    
    createTime - createTime or null for none
  - getHash
```
public java.lang.String getHash()
```
    Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
    
    Returns:
    
    value or null for none
  - setHash
```
public ItemMetadata setHash(java.lang.String hash)
```
    Hashing value provided by the API caller. This can be used with the items.push method to calculate modified state. The maximum length is 2048 characters.
    
    Parameters:
    
    hash - hash or null for none
  - getInteractions
```
public java.util.List<Interaction> getInteractions()
```
    A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
    
    Returns:
    
    value or null for none
  - setInteractions
```
public ItemMetadata setInteractions(java.util.List<Interaction> interactions)
```
    A list of interactions for the item. Interactions are used to improve Search quality, but are not exposed to end users. The maximum number of elements is 1000.
    
    Parameters:
    
    interactions - interactions or null for none
  - getKeywords
```
public java.util.List<java.lang.String> getKeywords()
```
    Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
    
    Returns:
    
    value or null for none
  - setKeywords
```
public ItemMetadata setKeywords(java.util.List<java.lang.String> keywords)
```
    Additional keywords or phrases that should match the item. Used internally for user generated content. The maximum number of elements is 100. The maximum length is 8192 characters.
    
    Parameters:
    
    keywords - keywords or null for none
  - getMimeType
```
public java.lang.String getMimeType()
```
    The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
    
    Returns:
    
    value or null for none
  - setMimeType
```
public ItemMetadata setMimeType(java.lang.String mimeType)
```
    The original mime-type of ItemContent.content in the source repository. The maximum length is 256 characters.
    
    Parameters:
    
    mimeType - mimeType or null for none
  - getObjectType
```
public java.lang.String getObjectType()
```
    The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
    
    Returns:
    
    value or null for none
  - setObjectType
```
public ItemMetadata setObjectType(java.lang.String objectType)
```
    The type of the item. This should correspond to the name of an object definition in the schema registered for the data source. For example, if the schema for the data source contains an object definition with name 'document', then item indexing requests for objects of that type should set objectType to 'document'. The maximum length is 256 characters.
    
    Parameters:
    
    objectType - objectType or null for none
  - getSearchQualityMetadata
```
public SearchQualityMetadata getSearchQualityMetadata()
```
    Additional search quality metadata of the item
    
    Returns:
    
    value or null for none
  - setSearchQualityMetadata
```
public ItemMetadata setSearchQualityMetadata(SearchQualityMetadata searchQualityMetadata)
```
    Additional search quality metadata of the item
    
    Parameters:
    
    searchQualityMetadata - searchQualityMetadata or null for none
  - getSourceRepositoryUrl
```
public java.lang.String getSourceRepositoryUrl()
```
    Link to the source repository serving the data. earch results apply this link to the title. The maximum length is 2048 characters.
    
    Returns:
    
    value or null for none
  - setSourceRepositoryUrl
```
public ItemMetadata setSourceRepositoryUrl(java.lang.String sourceRepositoryUrl)
```
    Link to the source repository serving the data. earch results apply this link to the title. The maximum length is 2048 characters.
    
    Parameters:
    
    sourceRepositoryUrl - sourceRepositoryUrl or null for none
  - getTitle
```
public java.lang.String getTitle()
```
    The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
    
    Returns:
    
    value or null for none
  - setTitle
```
public ItemMetadata setTitle(java.lang.String title)
```
    The title of the item. If given, this will be the displayed title of the Search result. The maximum length is 2048 characters.
    
    Parameters:
    
    title - title or null for none
  - getUpdateTime
```
public java.lang.String getUpdateTime()
```
    The time when the item was last modified in the source repository.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public ItemMetadata setUpdateTime(java.lang.String updateTime)
```
    The time when the item was last modified in the source repository.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public ItemMetadata set(java.lang.String fieldName,
                        java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public ItemMetadata clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Search API v1 (revision 47)

Class ItemMetadata

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

ItemMetadata

Method Detail

getContainerName

setContainerName

getContentLanguage

setContentLanguage

getCreateTime

setCreateTime

getHash

setHash

getInteractions

setInteractions

getKeywords

setKeywords

getMimeType

setMimeType

getObjectType

setObjectType

getSearchQualityMetadata

setSearchQualityMetadata

getSourceRepositoryUrl

setSourceRepositoryUrl

getTitle

setTitle

getUpdateTime

setUpdateTime

set

clone