target.apidocs.com.google.api.services.plus.Plus.People.Search.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-plus Show documentation

The newest version!







Plus.People.Search (Google+ API v1-rev20190328-1.30.10)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.plus
Class Plus.People.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<PeopleFeed>


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

















All Implemented Interfaces:
Cloneable, Map<String,Object>


Enclosing class:
Plus.People




public class Plus.People.Search
extends PlusRequest<PeopleFeed>











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>








Field Summary




Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
USER_AGENT_SUFFIX








Constructor Summary

Constructors 

Modifier
Constructor and Description


protected 
Search(String query)
Shut down.










Method Summary

All Methods Instance Methods Concrete 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 people to include in the response, which is used for paging.



String
getPageToken()
The continuation token, which is used to page through large result sets.



String
getQuery()
Specify a query string for full text search of public text in all profiles.



Plus.People.Search
set(String parameterName,
   Object value) 


Plus.People.Search
setAlt(String alt)
Data format for the response.



Plus.People.Search
setFields(String fields)
Selector specifying which fields to include in a partial response.



Plus.People.Search
setKey(String key)
API key.



Plus.People.Search
setLanguage(String language)
Specify the preferred language to search with.



Plus.People.Search
setMaxResults(Long maxResults)
The maximum number of people to include in the response, which is used for paging.



Plus.People.Search
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



Plus.People.Search
setPageToken(String pageToken)
The continuation token, which is used to page through large result sets.



Plus.People.Search
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



Plus.People.Search
setQuery(String query)
Specify a query string for full text search of public text in all profiles.



Plus.People.Search
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.



Plus.People.Search
setUserIp(String userIp)
Deprecated.







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, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream





Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString





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





Search
protected Search(String query)
Shut down. See https://developers.google.com/+/api-shutdown for more details.

 Create a request for the method "people.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 - Specify a query string for full text search of public text in all profiles.
Since:
1.13










Method Detail





executeUsingHead
public HttpResponse executeUsingHead()
                              throws IOException

Overrides:
executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PeopleFeed>
Throws:
IOException








buildHttpRequestUsingHead
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:
buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PeopleFeed>
Throws:
IOException








setAlt
public Plus.People.Search setAlt(String alt)
Description copied from class: PlusRequest
Data format for the response.

Overrides:
setAlt in class PlusRequest<PeopleFeed>








setFields
public Plus.People.Search setFields(String fields)
Description copied from class: PlusRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class PlusRequest<PeopleFeed>








setKey
public Plus.People.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<PeopleFeed>








setOauthToken
public Plus.People.Search setOauthToken(String oauthToken)
Description copied from class: PlusRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class PlusRequest<PeopleFeed>








setPrettyPrint
public Plus.People.Search setPrettyPrint(Boolean prettyPrint)
Description copied from class: PlusRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class PlusRequest<PeopleFeed>








setQuotaUser
public Plus.People.Search setQuotaUser(String quotaUser)
Description copied from class: PlusRequest
An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:
setQuotaUser in class PlusRequest<PeopleFeed>








setUserIp
public Plus.People.Search setUserIp(String userIp)
Description copied from class: PlusRequest
Deprecated. Please use quotaUser instead.

Overrides:
setUserIp in class PlusRequest<PeopleFeed>








getQuery
public String getQuery()
Specify a query string for full text search of public text in all profiles.







setQuery
public Plus.People.Search setQuery(String query)
Specify a query string for full text search of public text in all profiles.







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







setLanguage
public Plus.People.Search setLanguage(String language)
Specify the preferred language to search with. See search language codes for available
 values.







getMaxResults
public Long getMaxResults()
The maximum number of people 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: 25]
     [minimum: 1] [maximum: 50]







setMaxResults
public Plus.People.Search setMaxResults(Long maxResults)
The maximum number of people to include in the response, which is used for paging. For any
 response, the actual number returned might be less than the specified maxResults.







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.People.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.







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

Overrides:
set in class PlusRequest<PeopleFeed>














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2020 Google. All rights reserved.

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 people to include in the response, which is used for paging.
`String`	`getPageToken()` The continuation token, which is used to page through large result sets.
`String`	`getQuery()` Specify a query string for full text search of public text in all profiles.
`Plus.People.Search`	`set(String parameterName, Object value)`
`Plus.People.Search`	`setAlt(String alt)` Data format for the response.
`Plus.People.Search`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Plus.People.Search`	`setKey(String key)` API key.
`Plus.People.Search`	`setLanguage(String language)` Specify the preferred language to search with.
`Plus.People.Search`	`setMaxResults(Long maxResults)` The maximum number of people to include in the response, which is used for paging.
`Plus.People.Search`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Plus.People.Search`	`setPageToken(String pageToken)` The continuation token, which is used to page through large result sets.
`Plus.People.Search`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Plus.People.Search`	`setQuery(String query)` Specify a query string for full text search of public text in all profiles.
`Plus.People.Search`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Plus.People.Search`	`setUserIp(String userIp)` Deprecated.