Result (Custom Search API v1-rev20240821-2.0.0)

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

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class Result
extends com.google.api.client.json.GenericJson
```
A custom 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 Custom 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
Modifier and Type	Class and Description
`static class`	`Result.Image` Image belonging to a custom search result.
`static class`	`Result.Labels` Refinement label associated with a custom search result.

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
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

Result()

Constructors
Constructor and Description
`Result()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Result`	`clone()`
`String`	`getCacheId()` Indicates the ID of Google's cached version of the search result.
`String`	`getDisplayLink()` An abridged version of this search result’s URL, e.g.
`String`	`getFileFormat()` The file format of the search result.
`String`	`getFormattedUrl()` The URL displayed after the snippet for each search result.
`String`	`getHtmlFormattedUrl()` The HTML-formatted URL displayed after the snippet for each search result.
`String`	`getHtmlSnippet()` The snippet of the search result, in HTML.
`String`	`getHtmlTitle()` The title of the search result, in HTML.
`Result.Image`	`getImage()` Image belonging to a custom search result.
`String`	`getKind()` A unique identifier for the type of current object.
`List<Result.Labels>`	`getLabels()` Encapsulates all information about refinement labels.
`String`	`getLink()` The full URL to which the search result is pointing, e.g.
`String`	`getMime()` The MIME type of the search result.
`Map<String,Object>`	`getPagemap()` Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.
`String`	`getSnippet()` The snippet of the search result, in plain text.
`String`	`getTitle()` The title of the search result, in plain text.
`Result`	`set(String fieldName, Object value)`
`Result`	`setCacheId(String cacheId)` Indicates the ID of Google's cached version of the search result.
`Result`	`setDisplayLink(String displayLink)` An abridged version of this search result’s URL, e.g.
`Result`	`setFileFormat(String fileFormat)` The file format of the search result.
`Result`	`setFormattedUrl(String formattedUrl)` The URL displayed after the snippet for each search result.
`Result`	`setHtmlFormattedUrl(String htmlFormattedUrl)` The HTML-formatted URL displayed after the snippet for each search result.
`Result`	`setHtmlSnippet(String htmlSnippet)` The snippet of the search result, in HTML.
`Result`	`setHtmlTitle(String htmlTitle)` The title of the search result, in HTML.
`Result`	`setImage(Result.Image image)` Image belonging to a custom search result.
`Result`	`setKind(String kind)` A unique identifier for the type of current object.
`Result`	`setLabels(List<Result.Labels> labels)` Encapsulates all information about refinement labels.
`Result`	`setLink(String link)` The full URL to which the search result is pointing, e.g.
`Result`	`setMime(String mime)` The MIME type of the search result.
`Result`	`setPagemap(Map<String,Object> pagemap)` Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.
`Result`	`setSnippet(String snippet)` The snippet of the search result, in plain text.
`Result`	`setTitle(String title)` The title of the search result, in plain text.

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, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, 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
  - Result
```
public Result()
```
- Method Detail
  - getCacheId
```
public String getCacheId()
```
    Indicates the ID of Google's cached version of the search result.
    
    Returns:
    
    value or null for none
  - setCacheId
```
public Result setCacheId(String cacheId)
```
    Indicates the ID of Google's cached version of the search result.
    
    Parameters:
    
    cacheId - cacheId or null for none
  - getDisplayLink
```
public String getDisplayLink()
```
    An abridged version of this search result’s URL, e.g. www.example.com.
    
    Returns:
    
    value or null for none
  - setDisplayLink
```
public Result setDisplayLink(String displayLink)
```
    An abridged version of this search result’s URL, e.g. www.example.com.
    
    Parameters:
    
    displayLink - displayLink or null for none
  - getFileFormat
```
public String getFileFormat()
```
    The file format of the search result.
    
    Returns:
    
    value or null for none
  - setFileFormat
```
public Result setFileFormat(String fileFormat)
```
    The file format of the search result.
    
    Parameters:
    
    fileFormat - fileFormat or null for none
  - getFormattedUrl
```
public String getFormattedUrl()
```
    The URL displayed after the snippet for each search result.
    
    Returns:
    
    value or null for none
  - setFormattedUrl
```
public Result setFormattedUrl(String formattedUrl)
```
    The URL displayed after the snippet for each search result.
    
    Parameters:
    
    formattedUrl - formattedUrl or null for none
  - getHtmlFormattedUrl
```
public String getHtmlFormattedUrl()
```
    The HTML-formatted URL displayed after the snippet for each search result.
    
    Returns:
    
    value or null for none
  - setHtmlFormattedUrl
```
public Result setHtmlFormattedUrl(String htmlFormattedUrl)
```
    The HTML-formatted URL displayed after the snippet for each search result.
    
    Parameters:
    
    htmlFormattedUrl - htmlFormattedUrl or null for none
  - getHtmlSnippet
```
public String getHtmlSnippet()
```
    The snippet of the search result, in HTML.
    
    Returns:
    
    value or null for none
  - setHtmlSnippet
```
public Result setHtmlSnippet(String htmlSnippet)
```
    The snippet of the search result, in HTML.
    
    Parameters:
    
    htmlSnippet - htmlSnippet or null for none
  - getHtmlTitle
```
public String getHtmlTitle()
```
    The title of the search result, in HTML.
    
    Returns:
    
    value or null for none
  - setHtmlTitle
```
public Result setHtmlTitle(String htmlTitle)
```
    The title of the search result, in HTML.
    
    Parameters:
    
    htmlTitle - htmlTitle or null for none
  - getImage
```
public Result.Image getImage()
```
    Image belonging to a custom search result.
    
    Returns:
    
    value or null for none
  - setImage
```
public Result setImage(Result.Image image)
```
    Image belonging to a custom search result.
    
    Parameters:
    
    image - image or null for none
  - getKind
```
public String getKind()
```
    A unique identifier for the type of current object. For this API, it is `customsearch#result.`
    
    Returns:
    
    value or null for none
  - setKind
```
public Result setKind(String kind)
```
    A unique identifier for the type of current object. For this API, it is `customsearch#result.`
    
    Parameters:
    
    kind - kind or null for none
  - getLabels
```
public List<Result.Labels> getLabels()
```
    Encapsulates all information about refinement labels.
    
    Returns:
    
    value or null for none
  - setLabels
```
public Result setLabels(List<Result.Labels> labels)
```
    Encapsulates all information about refinement labels.
    
    Parameters:
    
    labels - labels or null for none
  - getLink
```
public String getLink()
```
    The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.
    
    Returns:
    
    value or null for none
  - setLink
```
public Result setLink(String link)
```
    The full URL to which the search result is pointing, e.g. http://www.example.com/foo/bar.
    
    Parameters:
    
    link - link or null for none
  - getMime
```
public String getMime()
```
    The MIME type of the search result.
    
    Returns:
    
    value or null for none
  - setMime
```
public Result setMime(String mime)
```
    The MIME type of the search result.
    
    Parameters:
    
    mime - mime or null for none
  - getPagemap
```
public Map<String,Object> getPagemap()
```
    Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.
    
    Returns:
    
    value or null for none
  - setPagemap
```
public Result setPagemap(Map<String,Object> pagemap)
```
    Contains [PageMap](https://developers.google.com/custom-search/docs/structured_data#pagemaps) information for this search result.
    
    Parameters:
    
    pagemap - pagemap or null for none
  - getSnippet
```
public String getSnippet()
```
    The snippet of the search result, in plain text.
    
    Returns:
    
    value or null for none
  - setSnippet
```
public Result setSnippet(String snippet)
```
    The snippet of the search result, in plain text.
    
    Parameters:
    
    snippet - snippet or null for none
  - getTitle
```
public String getTitle()
```
    The title of the search result, in plain text.
    
    Returns:
    
    value or null for none
  - setTitle
```
public Result setTitle(String title)
```
    The title of the search result, in plain text.
    
    Parameters:
    
    title - title or null for none
  - set
```
public Result set(String fieldName,
                  Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public Result clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class Result

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

Result

Method Detail

getCacheId

setCacheId

getDisplayLink

setDisplayLink

getFileFormat

setFileFormat

getFormattedUrl

setFormattedUrl

getHtmlFormattedUrl

setHtmlFormattedUrl

getHtmlSnippet

setHtmlSnippet

getHtmlTitle

setHtmlTitle

getImage

setImage

getKind

setKind

getLabels

setLabels

getLink

setLink

getMime

setMime

getPagemap

setPagemap

getSnippet

setSnippet

getTitle

setTitle

set

clone