You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@camel.apache.org by ac...@apache.org on 2020/12/10 11:09:02 UTC
[camel] 01/06: CAMEL-15932 - Camel-Google-* Stream components:
Review the documentation for calendar stream
This is an automated email from the ASF dual-hosted git repository.
acosentino pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/camel.git
commit c79cbc9bf62c5768bb1676adfdde87ecbf7c7e82
Author: Andrea Cosentino <an...@gmail.com>
AuthorDate: Thu Dec 10 11:50:31 2020 +0100
CAMEL-15932 - Camel-Google-* Stream components: Review the documentation for calendar stream
---
.../docs/google-calendar-stream-component.adoc | 510 +--------------------
1 file changed, 2 insertions(+), 508 deletions(-)
diff --git a/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc b/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc
index fd97d6d..56f8194 100644
--- a/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc
+++ b/components/camel-google-calendar/src/main/docs/google-calendar-stream-component.adoc
@@ -14,10 +14,10 @@ include::{cq-version}@camel-quarkus:ROOT:partial$reference/components/google-cal
*{component-header}*
-The Google Calendar component provides access
+The Google Calendar Stream component provides access
to https://calendar.google.com[Calendar] via
the https://developers.google.com/calendar/overview[Google Calendar
-Web APIs].
+Web APIs]. This component provides the streaming feature for Calendar events.
Google Calendar uses
the https://developers.google.com/accounts/docs/OAuth2[OAuth 2.0
@@ -140,510 +140,4 @@ with the following path and query parameters:
| *refreshToken* (security) | OAuth 2 refresh token. Using this, the Google Calendar component can obtain a new accessToken whenever the current one expires - a necessity if the application is long-lived. | | String
|===
-
-
-
-=== API Parameters (7 APIs):
-
-The Google Calendar Stream endpoint is an API based component and has additional parameters based on which API name and API method is used.
-The API name and API method is located in the endpoint URI as the null path parameters:
-
-----
-google-calendar-stream:index
-----
-
-There are 7 API names as listed in the table below:
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| API Name | Type | Description
-| *acl* | Consumer | The acl collection of methods
-| *calendars* | Consumer | The calendars collection of methods
-| *channels* | Consumer | The channels collection of methods
-| *events* | Consumer | The events collection of methods
-| *freebusy* | Consumer | The freebusy collection of methods
-| *list* | Consumer | The calendarList collection of methods
-| *settings* | Consumer | The settings collection of methods
-|===
-
-Each API is documented in the following sections to come.
-
-
-==== API: acl
-
-*Only consumer is supported*
-
-
-
-
-The acl API has 7 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-com.google.api.services.calendar.Calendar.Acl.Delete delete(String calendarId, String ruleId);
-
-com.google.api.services.calendar.Calendar.Acl.Get get(String calendarId, String ruleId);
-
-com.google.api.services.calendar.Calendar.Acl.Insert insert(String calendarId, com.google.api.services.calendar.model.AclRule content);
-
-com.google.api.services.calendar.Calendar.Acl.List list(String calendarId);
-
-com.google.api.services.calendar.Calendar.Acl.Patch patch(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content);
-
-com.google.api.services.calendar.Calendar.Acl.Update update(String calendarId, String ruleId, com.google.api.services.calendar.model.AclRule content);
-
-com.google.api.services.calendar.Calendar.Acl.Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content);
-
-----
-
-The acl API is defined in the syntax as follows:
-
-----
-google-calendar-stream:acl/methodName?[parameters]
-----
-
-The 7 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *delete* | | Deletes an access control rule
-| *get* | | Returns an access control rule
-| *insert* | | Creates an access control rule
-| *list* | | Returns the rules in the access control list for the calendar
-| *patch* | | Updates an access control rule
-| *update* | | Updates an access control rule
-| *watch* | | Watch for changes to ACL resources
-|===
-
-The acl API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| delete | *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. | String
-| delete | *ruleId* | ACL rule identifier | String
-| get | *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. | String
-| get | *ruleId* | ACL rule identifier | String
-| insert | *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. | String
-| insert | *content* | The com.google.api.services.calendar.model.AclRule | AclRule
-| list | *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. | String
-| patch | *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. | String
-| patch | *content* | The com.google.api.services.calendar.model.AclRule | AclRule
-| patch | *ruleId* | ACL rule identifier | String
-| update | *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. | String
-| update | *content* | The com.google.api.services.calendar.model.AclRule | AclRule
-| update | *ruleId* | ACL rule identifier | String
-| watch | *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. | String
-| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
-|===
-
-In addition to the parameters above, the acl API can also use from the 31 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelGoogleCalendarStream.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelGoogleCalendarStream.myParameterNameHere` header.
-
-
-
-==== API: calendars
-
-*Only consumer is supported*
-
-
-
-
-The calendars API has 6 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-com.google.api.services.calendar.Calendar.Calendars.Clear clear(String calendarId);
-
-com.google.api.services.calendar.Calendar.Calendars.Delete delete(String calendarId);
-
-com.google.api.services.calendar.Calendar.Calendars.Get get(String calendarId);
-
-com.google.api.services.calendar.Calendar.Calendars.Insert insert(com.google.api.services.calendar.model.Calendar content);
-
-com.google.api.services.calendar.Calendar.Calendars.Patch patch(String calendarId, com.google.api.services.calendar.model.Calendar content);
-
-com.google.api.services.calendar.Calendar.Calendars.Update update(String calendarId, com.google.api.services.calendar.model.Calendar content);
-
-----
-
-The calendars API is defined in the syntax as follows:
-
-----
-google-calendar-stream:calendars/methodName?[parameters]
-----
-
-The 6 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *clear* | | Clears a primary calendar
-| *delete* | | Deletes a secondary calendar
-| *get* | | Returns metadata for a calendar
-| *insert* | | Creates a secondary calendar
-| *patch* | | Updates metadata for a calendar
-| *update* | | Updates metadata for a calendar
-|===
-
-The calendars API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| clear | *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. | String
-| delete | *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. | String
-| get | *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. | String
-| insert | *content* | The com.google.api.services.calendar.model.Calendar | Calendar
-| patch | *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. | String
-| patch | *content* | The com.google.api.services.calendar.model.Calendar | Calendar
-| update | *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. | String
-| update | *content* | The com.google.api.services.calendar.model.Calendar | Calendar
-|===
-
-In addition to the parameters above, the calendars API can also use from the 31 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelGoogleCalendarStream.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelGoogleCalendarStream.myParameterNameHere` header.
-
-
-
-==== API: channels
-
-*Only consumer is supported*
-
-
-
-
-The channels API has 1 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-com.google.api.services.calendar.Calendar.Channels.Stop stop(com.google.api.services.calendar.model.Channel content);
-
-----
-
-The channels API is defined in the syntax as follows:
-
-----
-google-calendar-stream:channels/methodName?[parameters]
-----
-
-The 1 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *stop* | | Stop watching resources through this channel
-|===
-
-The channels API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| stop | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
-|===
-
-In addition to the parameters above, the channels API can also use from the 31 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelGoogleCalendarStream.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelGoogleCalendarStream.myParameterNameHere` header.
-
-
-
-==== API: events
-
-*Only consumer is supported*
-
-
-
-
-The events API has 11 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-com.google.api.services.calendar.Calendar.Events.CalendarImport calendarImport(String calendarId, com.google.api.services.calendar.model.Event content);
-
-com.google.api.services.calendar.Calendar.Events.Delete delete(String calendarId, String eventId);
-
-com.google.api.services.calendar.Calendar.Events.Get get(String calendarId, String eventId);
-
-com.google.api.services.calendar.Calendar.Events.Insert insert(String calendarId, com.google.api.services.calendar.model.Event content);
-
-com.google.api.services.calendar.Calendar.Events.Instances instances(String calendarId, String eventId);
-
-com.google.api.services.calendar.Calendar.Events.List list(String calendarId);
-
-com.google.api.services.calendar.Calendar.Events.Move move(String calendarId, String eventId, String destination);
-
-com.google.api.services.calendar.Calendar.Events.Patch patch(String calendarId, String eventId, com.google.api.services.calendar.model.Event content);
-
-com.google.api.services.calendar.Calendar.Events.QuickAdd quickAdd(String calendarId, String text);
-
-com.google.api.services.calendar.Calendar.Events.Update update(String calendarId, String eventId, com.google.api.services.calendar.model.Event content);
-
-com.google.api.services.calendar.Calendar.Events.Watch watch(String calendarId, com.google.api.services.calendar.model.Channel content);
-
-----
-
-The events API is defined in the syntax as follows:
-
-----
-google-calendar-stream:events/methodName?[parameters]
-----
-
-The 11 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *calendarImport* | | Imports an event
-| *delete* | | Deletes an event
-| *get* | | Returns an event
-| *insert* | | Creates an event
-| *instances* | | Returns instances of the specified recurring event
-| *list* | | Returns events on the specified calendar
-| *move* | | Moves an event to another calendar, i
-| *patch* | | Updates an event
-| *quickAdd* | | Creates an event based on a simple text string
-| *update* | | Updates an event
-| *watch* | | Watch for changes to Events resources
-|===
-
-The events API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| calendarImport | *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. | String
-| calendarImport | *content* | The com.google.api.services.calendar.model.Event | Event
-| delete | *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. | String
-| delete | *eventId* | Event identifier | String
-| get | *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. | String
-| get | *eventId* | Event identifier | String
-| insert | *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. | String
-| insert | *content* | The com.google.api.services.calendar.model.Event | Event
-| instances | *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. | String
-| instances | *eventId* | Recurring event identifier | String
-| list | *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. | String
-| move | *calendarId* | Calendar identifier of the source calendar where the event currently is on | String
-| move | *destination* | Calendar identifier of the target calendar where the event is to be moved to | String
-| move | *eventId* | Event identifier | String
-| patch | *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. | String
-| patch | *content* | The com.google.api.services.calendar.model.Event | Event
-| patch | *eventId* | Event identifier | String
-| quickAdd | *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. | String
-| quickAdd | *text* | The text describing the event to be created | String
-| update | *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. | String
-| update | *content* | The com.google.api.services.calendar.model.Event | Event
-| update | *eventId* | Event identifier | String
-| watch | *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. | String
-| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
-|===
-
-In addition to the parameters above, the events API can also use from the 31 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelGoogleCalendarStream.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelGoogleCalendarStream.myParameterNameHere` header.
-
-
-
-==== API: freebusy
-
-*Only consumer is supported*
-
-
-
-
-The freebusy API has 1 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-com.google.api.services.calendar.Calendar.Freebusy.Query query(com.google.api.services.calendar.model.FreeBusyRequest content);
-
-----
-
-The freebusy API is defined in the syntax as follows:
-
-----
-google-calendar-stream:freebusy/methodName?[parameters]
-----
-
-The 1 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *query* | | Returns free/busy information for a set of calendars
-|===
-
-The freebusy API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| query | *content* | The com.google.api.services.calendar.model.FreeBusyRequest | FreeBusyRequest
-|===
-
-In addition to the parameters above, the freebusy API can also use from the 31 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelGoogleCalendarStream.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelGoogleCalendarStream.myParameterNameHere` header.
-
-
-
-==== API: list
-
-*Only consumer is supported*
-
-
-
-
-The list API has 6 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-com.google.api.services.calendar.Calendar.CalendarList.Delete delete(String calendarId);
-
-com.google.api.services.calendar.Calendar.CalendarList.Get get(String calendarId);
-
-com.google.api.services.calendar.Calendar.CalendarList.Insert insert(com.google.api.services.calendar.model.CalendarListEntry content);
-
-com.google.api.services.calendar.Calendar.CalendarList.Patch patch(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content);
-
-com.google.api.services.calendar.Calendar.CalendarList.Update update(String calendarId, com.google.api.services.calendar.model.CalendarListEntry content);
-
-com.google.api.services.calendar.Calendar.CalendarList.Watch watch(com.google.api.services.calendar.model.Channel content);
-
-----
-
-The list API is defined in the syntax as follows:
-
-----
-google-calendar-stream:list/methodName?[parameters]
-----
-
-The 6 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *delete* | | Deletes an entry on the user's calendar list
-| *get* | | Returns an entry on the user's calendar list
-| *insert* | | Adds an entry to the user's calendar list
-| *patch* | | Updates an entry on the user's calendar list
-| *update* | | Updates an entry on the user's calendar list
-| *watch* | | Watch for changes to CalendarList resources
-|===
-
-The list API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| delete | *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. | String
-| get | *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. | String
-| insert | *content* | The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
-| patch | *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. | String
-| patch | *content* | The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
-| update | *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. | String
-| update | *content* | The com.google.api.services.calendar.model.CalendarListEntry | CalendarListEntry
-| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
-|===
-
-In addition to the parameters above, the list API can also use from the 31 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelGoogleCalendarStream.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelGoogleCalendarStream.myParameterNameHere` header.
-
-
-
-==== API: settings
-
-*Only consumer is supported*
-
-
-
-
-The settings API has 2 method(s) which is represented by the following method signatures
-(an API method may have multiple signatures due to overloading):
-
-[source,java]
-----
-
-com.google.api.services.calendar.Calendar.Settings.Get get(String setting);
-
-com.google.api.services.calendar.Calendar.Settings.Watch watch(com.google.api.services.calendar.model.Channel content);
-
-----
-
-The settings API is defined in the syntax as follows:
-
-----
-google-calendar-stream:settings/methodName?[parameters]
-----
-
-The 2 method(s) is listed in the table below.
-(API methods can have a shorthand alias name which can be used in the syntax instead of the name)
-
-[width="100%",cols="2,2,6",options="header"]
-|===
-| Method | Alias | Description
-| *get* | | Returns a single user setting
-| *watch* | | Watch for changes to Settings resources
-|===
-
-The settings API method(s) has the following set of parameters listed in the table below:
-[width="100%",cols="2,2,4,2",options="header"]
-|===
-| Method | Parameter | Description | Type
-| get | *setting* | The id of the user setting | String
-| watch | *contentChannel* | The com.google.api.services.calendar.model.Channel | Channel
-|===
-
-In addition to the parameters above, the settings API can also use from the 31 endpoint query option
-which is listed in the _Query Parameters_ section.
-
-Any of the parameters can be provided in either the endpoint URI, or dynamically in a message header.
-The message header name must be of the format `CamelGoogleCalendarStream.parameter`.
-The `inBody` parameter overrides message header, i.e. the endpoint parameter `inBody=myParameterNameHere`
-would override a `CamelGoogleCalendarStream.myParameterNameHere` header.
-// endpoint options: END
-
-
-
include::camel-spring-boot::page$google-calendar-starter.adoc[]