com.google.api.services.gmailpostmastertools.v1

Class PostmasterTools.Domains.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.gmailpostmastertools.v1.PostmasterToolsRequest<ListDomainsResponse>

com.google.api.services.gmailpostmastertools.v1.PostmasterTools.Domains.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

PostmasterTools.Domains

public class PostmasterTools.Domains.List
extends PostmasterToolsRequest<ListDomainsResponse>

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	List() Lists the domains that have been registered by the client.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
Integer	getPageSize() Requested page size.
String	getPageToken() The next_page_token value returned from a previous List request, if any.
PostmasterTools.Domains.List	set(String parameterName, Object value)
PostmasterTools.Domains.List	set$Xgafv(String $Xgafv) V1 error format.
PostmasterTools.Domains.List	setAccessToken(String accessToken) OAuth access token.
PostmasterTools.Domains.List	setAlt(String alt) Data format for response.
PostmasterTools.Domains.List	setCallback(String callback) JSONP
PostmasterTools.Domains.List	setFields(String fields) Selector specifying which fields to include in a partial response.
PostmasterTools.Domains.List	setKey(String key) API key.
PostmasterTools.Domains.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
PostmasterTools.Domains.List	setPageSize(Integer pageSize) Requested page size.
PostmasterTools.Domains.List	setPageToken(String pageToken) The next_page_token value returned from a previous List request, if any.
PostmasterTools.Domains.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
PostmasterTools.Domains.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
PostmasterTools.Domains.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
PostmasterTools.Domains.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.gmailpostmastertools.v1.PostmasterToolsRequest

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 the domains that have been registered by the client. The order of domains in the response is unspecified and non-deterministic. Newly created domains will not necessarily be added to the end of this list. Create a request for the method "domains.list". This request holds the parameters needed by the the gmailpostmastertools server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

PostmasterTools.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<ListDomainsResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<ListDomainsResponse>

Throws:

IOException

set$Xgafv

public PostmasterTools.Domains.List set$Xgafv(String $Xgafv)

Description copied from class: PostmasterToolsRequest

V1 error format.

Overrides:

set$Xgafv in class PostmasterToolsRequest<ListDomainsResponse>

setAccessToken

public PostmasterTools.Domains.List setAccessToken(String accessToken)

Description copied from class: PostmasterToolsRequest

OAuth access token.

Overrides:

setAccessToken in class PostmasterToolsRequest<ListDomainsResponse>

setAlt

public PostmasterTools.Domains.List setAlt(String alt)

Description copied from class: PostmasterToolsRequest

Data format for response.

Overrides:

setAlt in class PostmasterToolsRequest<ListDomainsResponse>

setCallback

public PostmasterTools.Domains.List setCallback(String callback)

Description copied from class: PostmasterToolsRequest

JSONP

Overrides:

setCallback in class PostmasterToolsRequest<ListDomainsResponse>

setFields

public PostmasterTools.Domains.List setFields(String fields)

Description copied from class: PostmasterToolsRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class PostmasterToolsRequest<ListDomainsResponse>

setKey

public PostmasterTools.Domains.List setKey(String key)

Description copied from class: PostmasterToolsRequest

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 PostmasterToolsRequest<ListDomainsResponse>

setOauthToken

public PostmasterTools.Domains.List setOauthToken(String oauthToken)

Description copied from class: PostmasterToolsRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class PostmasterToolsRequest<ListDomainsResponse>

setPrettyPrint

public PostmasterTools.Domains.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: PostmasterToolsRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class PostmasterToolsRequest<ListDomainsResponse>

setQuotaUser

public PostmasterTools.Domains.List setQuotaUser(String quotaUser)

Description copied from class: PostmasterToolsRequest

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 PostmasterToolsRequest<ListDomainsResponse>

setUploadType

public PostmasterTools.Domains.List setUploadType(String uploadType)

Description copied from class: PostmasterToolsRequest

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

Overrides:

setUploadType in class PostmasterToolsRequest<ListDomainsResponse>

setUploadProtocol

public PostmasterTools.Domains.List setUploadProtocol(String uploadProtocol)

Description copied from class: PostmasterToolsRequest

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

Overrides:

setUploadProtocol in class PostmasterToolsRequest<ListDomainsResponse>

getPageSize

public Integer getPageSize()

Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.

setPageSize

public PostmasterTools.Domains.List setPageSize(Integer pageSize)

Requested page size. Server may return fewer domains than requested. If unspecified, server will pick an appropriate default.

getPageToken

public String getPageToken()

The next_page_token value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to `ListDomains` method.

setPageToken

public PostmasterTools.Domains.List setPageToken(String pageToken)

The next_page_token value returned from a previous List request, if any. This is the value of ListDomainsResponse.next_page_token returned from the previous call to `ListDomains` method.

set

public PostmasterTools.Domains.List set(String parameterName,
                                        Object value)

Overrides:

set in class PostmasterToolsRequest<ListDomainsResponse>