Calendar API v3 (revision 30)



com.google.api.services.calendar
Class Calendar.Events.Get

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<Event>
                      extended by com.google.api.services.calendar.Calendar.Events.Get
All Implemented Interfaces:
java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.Object>
Enclosing class:
Calendar.Events

public class Calendar.Events.Get
extends CalendarRequest<Event>


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>
 
Method Summary
 HttpRequest buildHttpRequestUsingHead()
           
 HttpResponse executeUsingHead()
           
 java.lang.Boolean getAlwaysIncludeEmail()
          Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e.
 java.lang.String getCalendarId()
          Calendar identifier.
 java.lang.String getEventId()
          Event identifier.
 java.lang.Integer getMaxAttendees()
          The maximum number of attendees to include in the response.
 java.lang.String getTimeZone()
          Time zone used in the response.
 Calendar.Events.Get setAlt(java.lang.String alt)
          Data format for the response.
 Calendar.Events.Get setAlwaysIncludeEmail(java.lang.Boolean alwaysIncludeEmail)
          Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e.
 Calendar.Events.Get setCalendarId(java.lang.String calendarId)
          Calendar identifier.
 Calendar.Events.Get setEventId(java.lang.String eventId)
          Event identifier.
 Calendar.Events.Get setFields(java.lang.String fields)
          Selector specifying which fields to include in a partial response.
 Calendar.Events.Get setKey(java.lang.String key)
          API key.
 Calendar.Events.Get setMaxAttendees(java.lang.Integer maxAttendees)
          The maximum number of attendees to include in the response.
 Calendar.Events.Get setOauthToken(java.lang.String oauthToken)
          OAuth 2.0 token for the current user.
 Calendar.Events.Get setPrettyPrint(java.lang.Boolean prettyPrint)
          Returns response with indentations and line breaks.
 Calendar.Events.Get setQuotaUser(java.lang.String quotaUser)
          Available to use for quota purposes for server-side applications.
 Calendar.Events.Get setTimeZone(java.lang.String timeZone)
          Time zone used in the response.
 Calendar.Events.Get setUserIp(java.lang.String userIp)
          IP address of the site where the request originates.
 
Methods inherited from class com.google.api.services.calendar.CalendarRequest
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, 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, 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
 

Method Detail

executeUsingHead

public HttpResponse executeUsingHead()
                              throws java.io.IOException
Overrides:
executeUsingHead in class AbstractGoogleClientRequest<Event>
Throws:
java.io.IOException

buildHttpRequestUsingHead

public HttpRequest buildHttpRequestUsingHead()
                                      throws java.io.IOException
Overrides:
buildHttpRequestUsingHead in class AbstractGoogleClientRequest<Event>
Throws:
java.io.IOException

setAlt

public Calendar.Events.Get setAlt(java.lang.String alt)
Description copied from class: CalendarRequest
Data format for the response.

Overrides:
setAlt in class CalendarRequest<Event>

setFields

public Calendar.Events.Get setFields(java.lang.String fields)
Description copied from class: CalendarRequest
Selector specifying which fields to include in a partial response.

Overrides:
setFields in class CalendarRequest<Event>

setKey

public Calendar.Events.Get setKey(java.lang.String key)
Description copied from class: CalendarRequest
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 CalendarRequest<Event>

setOauthToken

public Calendar.Events.Get setOauthToken(java.lang.String oauthToken)
Description copied from class: CalendarRequest
OAuth 2.0 token for the current user.

Overrides:
setOauthToken in class CalendarRequest<Event>

setPrettyPrint

public Calendar.Events.Get setPrettyPrint(java.lang.Boolean prettyPrint)
Description copied from class: CalendarRequest
Returns response with indentations and line breaks.

Overrides:
setPrettyPrint in class CalendarRequest<Event>

setQuotaUser

public Calendar.Events.Get setQuotaUser(java.lang.String quotaUser)
Description copied from class: CalendarRequest
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 CalendarRequest<Event>

setUserIp

public Calendar.Events.Get setUserIp(java.lang.String userIp)
Description copied from class: CalendarRequest
IP address of the site where the request originates. Use this if you want to enforce per-user limits.

Overrides:
setUserIp in class CalendarRequest<Event>

getCalendarId

public java.lang.String getCalendarId()
Calendar identifier.


setCalendarId

public Calendar.Events.Get setCalendarId(java.lang.String calendarId)
Calendar identifier.


getEventId

public java.lang.String getEventId()
Event identifier.


setEventId

public Calendar.Events.Get setEventId(java.lang.String eventId)
Event identifier.


getTimeZone

public java.lang.String getTimeZone()
Time zone used in the response. Optional. The default is the time zone of the calendar.


setTimeZone

public Calendar.Events.Get setTimeZone(java.lang.String timeZone)
Time zone used in the response. Optional. The default is the time zone of the calendar.


getAlwaysIncludeEmail

public java.lang.Boolean getAlwaysIncludeEmail()
Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.


setAlwaysIncludeEmail

public Calendar.Events.Get setAlwaysIncludeEmail(java.lang.Boolean alwaysIncludeEmail)
Whether to always include a value in the "email" field for the organizer, creator and attendees, even if no real email is available (i.e. a generated, non-working value will be provided). The use of this option is discouraged and should only be used by clients which cannot handle the absence of an email address value in the mentioned places. Optional. The default is False.


getMaxAttendees

public java.lang.Integer getMaxAttendees()
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional. [minimum: 1]


setMaxAttendees

public Calendar.Events.Get setMaxAttendees(java.lang.Integer maxAttendees)
The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.