com.google.api.services.mybusinessaccountmanagement.v1

Class MyBusinessAccountManagement.Accounts.List

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.mybusinessaccountmanagement.v1.MyBusinessAccountManagementRequest<ListAccountsResponse>

com.google.api.services.mybusinessaccountmanagement.v1.MyBusinessAccountManagement.Accounts.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

MyBusinessAccountManagement.Accounts

public class MyBusinessAccountManagement.Accounts.List
extends MyBusinessAccountManagementRequest<ListAccountsResponse>

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

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

API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List() Lists all of the accounts for the authenticated user.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getFilter() Optional.
Integer	getPageSize() Optional.
String	getPageToken() Optional.
String	getParentAccount() Optional.
MyBusinessAccountManagement.Accounts.List	set(String parameterName, Object value)
MyBusinessAccountManagement.Accounts.List	set$Xgafv(String $Xgafv) V1 error format.
MyBusinessAccountManagement.Accounts.List	setAccessToken(String accessToken) OAuth access token.
MyBusinessAccountManagement.Accounts.List	setAlt(String alt) Data format for response.
MyBusinessAccountManagement.Accounts.List	setCallback(String callback) JSONP
MyBusinessAccountManagement.Accounts.List	setFields(String fields) Selector specifying which fields to include in a partial response.
MyBusinessAccountManagement.Accounts.List	setFilter(String filter) Optional.
MyBusinessAccountManagement.Accounts.List	setKey(String key) API key.
MyBusinessAccountManagement.Accounts.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
MyBusinessAccountManagement.Accounts.List	setPageSize(Integer pageSize) Optional.
MyBusinessAccountManagement.Accounts.List	setPageToken(String pageToken) Optional.
MyBusinessAccountManagement.Accounts.List	setParentAccount(String parentAccount) Optional.
MyBusinessAccountManagement.Accounts.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
MyBusinessAccountManagement.Accounts.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
MyBusinessAccountManagement.Accounts.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
MyBusinessAccountManagement.Accounts.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.mybusinessaccountmanagement.v1.MyBusinessAccountManagementRequest

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

List

protected List()

Lists all of the accounts for the authenticated user. This includes all accounts that the user owns, as well as any accounts for which the user has management rights. Create a request for the method "accounts.list". This request holds the parameters needed by the the mybusinessaccountmanagement server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

MyBusinessAccountManagement.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 com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException

Overrides:

executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListAccountsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException

Overrides:

buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<ListAccountsResponse>

Throws:

IOException

set$Xgafv

public MyBusinessAccountManagement.Accounts.List set$Xgafv(String $Xgafv)

Description copied from class: MyBusinessAccountManagementRequest

V1 error format.

Overrides:

set$Xgafv in class MyBusinessAccountManagementRequest<ListAccountsResponse>

setAccessToken

public MyBusinessAccountManagement.Accounts.List setAccessToken(String accessToken)

Description copied from class: MyBusinessAccountManagementRequest

OAuth access token.

Overrides:

setAccessToken in class MyBusinessAccountManagementRequest<ListAccountsResponse>

setAlt

public MyBusinessAccountManagement.Accounts.List setAlt(String alt)

Description copied from class: MyBusinessAccountManagementRequest

Data format for response.

Overrides:

setAlt in class MyBusinessAccountManagementRequest<ListAccountsResponse>

setCallback

public MyBusinessAccountManagement.Accounts.List setCallback(String callback)

Description copied from class: MyBusinessAccountManagementRequest

JSONP

Overrides:

setCallback in class MyBusinessAccountManagementRequest<ListAccountsResponse>

setFields

public MyBusinessAccountManagement.Accounts.List setFields(String fields)

Description copied from class: MyBusinessAccountManagementRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class MyBusinessAccountManagementRequest<ListAccountsResponse>

setKey

public MyBusinessAccountManagement.Accounts.List setKey(String key)

Description copied from class: MyBusinessAccountManagementRequest

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 MyBusinessAccountManagementRequest<ListAccountsResponse>

setOauthToken

public MyBusinessAccountManagement.Accounts.List setOauthToken(String oauthToken)

Description copied from class: MyBusinessAccountManagementRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class MyBusinessAccountManagementRequest<ListAccountsResponse>

setPrettyPrint

public MyBusinessAccountManagement.Accounts.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: MyBusinessAccountManagementRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class MyBusinessAccountManagementRequest<ListAccountsResponse>

setQuotaUser

public MyBusinessAccountManagement.Accounts.List setQuotaUser(String quotaUser)

Description copied from class: MyBusinessAccountManagementRequest

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 MyBusinessAccountManagementRequest<ListAccountsResponse>

setUploadType

public MyBusinessAccountManagement.Accounts.List setUploadType(String uploadType)

Description copied from class: MyBusinessAccountManagementRequest

Legacy upload protocol for media (e.g. "media", "multipart").

Overrides:

setUploadType in class MyBusinessAccountManagementRequest<ListAccountsResponse>

setUploadProtocol

public MyBusinessAccountManagement.Accounts.List setUploadProtocol(String uploadProtocol)

Description copied from class: MyBusinessAccountManagementRequest

Upload protocol for media (e.g. "raw", "multipart").

Overrides:

setUploadProtocol in class MyBusinessAccountManagementRequest<ListAccountsResponse>

getFilter

public String getFilter()

Optional. A filter constraining the accounts to return. The response includes only entries that match the filter. If `filter` is empty, then no constraints are applied and all accounts (paginated) are retrieved for the requested account. For example, a request with the filter `type=USER_GROUP` will only return user groups. The `type` field is the only supported filter.

setFilter

public MyBusinessAccountManagement.Accounts.List setFilter(String filter)

Optional. A filter constraining the accounts to return. The response includes only entries that match the filter. If `filter` is empty, then no constraints are applied and all accounts (paginated) are retrieved for the requested account. For example, a request with the filter `type=USER_GROUP` will only return user groups. The `type` field is the only supported filter.

getPageSize

public Integer getPageSize()

Optional. How many accounts to fetch per page. The default and maximum is 20.

setPageSize

public MyBusinessAccountManagement.Accounts.List setPageSize(Integer pageSize)

Optional. How many accounts to fetch per page. The default and maximum is 20.

getPageToken

public String getPageToken()

Optional. If specified, the next page of accounts is retrieved. The `pageToken` is returned when a call to `accounts.list` returns more results than can fit into the requested page size.

setPageToken

public MyBusinessAccountManagement.Accounts.List setPageToken(String pageToken)

Optional. If specified, the next page of accounts is retrieved. The `pageToken` is returned when a call to `accounts.list` returns more results than can fit into the requested page size.

getParentAccount

public String getParentAccount()

Optional. The resource name of the account for which the list of directly accessible accounts is to be retrieved. This only makes sense for Organizations and User Groups. If empty, will return `ListAccounts` for the authenticated user. `accounts/{account_id}`.

setParentAccount

public MyBusinessAccountManagement.Accounts.List setParentAccount(String parentAccount)

Optional. The resource name of the account for which the list of directly accessible accounts is to be retrieved. This only makes sense for Organizations and User Groups. If empty, will return `ListAccounts` for the authenticated user. `accounts/{account_id}`.

set

public MyBusinessAccountManagement.Accounts.List set(String parameterName,
                                                     Object value)

Overrides:

set in class MyBusinessAccountManagementRequest<ListAccountsResponse>