target.apidocs.com.google.api.services.calendar.Calendar.Events.Get.html Maven / Gradle / Ivy
The newest version!
Calendar.Events.Get (Calendar API v3-rev20241101-2.0.0)
com.google.api.services.calendar
Class Calendar.Events.Get
- 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<Event>
-
- com.google.api.services.calendar.Calendar.Events.Get
-
- 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
com.google.api.client.util.GenericData.Flags
-
Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
-
Constructor Summary
Constructors
Modifier
Constructor and Description
protected
Get(String calendarId,
String eventId)
Returns an event based on its Google Calendar ID.
-
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()
Event identifier.
Integer
getMaxAttendees()
The maximum number of attendees to include in the response.
String
getTimeZone()
Time zone used in the response.
Calendar.Events.Get
set(String parameterName,
Object value)
Calendar.Events.Get
setAlt(String alt)
Data format for the response.
Calendar.Events.Get
setAlwaysIncludeEmail(Boolean alwaysIncludeEmail)
Deprecated and ignored.
Calendar.Events.Get
setCalendarId(String calendarId)
Calendar identifier.
Calendar.Events.Get
setEventId(String eventId)
Event identifier.
Calendar.Events.Get
setFields(String fields)
Selector specifying which fields to include in a partial response.
Calendar.Events.Get
setKey(String key)
API key.
Calendar.Events.Get
setMaxAttendees(Integer maxAttendees)
The maximum number of attendees to include in the response.
Calendar.Events.Get
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Calendar.Events.Get
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Calendar.Events.Get
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Calendar.Events.Get
setTimeZone(String timeZone)
Time zone used in the response.
Calendar.Events.Get
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
-
Get
protected Get(String calendarId,
String eventId)
Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID,
call the events.list method using the iCalUID parameter.
Create a request for the method "events.get".
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
- 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<Event>
- Throws:
IOException
-
buildHttpRequestUsingHead
public com.google.api.client.http.HttpRequest buildHttpRequestUsingHead()
throws IOException
- Overrides:
buildHttpRequestUsingHead
in class com.google.api.client.googleapis.services.AbstractGoogleClientRequest<Event>
- Throws:
IOException
-
setAlt
public Calendar.Events.Get setAlt(String alt)
Description copied from class: CalendarRequest
Data format for the response.
- Overrides:
setAlt
in class CalendarRequest<Event>
-
setFields
public Calendar.Events.Get setFields(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(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(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(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(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<Event>
-
setUserIp
public Calendar.Events.Get setUserIp(String userIp)
Description copied from class: CalendarRequest
Deprecated. Please use quotaUser instead.
- Overrides:
setUserIp
in class CalendarRequest<Event>
-
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.Get 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()
Event identifier.
-
setEventId
public Calendar.Events.Get setEventId(String eventId)
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.Get 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.Get 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.
-
getTimeZone
public String getTimeZone()
Time zone used in the response. Optional. The default is the time zone of the calendar.
-
setTimeZone
public Calendar.Events.Get setTimeZone(String timeZone)
Time zone used in the response. Optional. The default is the time zone of the calendar.
-
set
public Calendar.Events.Get set(String parameterName,
Object value)
- Overrides:
set
in class CalendarRequest<Event>
Copyright © 2011–2024 Google. All rights reserved.
© 2015 - 2024 Weber Informatics LLC | Privacy Policy