target.apidocs.com.google.api.services.calendar.Calendar.Events.Patch.html Maven / Gradle / Ivy
The newest version!
Calendar.Events.Patch (Calendar API v3-rev20241101-2.0.0)
com.google.api.services.calendar
Class Calendar.Events.Patch
- 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.Patch
-
- Enclosing class:
- Calendar.Events
public class Calendar.Events.Patch
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
Patch(String calendarId,
String eventId,
Event content)
Updates an event.
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
Boolean
getAlwaysIncludeEmail()
Deprecated and ignored.
String
getCalendarId()
Calendar identifier.
Integer
getConferenceDataVersion()
Version number of conference data supported by the API client.
String
getEventId()
Event identifier.
Integer
getMaxAttendees()
The maximum number of attendees to include in the response.
Boolean
getSendNotifications()
Deprecated.
String
getSendUpdates()
Guests who should receive notifications about the event update (for example, title changes, etc.).
Boolean
getSupportsAttachments()
Whether API client performing operation supports event attachments.
Calendar.Events.Patch
set(String parameterName,
Object value)
Calendar.Events.Patch
setAlt(String alt)
Data format for the response.
Calendar.Events.Patch
setAlwaysIncludeEmail(Boolean alwaysIncludeEmail)
Deprecated and ignored.
Calendar.Events.Patch
setCalendarId(String calendarId)
Calendar identifier.
Calendar.Events.Patch
setConferenceDataVersion(Integer conferenceDataVersion)
Version number of conference data supported by the API client.
Calendar.Events.Patch
setEventId(String eventId)
Event identifier.
Calendar.Events.Patch
setFields(String fields)
Selector specifying which fields to include in a partial response.
Calendar.Events.Patch
setKey(String key)
API key.
Calendar.Events.Patch
setMaxAttendees(Integer maxAttendees)
The maximum number of attendees to include in the response.
Calendar.Events.Patch
setOauthToken(String oauthToken)
OAuth 2.0 token for the current user.
Calendar.Events.Patch
setPrettyPrint(Boolean prettyPrint)
Returns response with indentations and line breaks.
Calendar.Events.Patch
setQuotaUser(String quotaUser)
An opaque string that represents a user for quota purposes.
Calendar.Events.Patch
setSendNotifications(Boolean sendNotifications)
Deprecated.
Calendar.Events.Patch
setSendUpdates(String sendUpdates)
Guests who should receive notifications about the event update (for example, title changes,
etc.).
Calendar.Events.Patch
setSupportsAttachments(Boolean supportsAttachments)
Whether API client performing operation supports event attachments.
Calendar.Events.Patch
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, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, 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
-
Patch
protected Patch(String calendarId,
String eventId,
Event content)
Updates an event. This method supports patch semantics.
Create a request for the method "events.patch".
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.
content
- the Event
- Since:
- 1.13
-
Method Detail
-
setAlt
public Calendar.Events.Patch setAlt(String alt)
Description copied from class: CalendarRequest
Data format for the response.
- Overrides:
setAlt
in class CalendarRequest<Event>
-
setFields
public Calendar.Events.Patch 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.Patch 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.Patch 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.Patch 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.Patch 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.Patch 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.Patch 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.Patch 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.Patch 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).
-
getConferenceDataVersion
public Integer getConferenceDataVersion()
Version number of conference data supported by the API client. Version 0 assumes no conference data
support and ignores conference data in the event's body. Version 1 enables support for copying of
ConferenceData as well as for creating new conferences using the createRequest field of
conferenceData. The default is 0.
[minimum: 0] [maximum: 1]
-
setConferenceDataVersion
public Calendar.Events.Patch setConferenceDataVersion(Integer conferenceDataVersion)
Version number of conference data supported by the API client. Version 0 assumes no
conference data support and ignores conference data in the event's body. Version 1 enables
support for copying of ConferenceData as well as for creating new conferences using the
createRequest field of conferenceData. The default is 0.
-
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.Patch 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.
-
getSendNotifications
public Boolean getSendNotifications()
Deprecated. Please use sendUpdates instead.
Whether to send notifications about the event update (for example, description changes, etc.). Note
that some emails might still be sent even if you set the value to false. The default is false.
-
setSendNotifications
public Calendar.Events.Patch setSendNotifications(Boolean sendNotifications)
Deprecated. Please use sendUpdates instead.
Whether to send notifications about the event update (for example, description changes,
etc.). Note that some emails might still be sent even if you set the value to false. The
default is false.
-
getSendUpdates
public String getSendUpdates()
Guests who should receive notifications about the event update (for example, title changes, etc.).
-
setSendUpdates
public Calendar.Events.Patch setSendUpdates(String sendUpdates)
Guests who should receive notifications about the event update (for example, title changes,
etc.).
-
getSupportsAttachments
public Boolean getSupportsAttachments()
Whether API client performing operation supports event attachments. Optional. The default is False.
-
setSupportsAttachments
public Calendar.Events.Patch setSupportsAttachments(Boolean supportsAttachments)
Whether API client performing operation supports event attachments. Optional. The default
is False.
-
set
public Calendar.Events.Patch 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