com.google.api.services.plus

Class Plus.Activities.Search

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>

com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>

com.google.api.services.plus.PlusRequest<ActivityFeed>

com.google.api.services.plus.Plus.Activities.Search

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Plus.Activities

public class Plus.Activities.Search
extends PlusRequest<ActivityFeed>

Nested Class Summary

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

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

Modifier	Constructor and Description
protected	Plus.Activities.Search(String query) Search public activities.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getLanguage() Specify the preferred language to search with.
Long	getMaxResults() The maximum number of activities to include in the response, which is used for paging.
String	getOrderBy() Specifies how to order search results.
String	getPageToken() The continuation token, which is used to page through large result sets.
String	getQuery() Full-text search query string.
Plus.Activities.Search	set(String parameterName, Object value)
Plus.Activities.Search	setAlt(String alt) Data format for the response.
Plus.Activities.Search	setFields(String fields) Selector specifying which fields to include in a partial response.
Plus.Activities.Search	setKey(String key) API key.
Plus.Activities.Search	setLanguage(String language) Specify the preferred language to search with.
Plus.Activities.Search	setMaxResults(Long maxResults) The maximum number of activities to include in the response, which is used for paging.
Plus.Activities.Search	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Plus.Activities.Search	setOrderBy(String orderBy) Specifies how to order search results.
Plus.Activities.Search	setPageToken(String pageToken) The continuation token, which is used to page through large result sets.
Plus.Activities.Search	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Plus.Activities.Search	setQuery(String query) Full-text search query string.
Plus.Activities.Search	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Plus.Activities.Search	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.plus.PlusRequest

getAbstractGoogleClient, getAlt, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUserIp, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

buildHttpRequest, buildHttpRequestUrl, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

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

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Plus.Activities.Search

protected Plus.Activities.Search(String query)

Search public activities. Create a request for the method "activities.search". This request holds the parameters needed by the the plus server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Plus.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.

Parameters:

query - Full-text search query string.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<ActivityFeed>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ActivityFeed>

Throws:

IOException

setAlt

public Plus.Activities.Search setAlt(String alt)

Description copied from class: PlusRequest

Data format for the response.

Overrides:

setAlt in class PlusRequest<ActivityFeed>

setFields

public Plus.Activities.Search setFields(String fields)

Description copied from class: PlusRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PlusRequest<ActivityFeed>

setKey

public Plus.Activities.Search setKey(String key)

Description copied from class: PlusRequest

API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.

Overrides:

setKey in class PlusRequest<ActivityFeed>

setOauthToken

public Plus.Activities.Search setOauthToken(String oauthToken)

Description copied from class: PlusRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PlusRequest<ActivityFeed>

setPrettyPrint

public Plus.Activities.Search setPrettyPrint(Boolean prettyPrint)

Description copied from class: PlusRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PlusRequest<ActivityFeed>

setQuotaUser

public Plus.Activities.Search setQuotaUser(String quotaUser)

Description copied from class: PlusRequest

Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters. Overrides userIp if both are provided.

Overrides:

setQuotaUser in class PlusRequest<ActivityFeed>

setUserIp

public Plus.Activities.Search setUserIp(String userIp)

Description copied from class: PlusRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class PlusRequest<ActivityFeed>

getQuery

public String getQuery()

Full-text search query string.

setQuery

public Plus.Activities.Search setQuery(String query)

Full-text search query string.

getOrderBy

public String getOrderBy()

Specifies how to order search results. [default: recent]

setOrderBy

public Plus.Activities.Search setOrderBy(String orderBy)

Specifies how to order search results.

getPageToken

public String getPageToken()

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.

setPageToken

public Plus.Activities.Search setPageToken(String pageToken)

The continuation token, which is used to page through large result sets. To get the next page of results, set this parameter to the value of "nextPageToken" from the previous response. This token can be of any length.

getMaxResults

public Long getMaxResults()

The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults. [default: 10] [minimum: 1] [maximum: 20]

setMaxResults

public Plus.Activities.Search setMaxResults(Long maxResults)

The maximum number of activities to include in the response, which is used for paging. For any response, the actual number returned might be less than the specified maxResults.

getLanguage

public String getLanguage()

Specify the preferred language to search with. See search language codes for available values. [default: en-US]

setLanguage

public Plus.Activities.Search setLanguage(String language)

Specify the preferred language to search with. See search language codes for available values.

set

public Plus.Activities.Search set(String parameterName,
                         Object value)

Overrides:

set in class PlusRequest<ActivityFeed>