Google Calendar Connector 1.0 Reference
Anypoint Connector for Google Calendar (Google Calendar Connector) enables you to interface with the Google Calendar service without having to interact with the Google Calendar API directly.
Configurations
Config
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Name |
String |
The name for this configuration. Connectors reference the configuration with this name. |
x |
|
Connection |
The connection types to provide to this configuration. |
x |
||
Response Timeout |
Number |
The timeout for request to the remote service. |
1 |
|
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
MINUTES |
|
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
AUTO |
|
Name |
String |
The identifier of this element used to reference it in other components |
x |
|
Expiration Policy |
Configures the minimum amount of time that a dynamic configuration instance can remain idle before Mule considers it eligible for expiration. This does not mean that the instance expires at the exact moment that it becomes eligible. Mule purges the instances as appropriate. |
Connection Types
Oauth2 Connection Provider
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Default Headers |
Array of Default Header |
|||
Query Parameters |
Array of Default Query Param |
|||
Connection Timeout |
Number |
The timeout for establishing connections to the remote service |
30 |
|
Connection Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Connection Timeout |
SECONDS |
|
Use Persistent Connections |
Boolean |
If false, each connection will be closed after the first request is completed. |
true |
|
Max Connections |
Number |
The maximum number of outbound connections to keep open at the same time |
-1 |
|
Connection Idle Timeout |
Number |
A timeout for how long a connection can remain idle before it is closed |
30 |
|
Connection Idle Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the connection Idle Timeout |
SECONDS |
|
Proxy Config |
Reusable configuration element for outbound connections through a proxy |
|||
Stream Response |
Boolean |
Whether or not received responses should be streamed |
false |
|
Response Buffer Size |
Number |
The space in bytes for the buffer where the HTTP response will be stored. |
-1 |
|
Base Uri |
String |
Parameter base URI. Each instance/tenant gets its own |
||
Protocol |
Enumeration, one of:
|
Protocol to use for communication. Valid values are HTTP and HTTPS |
HTTP |
|
TLS Configuration |
||||
Reconnection |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
|||
Consumer Key |
String |
The OAuth consumerKey as registered with the service provider |
x |
|
Consumer Secret |
String |
The OAuth consumerSecret as registered with the service provider |
x |
|
Authorization Url |
String |
The service provider’s authorization endpoint URL |
||
Access Token Url |
String |
The service provider’s accessToken endpoint URL |
||
Scopes |
String |
The OAuth scopes to be requested during the dance. If not provided, this value defaults to those in the annotation. |
https://www.googleapis.com/auth/calendar https://www.googleapis.com/auth/calendar.events https://www.googleapis.com/auth/calendar.events.readonly https://www.googleapis.com/auth/calendar.readonly https://www.googleapis.com/auth/calendar.settings.readonly |
|
Resource Owner Id |
String |
The resourceOwnerId which each component should use if it doesn’t reference otherwise. |
||
Before |
String |
The name of a flow to execute right before starting the OAuth dance |
||
After |
String |
The name of a flow to execute right after an accessToken has been received |
||
Listener Config |
String |
A reference to an <http:listener-config /> to use to create the listener that will catch the access token callback endpoint. |
x |
|
Callback Path |
String |
The path of the access token callback endpoint |
x |
|
Authorize Path |
String |
The path of the local HTTP endpoint which triggers the OAuth dance |
x |
|
External Callback Url |
String |
If the callback endpoint is behind a proxy or should be accessed through a non direct URL, use this parameter to tell the OAuth provider the URL it should use to access the callback |
||
Object Store |
String |
A reference to the object store that should be used to store each resource owner id’s data. If not specified, runtime will automatically provision the default one. |
Calendars insert
<google-calendar:create-calendars>
Creates a secondary calendar. This operation makes an HTTP POST request to the /calendars endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Calendar Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Acl insert
<google-calendar:create-calendars-acl-by-calendar-id>
Creates an access control rule. This operation makes an HTTP POST request to the /calendars/{calendarId}/acl endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Send Notifications |
Boolean |
Whether to send notifications about the calendar sharing change. Optional. The default is True. |
false |
|
Acl Rule Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Acl watch
<google-calendar:create-calendars-acl-watch-by-calendar-id>
Watch for changes to ACL resources. This operation makes an HTTP POST request to the /calendars/{calendarId}/acl/watch endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Max Results |
Number |
Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Page Token |
String |
Token specifying which result page to return. Optional. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Show Deleted |
Boolean |
Whether to include deleted ACLs in the result. Deleted ACLs are represented by a role equal to "none". Deleted ACLs are always included if the syncToken is provided. Optional. |
false |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Sync Token |
String |
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All entries deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. The default is to return all entries. |
||
Channel Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendars clear
<google-calendar:create-calendars-clear-by-calendar-id>
Clears a primary calendar. This operation deletes all events associated with the primary calendar of an account. This operation makes an HTTP POST request to the /calendars/{calendarId}/clear endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events insert
<google-calendar:create-calendars-events-by-calendar-id>
Creates an event. This operation makes an HTTP POST request to the /calendars/{calendarId}/events endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Send Updates |
Enumeration, one of:
|
Whether to send notifications about the creation of the new event. Note that some emails might still be sent. The default is false. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Conference Data Version |
Number |
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. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Supports Attachments |
Boolean |
Whether API client performing operation supports event attachments. Optional. The default is False. |
false |
|
Max Attendees |
Number |
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. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Event Request Insert Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events import
<google-calendar:create-calendars-events-import-by-calendar-id>
Imports an event. This operation is used to add a private copy of an existing event to a calendar. This operation makes an HTTP POST request to the /calendars/{calendarId}/events/import endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Conference Data Version |
Number |
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 ConferenceData as well as for creating new conferences using the createRequest field of conferenceData. The default is 0. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Supports Attachments |
Boolean |
Whether API client performing operation supports event attachments. Optional. The default is False. |
false |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Event Request Import Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events move
<google-calendar:create-calendars-events-move-by-calendar-id-event-id>
Moves an event to another calendar, which changes an event’s organizer. This operation makes an HTTP POST request to the /calendars/{calendarId}/events/{eventId}/move endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
Calendar identifier of the source calendar where the event currently is on. |
x |
|
Event Id |
String |
Event identifier. |
x |
|
Send Updates |
Enumeration, one of:
|
Guests who should receive notifications about the change of the event’s organizer. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
destination |
String |
Calendar identifier of the target calendar where the event is to be moved to. |
x |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events quick Add
<google-calendar:create-calendars-events-quick-add-by-calendar-id>
Creates an event based on a simple text string. This operation makes an HTTP POST request to the /calendars/{calendarId}/events/quickAdd endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Send Updates |
Enumeration, one of:
|
Guests who should receive notifications about the creation of the new event. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
text |
String |
The text describing the event to be created. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events watch
<google-calendar:create-calendars-events-watch-by-calendar-id>
Watch for changes to Events resources. This operation makes an HTTP POST request to the /calendars/{calendarId}/events/watch endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Time Min |
String |
Lower bound (exclusive) 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. |
||
iCalUID |
String |
Specifies the event ID in the iCalendar format to be included in the response. Optional. |
||
Private Extended Property |
Array of String |
Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. |
||
Show Hidden Invitations |
Boolean |
Whether to include hidden invitations in the result. Optional. The default is False. |
false |
|
Max Results |
Number |
Maximum number of events returned on one result page. The number of events in the resulting page may be less than this value, or none at all, even if there are more events matching the query. Incomplete pages can be detected by a non-empty nextPageToken field in the response. By default the value is 250 events. The page size can never be larger than 2500 events. Optional. |
||
Shared Extended Property |
Array of String |
Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Page Token |
String |
Token specifying which result page to return. Optional. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Updated Min |
String |
Lower bound for an event’s last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. |
||
Show Deleted |
Boolean |
Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. |
false |
|
Max Attendees |
Number |
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. |
||
q |
String |
Free text search terms to find events that match these terms in any field, except for extended properties. Optional. |
||
Single Events |
Boolean |
Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. |
false |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Order By |
Enumeration, one of:
|
The order of the events returned in the result. Optional. The default is an unspecified, stable order. |
||
Sync Token |
String |
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. All events deleted since the previous list request will always be in the result set and it is not allowed to set showDeleted to False. The following query parameters cannot be specified together with nextSyncToken to ensure consistency of the client state: iCalUID, orderBy, privateExtendedProperty, q, sharedExtendedProperty, timeMin, timeMax, and updatedMin. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. Optional. The default is to return all entries. |
||
Time Zone |
String |
Time zone used in the response. Optional. The default is the time zone of the calendar. |
||
Time Max |
String |
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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. |
||
Channel Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Channels stop
<google-calendar:create-channels-stop>
Stop watching resources through this channel This operation makes an HTTP POST request to the /channels/stop endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Channel Request Stop Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Freebusy query
<google-calendar:create-free-busy>
Returns free/busy information for a set of calendars. This operation makes an HTTP POST request to the /freeBusy endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Free Busy Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendar List insert
<google-calendar:create-users-me-calendar-list>
Inserts an existing calendar into the user''s calendar list. This operation makes an HTTP POST request to the /users/me/calendarList endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Color Rgb Format |
Boolean |
Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. |
false |
|
Calendar List Entry Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendar List watch
<google-calendar:create-users-me-calendar-list-watch>
Watch for changes to CalendarList resources. This operation makes an HTTP POST request to the /users/me/calendarList/watch endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Max Results |
Number |
Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Page Token |
String |
Token specifying which result page to return. Optional. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Show Deleted |
Boolean |
Whether to include deleted calendar list entries in the result. Optional. The default is False. |
false |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Min Access Role |
Enumeration, one of:
|
The minimum access role for the user in the returned entries. Optional. The default is no restriction. |
||
Sync Token |
String |
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If only read-only fields such as calendar properties or ACLs have changed, the entry won’t be returned. All entries deleted and hidden since the previous list request will always be in the result set and it is not allowed to set showDeleted neither showHidden to False. To ensure client state consistency minAccessRole query parameter cannot be specified together with nextSyncToken. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. The default is to return all entries. |
||
Show Hidden |
Boolean |
Whether to show hidden entries. Optional. The default is False. |
false |
|
Channel Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Settings watch
<google-calendar:create-users-me-settings-watch>
Watch for changes to Settings resources. This operation makes an HTTP POST request to the /users/me/settings/watch endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Max Results |
Number |
Maximum number of entries returned on one result page. By default the value is 100 entries. The page size can never be larger than 250 entries. Optional. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Page Token |
String |
Token specifying which result page to return. Optional. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Sync Token |
String |
Token obtained from the nextSyncToken field returned on the last page of results from the previous list request. It makes the result of this list request contain only entries that have changed since then. If the syncToken expires, the server will respond with a 410 GONE response code and the client should clear its storage and perform a full synchronization without any syncToken. The default is to return all entries. |
||
Channel Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Acl delete
<google-calendar:delete-calendars-acl-by-calendar-id-rule-id>
Deletes an access control rule. This operation makes an HTTP DELETE request to the /calendars/{calendarId}/acl/{ruleId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Rule Id |
String |
ACL rule identifier. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendars delete
<google-calendar:delete-calendars-by-calendar-id>
Deletes a secondary calendar. Use calendars.clear for clearing all events on primary calendars. This operation makes an HTTP DELETE request to the /calendars/{calendarId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events delete
<google-calendar:delete-calendars-events-by-calendar-id-event-id>
Deletes an event. This operation makes an HTTP DELETE request to the /calendars/{calendarId}/events/{eventId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Event Id |
String |
Event identifier. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Send Updates |
Enumeration, one of:
|
Guests who should receive notifications about the deletion of the event. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendar List delete
<google-calendar:delete-users-me-calendar-list-by-calendar-id>
Removes a calendar from the user''s calendar list. This operation makes an HTTP DELETE request to the /users/me/calendarList/{calendarId} endpoint
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Acl list
<google-calendar:get-calendars-acl-by-calendar-id>
Returns the rules in the access control list for the calendar. This operation makes an HTTP GET request to the /calendars/{calendarId}/acl endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Show Deleted |
Boolean |
Whether to include deleted ACLs in the result. Deleted ACLs are represented by role equal to "none". Deleted ACLs will always be included if syncToken is provided. Optional. The default is False. |
false |
|
fields |
String |
Selector specifying which fields from items to include in a partial response. If empty, all fields will be returned. Fields must be written in parentheses, for example, items(id,organizer/displayName). |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Acl get
<google-calendar:get-calendars-acl-by-calendar-id-rule-id>
Returns an access control rule. This operation makes an HTTP GET request to the /calendars/{calendarId}/acl/{ruleId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Rule Id |
String |
ACL rule identifier. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendars get
<google-calendar:get-calendars-by-calendar-id>
Returns metadata for a calendar. This operation makes an HTTP GET request to the /calendars/{calendarId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events list
<google-calendar:get-calendars-events-by-calendar-id>
Returns events on the specified calendar. This operation makes an HTTP GET request to the /calendars/{calendarId}/events endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Time Min |
String |
Lower bound (exclusive) 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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMax is set, timeMin must be smaller than timeMax. |
||
iCalUID |
String |
Specifies the event ID in the iCalendar format to be included in the response. Optional. |
||
Private Extended Property |
Array of String |
Extended properties constraint specified as propertyName=value. Matches only private properties. This parameter might be repeated multiple times to return events that match all given constraints. |
||
Show Hidden Invitations |
Boolean |
Whether to include hidden invitations in the result. Optional. The default is False. |
false |
|
Shared Extended Property |
Array of String |
Extended properties constraint specified as propertyName=value. Matches only shared properties. This parameter might be repeated multiple times to return events that match all given constraints. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Updated Min |
String |
Lower bound for an event’s last modification time (as a RFC3339 timestamp) to filter by. When specified, entries deleted since this time will always be included regardless of showDeleted. Optional. The default is not to filter by last modification time. |
||
Show Deleted |
Boolean |
Whether to include deleted events (with status equals "cancelled") in the result. Cancelled instances of recurring events (but not the underlying recurring event) will still be included if showDeleted and singleEvents are both False. If showDeleted and singleEvents are both True, only single instances of deleted events (but not the underlying recurring events) are returned. Optional. The default is False. |
false |
|
Max Attendees |
Number |
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. |
||
q |
String |
Free text search terms to find events that match these terms in any field, except for extended properties. Optional. |
||
Single Events |
Boolean |
Whether to expand recurring events into instances and only return single one-off events and instances of recurring events, but not the underlying recurring events themselves. Optional. The default is False. |
false |
|
fields |
String |
Selector specifying which fields from items to include in a partial response. If empty, all fields will be returned. Fields must be written in parentheses, for example, items(id,organizer/displayName). |
||
Order By |
Enumeration, one of:
|
The order of the events returned in the result. Optional. The default is an unspecified, stable order. |
||
Time Zone |
String |
Time zone used in the response. Optional. The default is the time zone of the calendar. |
||
Time Max |
String |
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, for example, 2011-06-03T10:00:00-07:00, 2011-06-03T10:00:00Z. Milliseconds may be provided but are ignored. If timeMin is set, timeMax must be greater than timeMin. |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events get
<google-calendar:get-calendars-events-by-calendar-id-event-id>
Returns an event. This operation makes an HTTP GET request to the /calendars/{calendarId}/events/{eventId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Event Id |
String |
Event identifier. |
x |
|
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Max Attendees |
Number |
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. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Time Zone |
String |
Time zone used in the response. Optional. The default is the time zone of the calendar. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events instances
<google-calendar:get-calendars-events-instances-by-calendar-id-event-id>
Returns instances of the specified recurring event. This operation makes an HTTP GET request to the /calendars/{calendarId}/events/{eventId}/instances endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Event Id |
String |
Recurring event identifier. |
x |
|
Time Min |
String |
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. |
||
Max Results |
Number |
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. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Page Token |
String |
Token specifying which result page to return. Optional. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Show Deleted |
Boolean |
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. |
false |
|
Original Start |
String |
The original start time of the instance in the result. Optional. |
||
Max Attendees |
Number |
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. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Time Zone |
String |
Time zone used in the response. Optional. The default is the time zone of the calendar. |
||
Time Max |
String |
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. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Colors get
<google-calendar:get-colors>
Returns the color definitions for calendars and events. This operation makes an HTTP GET request to the /colors endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendar List list
<google-calendar:get-users-me-calendar-list>
Returns the calendars on the user''s calendar list. This operation makes an HTTP GET request to the /users/me/calendarList endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Show Deleted |
Boolean |
Whether to include deleted calendar list entries in the result. Optional. The default is False. |
false |
|
fields |
String |
Selector specifying which fields from items to include in a partial response. If empty, all fields will be returned. Fields must be written in parentheses, for example, items(id,organizer/displayName). |
||
Min Access Role |
Enumeration, one of:
|
The minimum access role for the user in the returned entries. Optional. The default is no restriction. |
||
Show Hidden |
Boolean |
Whether to show hidden entries. Optional. The default is False. |
false |
|
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendar List get
<google-calendar:get-users-me-calendar-list-by-calendar-id>
Returns a calendar from the user''s calendar list. This operation makes an HTTP GET request to the /users/me/calendarList/{calendarId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Settings list
<google-calendar:get-users-me-settings>
Returns all user settings for the authenticated user. This operation makes an HTTP GET request to the /users/me/settings endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields from items to include in a partial response. If empty, all fields will be returned. Fields must be written in parentheses, for example, items(id,organizer/displayName). |
||
Output Mime Type |
String |
The MIME type of the payload that this operation outputs. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Settings get
<google-calendar:get-users-me-settings-by-setting>
Returns a single user setting. This operation makes an HTTP GET request to the /users/me/settings/{setting} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
setting |
String |
The ID of the user setting. |
x |
|
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
#[null] |
||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Acl patch
<google-calendar:patch-calendars-acl-by-calendar-id-rule-id>
Updates an access control rule. This method supports patch semantics. This operation makes an HTTP PATCH request to the /calendars/{calendarId}/acl/{ruleId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Rule Id |
String |
ACL rule identifier. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Send Notifications |
Boolean |
Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. |
false |
|
Acl Rule Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendars patch
<google-calendar:patch-calendars-by-calendar-id>
Updates metadata for a calendar. This method supports patch semantics. This operation makes an HTTP PATCH request to the /calendars/{calendarId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Calendar Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events patch
<google-calendar:patch-calendars-events-by-calendar-id-event-id>
Updates an event. This method supports patch semantics. This operation makes an HTTP PATCH request to the /calendars/{calendarId}/events/{eventId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Event Id |
String |
Event identifier. |
x |
|
Send Updates |
Enumeration, one of:
|
Guests who should receive notifications about the event update (for example, title changes, etc.). |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Conference Data Version |
Number |
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. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Supports Attachments |
Boolean |
Whether API client performing operation supports event attachments. Optional. The default is False. |
false |
|
Max Attendees |
Number |
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. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Event Request Update Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendar List patch
<google-calendar:patch-users-me-calendar-list-by-calendar-id>
Updates an existing calendar on the user''s calendar list. This method supports patch semantics. This operation makes an HTTP PATCH request to the /users/me/calendarList/{calendarId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Color Rgb Format |
Boolean |
Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. |
false |
|
Calendar List Entry Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Unauthorize
<google-calendar:unauthorize>
Deletes all the access token information of a given resource owner ID so that it’s impossible to execute any operation for that user without doing the authorization dance again.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Resource Owner Id |
String |
The ID of the resource owner which access should be invalidated |
||
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
Acl update
<google-calendar:update-calendars-acl-by-calendar-id-rule-id>
Updates an access control rule. This operation makes an HTTP PUT request to the /calendars/{calendarId}/acl/{ruleId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Rule Id |
String |
ACL rule identifier. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Send Notifications |
Boolean |
Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True. |
false |
|
Acl Rule Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendars update
<google-calendar:update-calendars-by-calendar-id>
Updates metadata for a calendar. This operation makes an HTTP PUT request to the /calendars/{calendarId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Calendar Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Events update
<google-calendar:update-calendars-events-by-calendar-id-event-id>
Updates an event. This operation makes an HTTP PUT request to the /calendars/{calendarId}/events/{eventId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Event Id |
String |
Event identifier. |
x |
|
Send Updates |
Enumeration, one of:
|
Guests who should receive notifications about the event update (for example, title changes, etc.). |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Conference Data Version |
Number |
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. |
||
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
Supports Attachments |
Boolean |
Whether API client performing operation supports event attachments. Optional. The default is False. |
false |
|
Max Attendees |
Number |
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. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Event Request Update Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Calendar List update
<google-calendar:update-users-me-calendar-list-by-calendar-id>
Updates an existing calendar on the user''s calendar list. This operation makes an HTTP PUT request to the /users/me/calendarList/{calendarId} endpoint.
Parameters
Name | Type | Description | Default Value | Required |
---|---|---|---|---|
Configuration |
String |
The name of the configuration to use. |
x |
|
Calendar Id |
String |
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. |
x |
|
Quota User |
String |
An opaque string that represents a user for quota purposes. Must not exceed 40 characters. |
||
fields |
String |
Selector specifying which fields to include in a partial response. If empty, all fields will be returned. |
||
Pretty Print |
Boolean |
Returns response with indentations and line breaks. |
false |
|
Color Rgb Format |
Boolean |
Whether to use the foregroundColor and backgroundColor fields to write the calendar colors (RGB). If this feature is used, the index-based colorId field will be set to the best matching option automatically. Optional. The default is False. |
false |
|
Calendar List Entry Request Content |
Any |
The content to use |
#[payload] |
|
Config Ref |
ConfigurationProvider |
The name of the configuration to use to execute this component |
x |
|
Streaming Strategy |
|
Configure if repeatable streams should be used and their behavior |
||
Custom Query Parameters |
Object |
|||
Custom Headers |
Object |
|||
Response Timeout |
Number |
The timeout for request to the remote service. |
||
Response Timeout Unit |
Enumeration, one of:
|
A time unit that qualifies the Response Timeout |
||
Streaming Type |
Enumeration, one of:
|
Defines if the request should be sent using streaming. Setting the value to AUTO will automatically define the best strategy based on the request content. |
||
Target Variable |
String |
The name of a variable to store the operation’s output. |
||
Target Value |
String |
An expression to evaluate against the operation’s output and store the expression outcome in the target variable |
#[payload] |
|
Reconnection Strategy |
A retry strategy in case of connectivity errors |
Throws
-
GOOGLE-CALENDAR:BAD_REQUEST
-
GOOGLE-CALENDAR:CLIENT_ERROR
-
GOOGLE-CALENDAR:CONNECTIVITY
-
GOOGLE-CALENDAR:INTERNAL_SERVER_ERROR
-
GOOGLE-CALENDAR:NOT_ACCEPTABLE
-
GOOGLE-CALENDAR:NOT_FOUND
-
GOOGLE-CALENDAR:RETRY_EXHAUSTED
-
GOOGLE-CALENDAR:SERVER_ERROR
-
GOOGLE-CALENDAR:SERVICE_UNAVAILABLE
-
GOOGLE-CALENDAR:TIMEOUT
-
GOOGLE-CALENDAR:TOO_MANY_REQUESTS
-
GOOGLE-CALENDAR:UNAUTHORIZED
-
GOOGLE-CALENDAR:UNSUPPORTED_MEDIA_TYPE
Types
Proxy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Host |
String |
x |
||
Port |
Number |
x |
||
Username |
String |
|||
Password |
String |
|||
Non Proxy Hosts |
String |
Tls
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Enabled Protocols |
String |
A comma-separated list of protocols enabled for this context. |
||
Enabled Cipher Suites |
String |
A comma-separated list of cipher suites enabled for this context. |
||
Trust Store |
||||
Key Store |
||||
Revocation Check |
Trust Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the trust store. |
||
Password |
String |
The password used to protect the trust store. |
||
Type |
String |
The type of store used. |
||
Algorithm |
String |
The algorithm used by the trust store. |
||
Insecure |
Boolean |
If true, no certificate validations will be performed, rendering connections vulnerable to attacks. Use at your own risk. |
Key Store
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Path |
String |
The location (which will be resolved relative to the current classpath and file system, if possible) of the key store. |
||
Type |
String |
The type of store used. |
||
Alias |
String |
When the key store contains many private keys, this attribute indicates the alias of the key that should be used. If not defined, the first key in the file will be used by default. |
||
Key Password |
String |
The password used to protect the private key. |
||
Password |
String |
The password used to protect the key store. |
||
Algorithm |
String |
The algorithm used by the key store. |
Standard Revocation Check
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Only End Entities |
Boolean |
Only verify the last element of the certificate chain. |
||
Prefer Crls |
Boolean |
Try CRL instead of OCSP first. |
||
No Fallback |
Boolean |
Do not use the secondary checking method (the one not selected before). |
||
Soft Fail |
Boolean |
Avoid verification failure when the revocation server can not be reached or is busy. |
Custom Ocsp Responder
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Url |
String |
The URL of the OCSP responder. |
||
Cert Alias |
String |
Alias of the signing certificate for the OCSP response (must be in the trust store), if present. |
Reconnection
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Fails Deployment |
Boolean |
When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy. |
||
Reconnection Strategy |
The reconnection strategy to use. |
Reconnect
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
||
Count |
Number |
How many reconnection attempts to make. |
Reconnect Forever
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Frequency |
Number |
How often in milliseconds to reconnect |
||
Blocking |
Boolean |
If false, the reconnection strategy will run in a separate, non-blocking thread |
Expiration Policy
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Max Idle Time |
Number |
A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration |
||
Time Unit |
Enumeration, one of:
|
A time unit that qualifies the maxIdleTime attribute |
Http Response Attributes
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Status Code |
Number |
x |
||
Headers |
Object |
x |
||
Reason Phrase |
String |
x |
Repeatable In Memory Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The amount of memory that will be allocated to consume the stream and provide random access to it. If the stream contains more data than can be fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which all these attributes are expressed |
Repeatable File Store Stream
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Size |
Number |
Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |
Repeatable In Memory Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
Initial Buffer Size |
Number |
The number of instances to initially keep in memory to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, then the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize. Default value is 100 instances. |
||
Buffer Size Increment |
Number |
This is by how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full. Default value is 100 instances. |
||
Max Buffer Size |
Number |
The maximum amount of memory to use. If more than that is used then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower than or equal to zero means no limit. |
Repeatable File Store Iterable
Field | Type | Description | Default Value | Required |
---|---|---|---|---|
In Memory Objects |
Number |
The maximum amount of instances to keep in memory. If more than that is required, content on the disk is buffered. |
||
Buffer Unit |
Enumeration, one of:
|
The unit in which maxInMemorySize is expressed |