com.google.api.services.discovery

Class Discovery.Apis.GetRest

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

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Discovery.Apis

public class Discovery.Apis.GetRest
extends DiscoveryRequest<RestDescription>

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	GetRest(String api, String version) Retrieve the description of a particular version of an api.

Method Summary

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getApi() The name of the API.
String	getVersion() The version of the API.
Discovery.Apis.GetRest	set(String parameterName, Object value)
Discovery.Apis.GetRest	setAlt(String alt) Data format for the response.
Discovery.Apis.GetRest	setApi(String api) The name of the API.
Discovery.Apis.GetRest	setFields(String fields) Selector specifying which fields to include in a partial response.
Discovery.Apis.GetRest	setKey(String key) API key.
Discovery.Apis.GetRest	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Discovery.Apis.GetRest	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Discovery.Apis.GetRest	setQuotaUser(String quotaUser) An opaque string that represents a user for quota purposes.
Discovery.Apis.GetRest	setUserIp(String userIp) Deprecated.
Discovery.Apis.GetRest	setVersion(String version) The version of the API.

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

GetRest

protected GetRest(String api,
                  String version)

Retrieve the description of a particular version of an api. Create a request for the method "apis.getRest". 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.

Parameters:

api - The name of the API.

version - The version of the API.

Since:

1.13

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws IOException

Overrides:

executeUsingHead in class AbstractGoogleClientRequest<RestDescription>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<RestDescription>

Throws:

IOException

setAlt

public Discovery.Apis.GetRest setAlt(String alt)

Description copied from class: DiscoveryRequest

Data format for the response.

Overrides:

setAlt in class DiscoveryRequest<RestDescription>

setFields

public Discovery.Apis.GetRest setFields(String fields)

Description copied from class: DiscoveryRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class DiscoveryRequest<RestDescription>

setKey

public Discovery.Apis.GetRest 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<RestDescription>

setOauthToken

public Discovery.Apis.GetRest setOauthToken(String oauthToken)

Description copied from class: DiscoveryRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class DiscoveryRequest<RestDescription>

setPrettyPrint

public Discovery.Apis.GetRest setPrettyPrint(Boolean prettyPrint)

Description copied from class: DiscoveryRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class DiscoveryRequest<RestDescription>

setQuotaUser

public Discovery.Apis.GetRest 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<RestDescription>

setUserIp

public Discovery.Apis.GetRest setUserIp(String userIp)

Description copied from class: DiscoveryRequest

Deprecated. Please use quotaUser instead.

Overrides:

setUserIp in class DiscoveryRequest<RestDescription>

getApi

public String getApi()

The name of the API.

setApi

public Discovery.Apis.GetRest setApi(String api)

The name of the API.

getVersion

public String getVersion()

The version of the API.

setVersion

public Discovery.Apis.GetRest setVersion(String version)

The version of the API.

set

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

Overrides:

set in class DiscoveryRequest<RestDescription>