Calendar API v3 (revision 30)



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

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

public class Calendar.Events.Instances
extends CalendarRequest<Events>


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()
          Recurring event identifier.
 java.lang.Integer getMaxAttendees()
          The maximum number of attendees to include in the response.
 java.lang.Integer getMaxResults()
          Maximum number of events returned on one result page.
 java.lang.String getOriginalStart()
          The original start time of the instance in the result.
 java.lang.String getPageToken()
          Token specifying which result page to return.
 java.lang.Boolean getShowDeleted()
          Whether to include deleted events (with 'status' equals 'cancelled') in the result.
 DateTime getTimeMax()
          Upper bound (exclusive) for an event's start time to filter by.
 DateTime getTimeMin()
          Lower bound (inclusive) for an event's end time to filter by.
 java.lang.String getTimeZone()
          Time zone used in the response.
 Calendar.Events.Instances setAlt(java.lang.String alt)
          Data format for the response.
 Calendar.Events.Instances 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.Instances setCalendarId(java.lang.String calendarId)
          Calendar identifier.
 Calendar.Events.Instances setEventId(java.lang.String eventId)
          Recurring event identifier.
 Calendar.Events.Instances setFields(java.lang.String fields)
          Selector specifying which fields to include in a partial response.
 Calendar.Events.Instances setKey(java.lang.String key)
          API key.
 Calendar.Events.Instances setMaxAttendees(java.lang.Integer maxAttendees)
          The maximum number of attendees to include in the response.
 Calendar.Events.Instances setMaxResults(java.lang.Integer maxResults)
          Maximum number of events returned on one result page.
 Calendar.Events.Instances setOauthToken(java.lang.String oauthToken)
          OAuth 2.0 token for the current user.
 Calendar.Events.Instances setOriginalStart(java.lang.String originalStart)
          The original start time of the instance in the result.
 Calendar.Events.Instances setPageToken(java.lang.String pageToken)
          Token specifying which result page to return.
 Calendar.Events.Instances setPrettyPrint(java.lang.Boolean prettyPrint)
          Returns response with indentations and line breaks.
 Calendar.Events.Instances setQuotaUser(java.lang.String quotaUser)
          Available to use for quota purposes for server-side applications.
 Calendar.Events.Instances setShowDeleted(java.lang.Boolean showDeleted)
          Whether to include deleted events (with 'status' equals 'cancelled') in the result.
 Calendar.Events.Instances setTimeMax(DateTime timeMax)
          Upper bound (exclusive) for an event's start time to filter by.
 Calendar.Events.Instances setTimeMin(DateTime timeMin)
          Lower bound (inclusive) for an event's end time to filter by.
 Calendar.Events.Instances setTimeZone(java.lang.String timeZone)
          Time zone used in the response.
 Calendar.Events.Instances 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<Events>
Throws:
java.io.IOException

buildHttpRequestUsingHead

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

setAlt

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

Overrides:
setAlt in class CalendarRequest<Events>

setFields

public Calendar.Events.Instances 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<Events>

setKey

public Calendar.Events.Instances 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<Events>

setOauthToken

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

Overrides:
setOauthToken in class CalendarRequest<Events>

setPrettyPrint

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

Overrides:
setPrettyPrint in class CalendarRequest<Events>

setQuotaUser

public Calendar.Events.Instances 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<Events>

setUserIp

public Calendar.Events.Instances 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<Events>

getCalendarId

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


setCalendarId

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


getEventId

public java.lang.String getEventId()
Recurring event identifier.


setEventId

public Calendar.Events.Instances setEventId(java.lang.String eventId)
Recurring event identifier.


getShowDeleted

public java.lang.Boolean getShowDeleted()
Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False.


setShowDeleted

public Calendar.Events.Instances setShowDeleted(java.lang.Boolean showDeleted)
Whether to include deleted events (with 'status' equals 'cancelled') in the result. Cancelled instances of recurring events will still be included if 'singleEvents' is False. Optional. The default is False.


getTimeMax

public DateTime getTimeMax()
Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.


setTimeMax

public Calendar.Events.Instances setTimeMax(DateTime timeMax)
Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time.


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.Instances 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.


getMaxResults

public java.lang.Integer getMaxResults()
Maximum number of events returned on one result page. Optional. [minimum: 1]


setMaxResults

public Calendar.Events.Instances setMaxResults(java.lang.Integer maxResults)
Maximum number of events returned on one result page. Optional.


getPageToken

public java.lang.String getPageToken()
Token specifying which result page to return. Optional.


setPageToken

public Calendar.Events.Instances setPageToken(java.lang.String pageToken)
Token specifying which result page to return. Optional.


getTimeMin

public DateTime getTimeMin()
Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.


setTimeMin

public Calendar.Events.Instances setTimeMin(DateTime timeMin)
Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time.


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.Instances setTimeZone(java.lang.String timeZone)
Time zone used in the response. Optional. The default is the time zone of the calendar.


getOriginalStart

public java.lang.String getOriginalStart()
The original start time of the instance in the result. Optional.


setOriginalStart

public Calendar.Events.Instances setOriginalStart(java.lang.String originalStart)
The original start time of the instance in the result. Optional.


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.Instances 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.