com.google.api.services.appengine.v1

Class Appengine.Apps.Locations.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.appengine.v1.AppengineRequest<ListLocationsResponse>

com.google.api.services.appengine.v1.Appengine.Apps.Locations.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Appengine.Apps.Locations

public class Appengine.Apps.Locations.List
extends AppengineRequest<ListLocationsResponse>

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

USER_AGENT_SUFFIX

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	List(String appsId) Lists information about the supported locations for this service.

Method Summary

Modifier and Type	Method and Description
com.google.api.client.http.HttpRequest	buildHttpRequestUsingHead()
com.google.api.client.http.HttpResponse	executeUsingHead()
String	getAppsId() Part of `name`.
String	getFilter() A filter to narrow down results to a preferred subset.
Integer	getPageSize() The maximum number of results to return.
String	getPageToken() A page token received from the next_page_token field in the response.
Appengine.Apps.Locations.List	set(String parameterName, Object value)
Appengine.Apps.Locations.List	set$Xgafv(String $Xgafv) V1 error format.
Appengine.Apps.Locations.List	setAccessToken(String accessToken) OAuth access token.
Appengine.Apps.Locations.List	setAlt(String alt) Data format for response.
Appengine.Apps.Locations.List	setAppsId(String appsId) Part of `name`.
Appengine.Apps.Locations.List	setCallback(String callback) JSONP
Appengine.Apps.Locations.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Appengine.Apps.Locations.List	setFilter(String filter) A filter to narrow down results to a preferred subset.
Appengine.Apps.Locations.List	setKey(String key) API key.
Appengine.Apps.Locations.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Appengine.Apps.Locations.List	setPageSize(Integer pageSize) The maximum number of results to return.
Appengine.Apps.Locations.List	setPageToken(String pageToken) A page token received from the next_page_token field in the response.
Appengine.Apps.Locations.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Appengine.Apps.Locations.List	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Appengine.Apps.Locations.List	setUploadProtocol(String uploadProtocol) Upload protocol for media (e.g.
Appengine.Apps.Locations.List	setUploadType(String uploadType) Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.appengine.v1.AppengineRequest

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(String appsId)

Lists information about the supported locations for this service. Create a request for the method "locations.list". This request holds the parameters needed by the the appengine server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

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

Parameters:

appsId - Part of `name`. The resource that owns the locations collection, if applicable.

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<ListLocationsResponse>

Throws:

IOException

buildHttpRequestUsingHead

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

Overrides:

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

Throws:

IOException

set$Xgafv

public Appengine.Apps.Locations.List set$Xgafv(String $Xgafv)

Description copied from class: AppengineRequest

V1 error format.

Overrides:

set$Xgafv in class AppengineRequest<ListLocationsResponse>

setAccessToken

public Appengine.Apps.Locations.List setAccessToken(String accessToken)

Description copied from class: AppengineRequest

OAuth access token.

Overrides:

setAccessToken in class AppengineRequest<ListLocationsResponse>

setAlt

public Appengine.Apps.Locations.List setAlt(String alt)

Description copied from class: AppengineRequest

Data format for response.

Overrides:

setAlt in class AppengineRequest<ListLocationsResponse>

setCallback

public Appengine.Apps.Locations.List setCallback(String callback)

Description copied from class: AppengineRequest

JSONP

Overrides:

setCallback in class AppengineRequest<ListLocationsResponse>

setFields

public Appengine.Apps.Locations.List setFields(String fields)

Description copied from class: AppengineRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class AppengineRequest<ListLocationsResponse>

setKey

public Appengine.Apps.Locations.List setKey(String key)

Description copied from class: AppengineRequest

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 AppengineRequest<ListLocationsResponse>

setOauthToken

public Appengine.Apps.Locations.List setOauthToken(String oauthToken)

Description copied from class: AppengineRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class AppengineRequest<ListLocationsResponse>

setPrettyPrint

public Appengine.Apps.Locations.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: AppengineRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class AppengineRequest<ListLocationsResponse>

setQuotaUser

public Appengine.Apps.Locations.List setQuotaUser(String quotaUser)

Description copied from class: AppengineRequest

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 AppengineRequest<ListLocationsResponse>

setUploadType

public Appengine.Apps.Locations.List setUploadType(String uploadType)

Description copied from class: AppengineRequest

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

Overrides:

setUploadType in class AppengineRequest<ListLocationsResponse>

setUploadProtocol

public Appengine.Apps.Locations.List setUploadProtocol(String uploadProtocol)

Description copied from class: AppengineRequest

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

Overrides:

setUploadProtocol in class AppengineRequest<ListLocationsResponse>

getAppsId

public String getAppsId()

Part of `name`. The resource that owns the locations collection, if applicable.

setAppsId

public Appengine.Apps.Locations.List setAppsId(String appsId)

Part of `name`. The resource that owns the locations collection, if applicable.

getFilter

public String getFilter()

A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

setFilter

public Appengine.Apps.Locations.List setFilter(String filter)

A filter to narrow down results to a preferred subset. The filtering language accepts strings like "displayName=tokyo", and is documented in more detail in AIP-160 (https://google.aip.dev/160).

getPageSize

public Integer getPageSize()

The maximum number of results to return. If not set, the service selects a default.

setPageSize

public Appengine.Apps.Locations.List setPageSize(Integer pageSize)

The maximum number of results to return. If not set, the service selects a default.

getPageToken

public String getPageToken()

A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

setPageToken

public Appengine.Apps.Locations.List setPageToken(String pageToken)

A page token received from the next_page_token field in the response. Send that page token to receive the subsequent page.

set

public Appengine.Apps.Locations.List set(String parameterName,
                                         Object value)

Overrides:

set in class AppengineRequest<ListLocationsResponse>