Plus.People.List (Google+ API v1 (Rev. 590) 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.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.List

All Implemented Interfaces:

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

Enclosing class:

Plus.People
```
public class Plus.People.List
extends PlusRequest<PeopleFeed>
```

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>

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

Constructor Summary

Constructors
Modifier Constructor and Description

protected List(java.lang.String userId, java.lang.String collection)
List all of the people in the specified collection.

Constructors
Modifier	Constructor and Description
`protected`	`List(java.lang.String userId, java.lang.String collection)` List all of the people in the specified collection.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`java.lang.String`	`getCollection()` The collection of people to list.
`java.lang.Long`	`getMaxResults()` The maximum number of people to include in the response, which is used for paging.
`java.lang.String`	`getOrderBy()` The order to return people in.
`java.lang.String`	`getPageToken()` The continuation token, which is used to page through large result sets.
`java.lang.String`	`getUserId()` Get the collection of people for the person identified.
`Plus.People.List`	`set(java.lang.String parameterName, java.lang.Object value)`
`Plus.People.List`	`setAlt(java.lang.String alt)` Data format for the response.
`Plus.People.List`	`setCollection(java.lang.String collection)` The collection of people to list.
`Plus.People.List`	`setFields(java.lang.String fields)` Selector specifying which fields to include in a partial response.
`Plus.People.List`	`setKey(java.lang.String key)` API key.
`Plus.People.List`	`setMaxResults(java.lang.Long maxResults)` The maximum number of people to include in the response, which is used for paging.
`Plus.People.List`	`setOauthToken(java.lang.String oauthToken)` OAuth 2.0 token for the current user.
`Plus.People.List`	`setOrderBy(java.lang.String orderBy)` The order to return people in.
`Plus.People.List`	`setPageToken(java.lang.String pageToken)` The continuation token, which is used to page through large result sets.
`Plus.People.List`	`setPrettyPrint(java.lang.Boolean prettyPrint)` Returns response with indentations and line breaks.
`Plus.People.List`	`setQuotaUser(java.lang.String quotaUser)` An opaque string that represents a user for quota purposes.
`Plus.People.List`	`setUserId(java.lang.String userId)` Get the collection of people for the person identified.
`Plus.People.List`	`setUserIp(java.lang.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, 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

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - List
```
protected List(java.lang.String userId,
               java.lang.String collection)
```
    List all of the people in the specified collection. Create a request for the method "people.list". 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:
    
    userId - Get the collection of people for the person identified. Use "me" to indicate the authenticated user.
    
    collection - The collection of people to list.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws java.io.IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PeopleFeed>
    
    Throws:
    
    java.io.IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws java.io.IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<PeopleFeed>
    
    Throws:
    
    java.io.IOException
  - setAlt
```
public Plus.People.List setAlt(java.lang.String alt)
```
    Description copied from class: PlusRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class PlusRequest<PeopleFeed>
  - setFields
```
public Plus.People.List setFields(java.lang.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.List setKey(java.lang.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.List setOauthToken(java.lang.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.List setPrettyPrint(java.lang.Boolean prettyPrint)
```
    Description copied from class: PlusRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class PlusRequest<PeopleFeed>
  - setQuotaUser
```
public Plus.People.List setQuotaUser(java.lang.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.List setUserIp(java.lang.String userIp)
```
    Description copied from class: PlusRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class PlusRequest<PeopleFeed>
  - getUserId
```
public java.lang.String getUserId()
```
    Get the collection of people for the person identified. Use "me" to indicate the authenticated user.
  - setUserId
```
public Plus.People.List setUserId(java.lang.String userId)
```
    Get the collection of people for the person identified. Use "me" to indicate the authenticated user.
  - getCollection
```
public java.lang.String getCollection()
```
    The collection of people to list.
  - setCollection
```
public Plus.People.List setCollection(java.lang.String collection)
```
    The collection of people to list.
  - getMaxResults
```
public java.lang.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: 100] [minimum: 1] [maximum: 100]
  - setMaxResults
```
public Plus.People.List setMaxResults(java.lang.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.
  - getOrderBy
```
public java.lang.String getOrderBy()
```
    The order to return people in.
  - setOrderBy
```
public Plus.People.List setOrderBy(java.lang.String orderBy)
```
    The order to return people in.
  - getPageToken
```
public java.lang.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.
  - setPageToken
```
public Plus.People.List setPageToken(java.lang.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.
  - set
```
public Plus.People.List set(java.lang.String parameterName,
                            java.lang.Object value)
```
    Overrides:
    
    set in class PlusRequest<PeopleFeed>

Google+ API v1 (revision 590)

Class Plus.People.List

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

Field Summary

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

Constructor Summary

Method Summary

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

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

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

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

List

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getUserId

setUserId

getCollection

setCollection

getMaxResults

setMaxResults

getOrderBy

setOrderBy

getPageToken

setPageToken

set