com.google.api.services.customsearch.v1.model

Class Promotion

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.customsearch.v1.model.Promotion

All Implemented Interfaces:

java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>

public final class Promotion
extends com.google.api.client.json.GenericJson

Promotion 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	Promotion.BodyLines Block object belonging to a promotion.
static class	Promotion.Image Image belonging to a promotion.

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
Promotion()

Method Summary

Modifier and Type	Method and Description
Promotion	clone()
java.util.List<Promotion.BodyLines>	getBodyLines() An array of block objects for this promotion.
java.lang.String	getDisplayLink() An abridged version of this search's result URL, e.g.
java.lang.String	getHtmlTitle() The title of the promotion, in HTML.
Promotion.Image	getImage() Image belonging to a promotion.
java.lang.String	getLink() The URL of the promotion.
java.lang.String	getTitle() The title of the promotion.
Promotion	set(java.lang.String fieldName, java.lang.Object value)
Promotion	setBodyLines(java.util.List<Promotion.BodyLines> bodyLines) An array of block objects for this promotion.
Promotion	setDisplayLink(java.lang.String displayLink) An abridged version of this search's result URL, e.g.
Promotion	setHtmlTitle(java.lang.String htmlTitle) The title of the promotion, in HTML.
Promotion	setImage(Promotion.Image image) Image belonging to a promotion.
Promotion	setLink(java.lang.String link) The URL of the promotion.
Promotion	setTitle(java.lang.String title) The title of the promotion.

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

Promotion

public Promotion()

Method Detail

getBodyLines

public java.util.List<Promotion.BodyLines> getBodyLines()

An array of block objects for this promotion. See [Google WebSearch Protocol reference](https://developers.google.com/custom-search/docs/xml_results) for more information.

Returns:

value or null for none

setBodyLines

public Promotion setBodyLines(java.util.List<Promotion.BodyLines> bodyLines)

An array of block objects for this promotion. See [Google WebSearch Protocol reference](https://developers.google.com/custom-search/docs/xml_results) for more information.

Parameters:

bodyLines - bodyLines or null for none

getDisplayLink

public java.lang.String getDisplayLink()

An abridged version of this search's result URL, e.g. www.example.com.

Returns:

value or null for none

setDisplayLink

public Promotion setDisplayLink(java.lang.String displayLink)

An abridged version of this search's result URL, e.g. www.example.com.

Parameters:

displayLink - displayLink or null for none

getHtmlTitle

public java.lang.String getHtmlTitle()

The title of the promotion, in HTML.

Returns:

value or null for none

setHtmlTitle

public Promotion setHtmlTitle(java.lang.String htmlTitle)

The title of the promotion, in HTML.

Parameters:

htmlTitle - htmlTitle or null for none

getImage

public Promotion.Image getImage()

Image belonging to a promotion.

Returns:

value or null for none

setImage

public Promotion setImage(Promotion.Image image)

Image belonging to a promotion.

Parameters:

image - image or null for none

getLink

public java.lang.String getLink()

The URL of the promotion.

Returns:

value or null for none

setLink

public Promotion setLink(java.lang.String link)

The URL of the promotion.

Parameters:

link - link or null for none

getTitle

public java.lang.String getTitle()

The title of the promotion.

Returns:

value or null for none

setTitle

public Promotion setTitle(java.lang.String title)

The title of the promotion.

Parameters:

title - title or null for none

set

public Promotion set(java.lang.String fieldName,
                     java.lang.Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Promotion clone()

Overrides:

clone in class com.google.api.client.json.GenericJson