Calendar API v3 (revision 30)



com.google.api.services.calendar
Class CalendarRequest<T>

java.lang.Object
  extended by java.util.AbstractMap<java.lang.String,java.lang.Object>
      extended by com.google.api.client.util.GenericData
          extended by com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
              extended by com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
                  extended by com.google.api.services.calendar.CalendarRequest<T>
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
Direct Known Subclasses:
Calendar.Acl.Delete, Calendar.Acl.Get, Calendar.Acl.Insert, Calendar.Acl.List, Calendar.Acl.Patch, Calendar.Acl.Update, Calendar.CalendarList.Delete, Calendar.CalendarList.Get, Calendar.CalendarList.Insert, Calendar.CalendarList.List, Calendar.CalendarList.Patch, Calendar.CalendarList.Update, Calendar.Calendars.Clear, Calendar.Calendars.Delete, Calendar.Calendars.Get, Calendar.Calendars.Insert, Calendar.Calendars.Patch, Calendar.Calendars.Update, Calendar.Colors.Get, Calendar.Events.CalendarImport, Calendar.Events.Delete, Calendar.Events.Get, Calendar.Events.Insert, Calendar.Events.Instances, Calendar.Events.List, Calendar.Events.Move, Calendar.Events.Patch, Calendar.Events.QuickAdd, Calendar.Events.Update, Calendar.Freebusy.Query, Calendar.Settings.Get, Calendar.Settings.List

public abstract class CalendarRequest<T>
extends AbstractGoogleJsonClientRequest<T>

Calendar request.

Upgrade warning: this class now extends AbstractGoogleJsonClientRequest, whereas in prior version 1.8 it extended JsonHttpRequest.

Since:
1.3

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
java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>
 
Nested classes/interfaces inherited from interface java.util.Map
java.util.Map.Entry<K,V>
 
Constructor Summary
CalendarRequest(Calendar client, java.lang.String method, java.lang.String uriTemplate, java.lang.Object content, java.lang.Class<T> responseClass)
           
 
Method Summary
 Calendar getAbstractGoogleClient()
           
 java.lang.String getAlt()
          Data format for the response.
 java.lang.String getFields()
          Selector specifying which fields to include in a partial response.
 java.lang.String getKey()
          API key.
 java.lang.String getOauthToken()
          OAuth 2.0 token for the current user.
 java.lang.Boolean getPrettyPrint()
          Returns response with indentations and line breaks.
 java.lang.String getQuotaUser()
          Available to use for quota purposes for server-side applications.
 java.lang.String getUserIp()
          IP address of the site where the request originates.
 CalendarRequest<T> setAlt(java.lang.String alt)
          Data format for the response.
 CalendarRequest<T> setDisableGZipContent(boolean disableGZipContent)
           
 CalendarRequest<T> setFields(java.lang.String fields)
          Selector specifying which fields to include in a partial response.
 CalendarRequest<T> setKey(java.lang.String key)
          API key.
 CalendarRequest<T> setOauthToken(java.lang.String oauthToken)
          OAuth 2.0 token for the current user.
 CalendarRequest<T> setPrettyPrint(java.lang.Boolean prettyPrint)
          Returns response with indentations and line breaks.
 CalendarRequest<T> setQuotaUser(java.lang.String quotaUser)
          Available to use for quota purposes for server-side applications.
 CalendarRequest<T> setRequestHeaders(HttpHeaders headers)
           
 CalendarRequest<T> setUserIp(java.lang.String userIp)
          IP address of the site where the request originates.
 
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, buildHttpRequestUsingHead, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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, set, 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

CalendarRequest

public CalendarRequest(Calendar client,
                       java.lang.String method,
                       java.lang.String uriTemplate,
                       java.lang.Object content,
                       java.lang.Class<T> responseClass)
Parameters:
client - Google client
method - HTTP Method
uriTemplate - URI template for the path relative to the base URL. If it starts with a "/" the base path from the base URL will be stripped out. The URI template can also be a full URL. URI template expansion is done using UriTemplate.expand(String, String, Object, boolean)
content - A POJO that can be serialized into JSON or null for none
responseClass - response class to parse into
Method Detail

getAlt

public java.lang.String getAlt()
Data format for the response. [default: json]


setAlt

public CalendarRequest<T> setAlt(java.lang.String alt)
Data format for the response.


getFields

public java.lang.String getFields()
Selector specifying which fields to include in a partial response.


setFields

public CalendarRequest<T> setFields(java.lang.String fields)
Selector specifying which fields to include in a partial response.


getKey

public java.lang.String getKey()
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.


setKey

public CalendarRequest<T> setKey(java.lang.String key)
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.


getOauthToken

public java.lang.String getOauthToken()
OAuth 2.0 token for the current user.


setOauthToken

public CalendarRequest<T> setOauthToken(java.lang.String oauthToken)
OAuth 2.0 token for the current user.


getPrettyPrint

public java.lang.Boolean getPrettyPrint()
Returns response with indentations and line breaks. [default: true]


setPrettyPrint

public CalendarRequest<T> setPrettyPrint(java.lang.Boolean prettyPrint)
Returns response with indentations and line breaks.


getQuotaUser

public java.lang.String getQuotaUser()
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.


setQuotaUser

public CalendarRequest<T> setQuotaUser(java.lang.String quotaUser)
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.


getUserIp

public java.lang.String getUserIp()
IP address of the site where the request originates. Use this if you want to enforce per-user limits.


setUserIp

public CalendarRequest<T> setUserIp(java.lang.String userIp)
IP address of the site where the request originates. Use this if you want to enforce per-user limits.


getAbstractGoogleClient

public final Calendar getAbstractGoogleClient()
Overrides:
getAbstractGoogleClient in class AbstractGoogleJsonClientRequest<T>

setDisableGZipContent

public CalendarRequest<T> setDisableGZipContent(boolean disableGZipContent)
Overrides:
setDisableGZipContent in class AbstractGoogleJsonClientRequest<T>

setRequestHeaders

public CalendarRequest<T> setRequestHeaders(HttpHeaders headers)
Overrides:
setRequestHeaders in class AbstractGoogleJsonClientRequest<T>