Calendar.Events.Instances (Calendar API v3-rev20250404-2.0.0)

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.calendar.CalendarRequest<Events>
        
        com.google.api.services.calendar.Calendar.Events.Instances

All Implemented Interfaces:

Cloneable, Map<String,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
  com.google.api.client.util.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
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier Constructor and Description

protected Instances(String calendarId, String eventId)
Returns instances of the specified recurring event.

Constructors
Modifier	Constructor and Description
`protected`	`Instances(String calendarId, String eventId)` Returns instances of the specified recurring event.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.google.api.client.http.HttpRequest`	`buildHttpRequestUsingHead()`
`com.google.api.client.http.HttpResponse`	`executeUsingHead()`
`Boolean`	`getAlwaysIncludeEmail()` Deprecated and ignored.
`String`	`getCalendarId()` Calendar identifier.
`String`	`getEventId()` Recurring event identifier.
`Integer`	`getMaxAttendees()` The maximum number of attendees to include in the response.
`Integer`	`getMaxResults()` Maximum number of events returned on one result page.
`String`	`getOriginalStart()` The original start time of the instance in the result.
`String`	`getPageToken()` Token specifying which result page to return.
`Boolean`	`getShowDeleted()` Whether to include deleted events (with status equals "cancelled") in the result.
`com.google.api.client.util.DateTime`	`getTimeMax()` Upper bound (exclusive) for an event's start time to filter by.
`com.google.api.client.util.DateTime`	`getTimeMin()` Lower bound (inclusive) for an event's end time to filter by.
`String`	`getTimeZone()` Time zone used in the response.
`Calendar.Events.Instances`	`set(String parameterName, Object value)`
`Calendar.Events.Instances`	`setAlt(String alt)` Data format for the response.
`Calendar.Events.Instances`	`setAlwaysIncludeEmail(Boolean alwaysIncludeEmail)` Deprecated and ignored.
`Calendar.Events.Instances`	`setCalendarId(String calendarId)` Calendar identifier.
`Calendar.Events.Instances`	`setEventId(String eventId)` Recurring event identifier.
`Calendar.Events.Instances`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`Calendar.Events.Instances`	`setKey(String key)` API key.
`Calendar.Events.Instances`	`setMaxAttendees(Integer maxAttendees)` The maximum number of attendees to include in the response.
`Calendar.Events.Instances`	`setMaxResults(Integer maxResults)` Maximum number of events returned on one result page.
`Calendar.Events.Instances`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`Calendar.Events.Instances`	`setOriginalStart(String originalStart)` The original start time of the instance in the result.
`Calendar.Events.Instances`	`setPageToken(String pageToken)` Token specifying which result page to return.
`Calendar.Events.Instances`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`Calendar.Events.Instances`	`setQuotaUser(String quotaUser)` An opaque string that represents a user for quota purposes.
`Calendar.Events.Instances`	`setShowDeleted(Boolean showDeleted)` Whether to include deleted events (with status equals "cancelled") in the result.
`Calendar.Events.Instances`	`setTimeMax(com.google.api.client.util.DateTime timeMax)` Upper bound (exclusive) for an event's start time to filter by.
`Calendar.Events.Instances`	`setTimeMin(com.google.api.client.util.DateTime timeMin)` Lower bound (inclusive) for an event's end time to filter by.
`Calendar.Events.Instances`	`setTimeZone(String timeZone)` Time zone used in the response.
`Calendar.Events.Instances`	`setUserIp(String userIp)` Deprecated.

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, 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
  - Instances
```
protected Instances(String calendarId,
                    String eventId)
```
    Returns instances of the specified recurring event. Create a request for the method "events.instances". This request holds the parameters needed by the the calendar server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    Calendar.initialize(com.google.api.client.googleapis.services.AbstractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    calendarId - Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
    
    eventId - Recurring event identifier.
    
    Since:
    
    1.13
- Method Detail
  - executeUsingHead
```
public com.google.api.client.http.HttpResponse executeUsingHead()
                                                         throws IOException
```
    Overrides:
    
    executeUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Events>
    
    Throws:
    
    IOException
  - buildHttpRequestUsingHead
```
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
                                                                 throws IOException
```
    Overrides:
    
    buildHttpRequestUsingHead in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Events>
    
    Throws:
    
    IOException
  - setAlt
```
public Calendar.Events.Instances setAlt(String alt)
```
    Description copied from class: CalendarRequest
    
    Data format for the response.
    
    Overrides:
    
    setAlt in class CalendarRequest<Events>
  - setFields
```
public Calendar.Events.Instances setFields(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(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(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(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(String quotaUser)
```
    Description copied from class: CalendarRequest
    
    An opaque string that represents a user for quota purposes. Must not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class CalendarRequest<Events>
  - setUserIp
```
public Calendar.Events.Instances setUserIp(String userIp)
```
    Description copied from class: CalendarRequest
    
    Deprecated. Please use quotaUser instead.
    
    Overrides:
    
    setUserIp in class CalendarRequest<Events>
  - getCalendarId
```
public String getCalendarId()
```
    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  - setCalendarId
```
public Calendar.Events.Instances setCalendarId(String calendarId)
```
    Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.
  - getEventId
```
public String getEventId()
```
    Recurring event identifier.
  - setEventId
```
public Calendar.Events.Instances setEventId(String eventId)
```
    Recurring event identifier.
  - getAlwaysIncludeEmail
```
public Boolean getAlwaysIncludeEmail()
```
    Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
  - setAlwaysIncludeEmail
```
public Calendar.Events.Instances setAlwaysIncludeEmail(Boolean alwaysIncludeEmail)
```
    Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).
  - getMaxAttendees
```
public 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(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.
  - getMaxResults
```
public Integer getMaxResults()
```
    Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. [minimum: 1]
  - setMaxResults
```
public Calendar.Events.Instances setMaxResults(Integer maxResults)
```
    Maximum number of events returned on one result page. By default the value is 250 events. The page size can never be larger than 2500 events. Optional.
  - getOriginalStart
```
public String getOriginalStart()
```
    The original start time of the instance in the result. Optional.
  - setOriginalStart
```
public Calendar.Events.Instances setOriginalStart(String originalStart)
```
    The original start time of the instance in the result. Optional.
  - getPageToken
```
public String getPageToken()
```
    Token specifying which result page to return. Optional.
  - setPageToken
```
public Calendar.Events.Instances setPageToken(String pageToken)
```
    Token specifying which result page to return. Optional.
  - getShowDeleted
```
public 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(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 com.google.api.client.util.DateTime getTimeMax()
```
    Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.
  - setTimeMax
```
public Calendar.Events.Instances setTimeMax(com.google.api.client.util.DateTime timeMax)
```
    Upper bound (exclusive) for an event's start time to filter by. Optional. The default is not to filter by start time. Must be an RFC3339 timestamp with mandatory time zone offset.
  - getTimeMin
```
public com.google.api.client.util.DateTime getTimeMin()
```
    Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.
  - setTimeMin
```
public Calendar.Events.Instances setTimeMin(com.google.api.client.util.DateTime timeMin)
```
    Lower bound (inclusive) for an event's end time to filter by. Optional. The default is not to filter by end time. Must be an RFC3339 timestamp with mandatory time zone offset.
  - getTimeZone
```
public String getTimeZone()
```
    Time zone used in the response. Optional. The default is the time zone of the calendar.
  - setTimeZone
```
public Calendar.Events.Instances setTimeZone(String timeZone)
```
    Time zone used in the response. Optional. The default is the time zone of the calendar.
  - set
```
public Calendar.Events.Instances set(String parameterName,
                                     Object value)
```
    Overrides:
    
    set in class CalendarRequest<Events>

Class Calendar.Events.Instances

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.calendar.CalendarRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

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

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

Instances

Method Detail

executeUsingHead

buildHttpRequestUsingHead

setAlt

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUserIp

getCalendarId

setCalendarId

getEventId

setEventId

getAlwaysIncludeEmail

setAlwaysIncludeEmail

getMaxAttendees

setMaxAttendees

getMaxResults

setMaxResults

getOriginalStart

setOriginalStart

getPageToken

setPageToken

getShowDeleted

setShowDeleted

getTimeMax

setTimeMax

getTimeMin

setTimeMin

getTimeZone

setTimeZone

set