com.google.api.services.games

Class Games.Events.ListDefinitions

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.games.GamesRequest<EventDefinitionListResponse>

com.google.api.services.games.Games.Events.ListDefinitions

All Implemented Interfaces:

Cloneable, Map<String,Object>

Enclosing class:

Games.Events

public class Games.Events.ListDefinitions
extends GamesRequest<EventDefinitionListResponse>

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>

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	Games.Events.ListDefinitions() Returns a list of the event definitions in this application.

Method Summary

Methods

Modifier and Type	Method and Description
HttpRequest	buildHttpRequestUsingHead()
HttpResponse	executeUsingHead()
String	getLanguage() The preferred language to use for strings returned by this method.
Integer	getMaxResults() The maximum number of event definitions to return in the response, used for paging.
String	getPageToken() The token returned by the previous request.
Games.Events.ListDefinitions	set(String parameterName, Object value)
Games.Events.ListDefinitions	setAlt(String alt) Data format for the response.
Games.Events.ListDefinitions	setFields(String fields) Selector specifying which fields to include in a partial response.
Games.Events.ListDefinitions	setKey(String key) API key.
Games.Events.ListDefinitions	setLanguage(String language) The preferred language to use for strings returned by this method.
Games.Events.ListDefinitions	setMaxResults(Integer maxResults) The maximum number of event definitions to return in the response, used for paging.
Games.Events.ListDefinitions	setOauthToken(String oauthToken) OAuth 2.0 token for the current user.
Games.Events.ListDefinitions	setPageToken(String pageToken) The token returned by the previous request.
Games.Events.ListDefinitions	setPrettyPrint(Boolean prettyPrint) Returns response with indentations and line breaks.
Games.Events.ListDefinitions	setQuotaUser(String quotaUser) Available to use for quota purposes for server-side applications.
Games.Events.ListDefinitions	setUserIp(String userIp) IP address of the site where the request originates.

Methods inherited from class com.google.api.services.games.GamesRequest

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, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue

Methods inherited from class com.google.api.client.util.GenericData

clone, entrySet, get, getClassInfo, getUnknownKeys, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, equals, hashCode, isEmpty, keySet, size, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Games.Events.ListDefinitions

protected Games.Events.ListDefinitions()

Returns a list of the event definitions in this application. Create a request for the method "events.listDefinitions". This request holds the parameters needed by the the games server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.

ListDefinitions#initialize(com.google.api.client.googleapis.services.AbstractGoogleC lientRequest) 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<EventDefinitionListResponse>

Throws:

IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws IOException

Overrides:

buildHttpRequestUsingHead in class AbstractGoogleClientRequest<EventDefinitionListResponse>

Throws:

IOException

setAlt

public Games.Events.ListDefinitions setAlt(String alt)

Description copied from class: GamesRequest

Data format for the response.

Overrides:

setAlt in class GamesRequest<EventDefinitionListResponse>

setFields

public Games.Events.ListDefinitions setFields(String fields)

Description copied from class: GamesRequest

Selector specifying which fields to include in a partial response.

Overrides:

setFields in class GamesRequest<EventDefinitionListResponse>

setKey

public Games.Events.ListDefinitions setKey(String key)

Description copied from class: GamesRequest

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 GamesRequest<EventDefinitionListResponse>

setOauthToken

public Games.Events.ListDefinitions setOauthToken(String oauthToken)

Description copied from class: GamesRequest

OAuth 2.0 token for the current user.

Overrides:

setOauthToken in class GamesRequest<EventDefinitionListResponse>

setPrettyPrint

public Games.Events.ListDefinitions setPrettyPrint(Boolean prettyPrint)

Description copied from class: GamesRequest

Returns response with indentations and line breaks.

Overrides:

setPrettyPrint in class GamesRequest<EventDefinitionListResponse>

setQuotaUser

public Games.Events.ListDefinitions setQuotaUser(String quotaUser)

Description copied from class: GamesRequest

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 userIp if both are provided.

Overrides:

setQuotaUser in class GamesRequest<EventDefinitionListResponse>

setUserIp

public Games.Events.ListDefinitions setUserIp(String userIp)

Description copied from class: GamesRequest

IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:

setUserIp in class GamesRequest<EventDefinitionListResponse>

getPageToken

public String getPageToken()

The token returned by the previous request.

setPageToken

public Games.Events.ListDefinitions setPageToken(String pageToken)

The token returned by the previous request.

getMaxResults

public Integer getMaxResults()

The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified maxResults. [minimum: 1] [maximum: 100]

setMaxResults

public Games.Events.ListDefinitions setMaxResults(Integer maxResults)

The maximum number of event definitions to return in the response, used for paging. For any response, the actual number of event definitions to return may be less than the specified maxResults.

getLanguage

public String getLanguage()

The preferred language to use for strings returned by this method.

setLanguage

public Games.Events.ListDefinitions setLanguage(String language)

The preferred language to use for strings returned by this method.

set

public Games.Events.ListDefinitions set(String parameterName,
                               Object value)

Overrides:

set in class GamesRequest<EventDefinitionListResponse>