com.google.api.services.discovery

Class Discovery.Apis.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.discovery.DiscoveryRequest<DirectoryList>

com.google.api.services.discovery.Discovery.Apis.List

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Discovery.Apis

public class Discovery.Apis.List
extends DiscoveryRequest<DirectoryList>

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() Retrieve the list of APIs supported at this endpoint.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getName() Only include APIs with the given name.
Boolean	getPreferred() Return only the preferred version of an API.
boolean	isPreferred() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
Discovery.Apis.List	set(String parameterName, Object value)
Discovery.Apis.List	setAlt(String alt) Data format for the response.
Discovery.Apis.List	setFields(String fields) Selector specifying which fields to include in a partial response.
Discovery.Apis.List	setKey(String key) API key.
Discovery.Apis.List	setName(String name) Only include APIs with the given name.
Discovery.Apis.List	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Discovery.Apis.List	setPreferred(Boolean preferred) Return only the preferred version of an API.
Discovery.Apis.List	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Discovery.Apis.List	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Discovery.Apis.List	setUserIp(String userIp) Deprecated.

Methods inherited from class com.google.api.services.discovery.DiscoveryRequest

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, 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()

Retrieve the list of APIs supported at this endpoint. Create a request for the method "apis.list". This request holds the parameters needed by the the discovery server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

Discovery.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<DirectoryList>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<DirectoryList>

Throws:

IOException

setAlt

public Discovery.Apis.List setAlt(String alt)

Description copied from class: DiscoveryRequest

Data format for the response.

Overrides:

setAlt in class DiscoveryRequest<DirectoryList>

setFields

public Discovery.Apis.List setFields(String fields)

Description copied from class: DiscoveryRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryRequest<DirectoryList>

setKey

public Discovery.Apis.List setKey(String key)

Description copied from class: DiscoveryRequest

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 DiscoveryRequest<DirectoryList>

setOauthToken

public Discovery.Apis.List setOauthToken(String oauthToken)

Description copied from class: DiscoveryRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryRequest<DirectoryList>

setPrettyPrint

public Discovery.Apis.List setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryRequest<DirectoryList>

setQuotaUser

public Discovery.Apis.List setQuotaUser(String quotaUser)

Description copied from class: DiscoveryRequest

An opaque string that represents a user for quota purposes. Must not exceed 40 characters.

Overrides:

setQuotaUser in class DiscoveryRequest<DirectoryList>

setUserIp

public Discovery.Apis.List setUserIp(String userIp)

Description copied from class: DiscoveryRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DiscoveryRequest<DirectoryList>

getName

public String getName()

Only include APIs with the given name.

setName

public Discovery.Apis.List setName(String name)

Only include APIs with the given name.

getPreferred

public Boolean getPreferred()

Return only the preferred version of an API. [default: false]

setPreferred

public Discovery.Apis.List setPreferred(Boolean preferred)

Return only the preferred version of an API.

isPreferred

public boolean isPreferred()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

Return only the preferred version of an API.

set

public Discovery.Apis.List set(String parameterName,
                               Object value)

Overrides:

set in class DiscoveryRequest<DirectoryList>