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

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
```
public final class Metadata
extends com.google.api.client.json.GenericJson
```
Metadata of a matched search result.
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

Metadata()

Constructors
Constructor and Description
`Metadata()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Metadata`	`clone()`
`java.lang.String`	`getCreateTime()` The creation time for this document or object in the search result.
`ResultDisplayMetadata`	`getDisplayOptions()` Options that specify how to display a structured data search result.
`java.util.List<NamedProperty>`	`getFields()` Indexed fields in structured data, returned as a generic named property.
`java.lang.String`	`getMimeType()` Mime type of the search result.
`java.lang.String`	`getObjectType()` Object type of the search result.
`Person`	`getOwner()` Owner (usually creator) of the document or object of the search result.
`Source`	`getSource()` The named source for the result, such as Gmail.
`java.lang.String`	`getUpdateTime()` The last modified date for the object in the search result.
`Metadata`	`set(java.lang.String fieldName, java.lang.Object value)`
`Metadata`	`setCreateTime(java.lang.String createTime)` The creation time for this document or object in the search result.
`Metadata`	`setDisplayOptions(ResultDisplayMetadata displayOptions)` Options that specify how to display a structured data search result.
`Metadata`	`setFields(java.util.List<NamedProperty> fields)` Indexed fields in structured data, returned as a generic named property.
`Metadata`	`setMimeType(java.lang.String mimeType)` Mime type of the search result.
`Metadata`	`setObjectType(java.lang.String objectType)` Object type of the search result.
`Metadata`	`setOwner(Person owner)` Owner (usually creator) of the document or object of the search result.
`Metadata`	`setSource(Source source)` The named source for the result, such as Gmail.
`Metadata`	`setUpdateTime(java.lang.String updateTime)` The last modified date for the object in the search result.

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
  - Metadata
```
public Metadata()
```
- Method Detail
  - getCreateTime
```
public java.lang.String getCreateTime()
```
    The creation time for this document or object in the search result.
    
    Returns:
    
    value or null for none
  - setCreateTime
```
public Metadata setCreateTime(java.lang.String createTime)
```
    The creation time for this document or object in the search result.
    
    Parameters:
    
    createTime - createTime or null for none
  - getDisplayOptions
```
public ResultDisplayMetadata getDisplayOptions()
```
    Options that specify how to display a structured data search result.
    
    Returns:
    
    value or null for none
  - setDisplayOptions
```
public Metadata setDisplayOptions(ResultDisplayMetadata displayOptions)
```
    Options that specify how to display a structured data search result.
    
    Parameters:
    
    displayOptions - displayOptions or null for none
  - getFields
```
public java.util.List<NamedProperty> getFields()
```
    Indexed fields in structured data, returned as a generic named property.
    
    Returns:
    
    value or null for none
  - setFields
```
public Metadata setFields(java.util.List<NamedProperty> fields)
```
    Indexed fields in structured data, returned as a generic named property.
    
    Parameters:
    
    fields - fields or null for none
  - getMimeType
```
public java.lang.String getMimeType()
```
    Mime type of the search result.
    
    Returns:
    
    value or null for none
  - setMimeType
```
public Metadata setMimeType(java.lang.String mimeType)
```
    Mime type of the search result.
    
    Parameters:
    
    mimeType - mimeType or null for none
  - getObjectType
```
public java.lang.String getObjectType()
```
    Object type of the search result.
    
    Returns:
    
    value or null for none
  - setObjectType
```
public Metadata setObjectType(java.lang.String objectType)
```
    Object type of the search result.
    
    Parameters:
    
    objectType - objectType or null for none
  - getOwner
```
public Person getOwner()
```
    Owner (usually creator) of the document or object of the search result.
    
    Returns:
    
    value or null for none
  - setOwner
```
public Metadata setOwner(Person owner)
```
    Owner (usually creator) of the document or object of the search result.
    
    Parameters:
    
    owner - owner or null for none
  - getSource
```
public Source getSource()
```
    The named source for the result, such as Gmail.
    
    Returns:
    
    value or null for none
  - setSource
```
public Metadata setSource(Source source)
```
    The named source for the result, such as Gmail.
    
    Parameters:
    
    source - source or null for none
  - getUpdateTime
```
public java.lang.String getUpdateTime()
```
    The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.
    
    Returns:
    
    value or null for none
  - setUpdateTime
```
public Metadata setUpdateTime(java.lang.String updateTime)
```
    The last modified date for the object in the search result. If not set in the item, the value returned here is empty. When `updateTime` is used for calculating freshness and is not set, this value defaults to 2 years from the current time.
    
    Parameters:
    
    updateTime - updateTime or null for none
  - set
```
public Metadata set(java.lang.String fieldName,
                    java.lang.Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Metadata clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Cloud Search API v1 (revision 47)

Class Metadata

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

Metadata

Method Detail

getCreateTime

setCreateTime

getDisplayOptions

setDisplayOptions

getFields

setFields

getMimeType

setMimeType

getObjectType

setObjectType

getOwner

setOwner

getSource

setSource

getUpdateTime

setUpdateTime

set

clone