• Home
• com.google.apis
• google-api-services-people
• v1-rev20210330-1.31.0
• source code
• PeopleService.ContactGroups.BatchGet.html

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

target.apidocs.com.google.api.services.people.v1.PeopleService.ContactGroups.BatchGet.html Maven / Gradle / Ivy

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.people.v1
Class PeopleService.ContactGroups.BatchGet



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.people.v1.PeopleServiceRequest<BatchGetContactGroupsResponse>


com.google.api.services.people.v1.PeopleService.ContactGroups.BatchGet

















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


Enclosing class:
PeopleService.ContactGroups




public class PeopleService.ContactGroups.BatchGet
extends PeopleServiceRequest<BatchGetContactGroupsResponse>











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 
BatchGet()
Get a list of contact groups owned by the authenticated user by specifying a list of contact
 group resource names.










Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HttpRequest
buildHttpRequestUsingHead() 


HttpResponse
executeUsingHead() 


String
getGroupFields()
Optional.



Integer
getMaxMembers()
Optional.



List<String>
getResourceNames()
Required.



PeopleService.ContactGroups.BatchGet
set(String parameterName,
   Object value) 


PeopleService.ContactGroups.BatchGet
set$Xgafv(String $Xgafv)
V1 error format.



PeopleService.ContactGroups.BatchGet
setAccessToken(String accessToken)
OAuth access token.



PeopleService.ContactGroups.BatchGet
setAlt(String alt)
Data format for response.



PeopleService.ContactGroups.BatchGet
setCallback(String callback)
JSONP



PeopleService.ContactGroups.BatchGet
setFields(String fields)
Selector specifying which fields to include in a partial response.



PeopleService.ContactGroups.BatchGet
setGroupFields(String groupFields)
Optional.



PeopleService.ContactGroups.BatchGet
setKey(String key)
API key.



PeopleService.ContactGroups.BatchGet
setMaxMembers(Integer maxMembers)
Optional.



PeopleService.ContactGroups.BatchGet
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.



PeopleService.ContactGroups.BatchGet
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.



PeopleService.ContactGroups.BatchGet
setQuotaUser(String quotaUser)
Available to use for quota purposes for server-side applications.



PeopleService.ContactGroups.BatchGet
setResourceNames(List<String> resourceNames)
Required.



PeopleService.ContactGroups.BatchGet
setUploadProtocol(String uploadProtocol)
Upload protocol for media (e.g.



PeopleService.ContactGroups.BatchGet
setUploadType(String uploadType)
Legacy upload protocol for media (e.g.







Methods inherited from class com.google.api.services.people.v1.PeopleServiceRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, 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





BatchGet
protected BatchGet()
Get a list of contact groups owned by the authenticated user by specifying a list of contact
 group resource names.

 Create a request for the method "contactGroups.batchGet".

 This request holds the parameters needed by the the people server.  After setting any optional
 parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation. 

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

Since:
1.13










Method Detail





executeUsingHead
public HttpResponse executeUsingHead()
                              throws IOException

Overrides:
executeUsingHead in class AbstractGoogleClientRequest<BatchGetContactGroupsResponse>
Throws:
IOException








buildHttpRequestUsingHead
public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:
buildHttpRequestUsingHead in class AbstractGoogleClientRequest<BatchGetContactGroupsResponse>
Throws:
IOException








set$Xgafv
public PeopleService.ContactGroups.BatchGet set$Xgafv(String $Xgafv)
Description copied from class: PeopleServiceRequest
V1 error format.

Overrides:
set$Xgafv in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setAccessToken
public PeopleService.ContactGroups.BatchGet setAccessToken(String accessToken)
Description copied from class: PeopleServiceRequest
OAuth access token.

Overrides:
setAccessToken in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setAlt
public PeopleService.ContactGroups.BatchGet setAlt(String alt)
Description copied from class: PeopleServiceRequest
Data format for response.

Overrides:
setAlt in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setCallback
public PeopleService.ContactGroups.BatchGet setCallback(String callback)
Description copied from class: PeopleServiceRequest
JSONP

Overrides:
setCallback in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setFields
public PeopleService.ContactGroups.BatchGet setFields(String fields)
Description copied from class: PeopleServiceRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setKey
public PeopleService.ContactGroups.BatchGet setKey(String key)
Description copied from class: PeopleServiceRequest
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 PeopleServiceRequest<BatchGetContactGroupsResponse>








setOauthToken
public PeopleService.ContactGroups.BatchGet setOauthToken(String oauthToken)
Description copied from class: PeopleServiceRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setPrettyPrint
public PeopleService.ContactGroups.BatchGet setPrettyPrint(Boolean prettyPrint)
Description copied from class: PeopleServiceRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setQuotaUser
public PeopleService.ContactGroups.BatchGet setQuotaUser(String quotaUser)
Description copied from class: PeopleServiceRequest
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:
setQuotaUser in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setUploadType
public PeopleService.ContactGroups.BatchGet setUploadType(String uploadType)
Description copied from class: PeopleServiceRequest
Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:
setUploadType in class PeopleServiceRequest<BatchGetContactGroupsResponse>








setUploadProtocol
public PeopleService.ContactGroups.BatchGet setUploadProtocol(String uploadProtocol)
Description copied from class: PeopleServiceRequest
Upload protocol for media (e.g. "raw", "multipart").

Overrides:
setUploadProtocol in class PeopleServiceRequest<BatchGetContactGroupsResponse>








getGroupFields
public String getGroupFields()
Optional. A field mask to restrict which fields on the group are returned. Defaults to `metadata`,
     `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields are: * clientData *
     groupType * memberCount * metadata * name







setGroupFields
public PeopleService.ContactGroups.BatchGet setGroupFields(String groupFields)
Optional. A field mask to restrict which fields on the group are returned. Defaults to
 `metadata`, `groupType`, `memberCount`, and `name` if not set or set to empty. Valid fields
 are: * clientData * groupType * memberCount * metadata * name







getMaxMembers
public Integer getMaxMembers()
Optional. Specifies the maximum number of members to return for each group. Defaults to 0 if not
     set, which will return zero members.







setMaxMembers
public PeopleService.ContactGroups.BatchGet setMaxMembers(Integer maxMembers)
Optional. Specifies the maximum number of members to return for each group. Defaults to 0
 if not set, which will return zero members.







getResourceNames
public List<String> getResourceNames()
Required. The resource names of the contact groups to get.







setResourceNames
public PeopleService.ContactGroups.BatchGet setResourceNames(List<String> resourceNames)
Required. The resource names of the contact groups to get.







set
public PeopleService.ContactGroups.BatchGet set(String parameterName,
                                                Object value)

Overrides:
set in class PeopleServiceRequest<BatchGetContactGroupsResponse>














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–2021 Google. All rights reserved.