docs: update docs/dyn (#1096)
This PR was generated using Autosynth. :rainbow:
Synth log will be available here:
https://source.cloud.google.com/results/invocations/6f0f288a-a1e8-4b2d-a85f-00b1c6150185/targets
- [ ] To automatically regenerate this PR, check this box.
Source-Link: https://github.com/googleapis/synthtool/commit/39b7149da4026765385403632db3c6f63db96b2c
Source-Link: https://github.com/googleapis/synthtool/commit/9a7d9fbb7045c34c9d3d22c1ff766eeae51f04c9
Source-Link: https://github.com/googleapis/synthtool/commit/dc9903a8c30c3662b6098f0e4a97f221d67268b2
Source-Link: https://github.com/googleapis/synthtool/commit/7fcc405a579d5d53a726ff3da1b7c8c08f0f2d58
Source-Link: https://github.com/googleapis/synthtool/commit/d5fc0bcf9ea9789c5b0e3154a9e3b29e5cea6116
Source-Link: https://github.com/googleapis/synthtool/commit/e89175cf074dccc4babb4eca66ae913696e47a71
Source-Link: https://github.com/googleapis/synthtool/commit/7d652819519dfa24da9e14548232e4aaba71a11c
Source-Link: https://github.com/googleapis/synthtool/commit/7db8a6c5ffb12a6e4c2f799c18f00f7f3d60e279
Source-Link: https://github.com/googleapis/synthtool/commit/1f1148d3c7a7a52f0c98077f976bd9b3c948ee2b
Source-Link: https://github.com/googleapis/synthtool/commit/2c8aecedd55b0480fb4e123b6e07fa5b12953862
Source-Link: https://github.com/googleapis/synthtool/commit/3d3e94c4e02370f307a9a200b0c743c3d8d19f29
Source-Link: https://github.com/googleapis/synthtool/commit/c7824ea48ff6d4d42dfae0849aec8a85acd90bd9
Source-Link: https://github.com/googleapis/synthtool/commit/ba9918cd22874245b55734f57470c719b577e591
Source-Link: https://github.com/googleapis/synthtool/commit/b19b401571e77192f8dd38eab5fb2300a0de9324
Source-Link: https://github.com/googleapis/synthtool/commit/6542bd723403513626f61642fc02ddca528409aa
diff --git a/docs/dyn/calendar_v3.acl.html b/docs/dyn/calendar_v3.acl.html
index 5c0ab2a..cea34bf 100644
--- a/docs/dyn/calendar_v3.acl.html
+++ b/docs/dyn/calendar_v3.acl.html
@@ -87,7 +87,7 @@
<code><a href="#insert">insert(calendarId, body=None, sendNotifications=None)</a></code></p>
<p class="firstline">Creates an access control rule.</p>
<p class="toc_element">
- <code><a href="#list">list(calendarId, maxResults=None, pageToken=None, syncToken=None, showDeleted=None)</a></code></p>
+ <code><a href="#list">list(calendarId, pageToken=None, maxResults=None, syncToken=None, showDeleted=None)</a></code></p>
<p class="firstline">Returns the rules in the access control list for the calendar.</p>
<p class="toc_element">
<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
@@ -99,7 +99,7 @@
<code><a href="#update">update(calendarId, ruleId, body=None, sendNotifications=None)</a></code></p>
<p class="firstline">Updates an access control rule.</p>
<p class="toc_element">
- <code><a href="#watch">watch(calendarId, body=None, pageToken=None, maxResults=None, syncToken=None, showDeleted=None)</a></code></p>
+ <code><a href="#watch">watch(calendarId, body=None, pageToken=None, syncToken=None, maxResults=None, showDeleted=None)</a></code></p>
<p class="firstline">Watch for changes to ACL resources.</p>
<h3>Method Details</h3>
<div class="method">
@@ -129,24 +129,24 @@
An object of the form:
{
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "etag": "A String", # ETag of the resource.
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- }</pre>
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "id": "A String", # Identifier of the ACL rule.
+ "etag": "A String", # ETag of the resource.
+ }</pre>
</div>
<div class="method">
@@ -159,13 +159,32 @@
The object takes the form of:
{
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "id": "A String", # Identifier of the ACL rule.
+ "etag": "A String", # ETag of the resource.
+}
+
+ sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"scope": { # The scope of the rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
@@ -174,44 +193,25 @@
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "id": "A String", # Identifier of the ACL rule.
"etag": "A String", # ETag of the resource.
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- }
-
- sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Optional. The default is True.
-
-Returns:
- An object of the form:
-
- {
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "etag": "A String", # ETag of the resource.
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- }</pre>
+ }</pre>
</div>
<div class="method">
- <code class="details" id="list">list(calendarId, maxResults=None, pageToken=None, syncToken=None, showDeleted=None)</code>
+ <code class="details" id="list">list(calendarId, pageToken=None, maxResults=None, syncToken=None, showDeleted=None)</code>
<pre>Returns the rules in the access control list for the calendar.
Args:
calendarId: 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. (required)
- maxResults: integer, 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.
pageToken: string, Token specifying which result page to return. Optional.
+ maxResults: integer, 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.
syncToken: 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.
Learn more about incremental synchronization.
@@ -222,31 +222,31 @@
An object of the form:
{
- "etag": "A String", # ETag of the collection.
+ "kind": "calendar#acl", # Type of the collection ("calendar#acl").
"items": [ # List of rules on the access control list.
{
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "etag": "A String", # ETag of the resource.
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "id": "A String", # Identifier of the ACL rule.
+ "etag": "A String", # ETag of the resource.
+ },
],
- "kind": "calendar#acl", # Type of the collection ("calendar#acl").
"nextSyncToken": "A String", # Token used at a later point in time to retrieve only the entries that have changed since this result was returned. Omitted if further results are available, in which case nextPageToken is provided.
"nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available, in which case nextSyncToken is provided.
+ "etag": "A String", # ETag of the collection.
}</pre>
</div>
@@ -275,13 +275,32 @@
The object takes the form of:
{
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "id": "A String", # Identifier of the ACL rule.
+ "etag": "A String", # ETag of the resource.
+}
+
+ sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"scope": { # The scope of the rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
@@ -290,34 +309,15 @@
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "id": "A String", # Identifier of the ACL rule.
"etag": "A String", # ETag of the resource.
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- }
-
- sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
-
-Returns:
- An object of the form:
-
- {
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "etag": "A String", # ETag of the resource.
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- }</pre>
+ }</pre>
</div>
<div class="method">
@@ -331,13 +331,32 @@
The object takes the form of:
{
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
+ "scope": { # The scope of the rule.
+ "type": "A String", # The type of the scope. Possible values are:
+ # - "default" - The public scope. This is the default value.
+ # - "user" - Limits the scope to a single user.
+ # - "group" - Limits the scope to a group.
+ # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
+ "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
+ },
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "id": "A String", # Identifier of the ACL rule.
+ "etag": "A String", # ETag of the resource.
+}
+
+ sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
+
+Returns:
+ An object of the form:
+
+ {
+ "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
"scope": { # The scope of the rule.
"type": "A String", # The type of the scope. Possible values are:
# - "default" - The public scope. This is the default value.
@@ -346,38 +365,19 @@
# - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
"value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
},
+ "role": "A String", # The role assigned to the scope. Possible values are:
+ # - "none" - Provides no access.
+ # - "freeBusyReader" - Provides read access to free/busy information.
+ # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
+ # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
+ # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
+ "id": "A String", # Identifier of the ACL rule.
"etag": "A String", # ETag of the resource.
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- }
-
- sendNotifications: boolean, Whether to send notifications about the calendar sharing change. Note that there are no notifications on access removal. Optional. The default is True.
-
-Returns:
- An object of the form:
-
- {
- "role": "A String", # The role assigned to the scope. Possible values are:
- # - "none" - Provides no access.
- # - "freeBusyReader" - Provides read access to free/busy information.
- # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.
- # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.
- # - "owner" - Provides ownership of the calendar. This role has all of the permissions of the writer role with the additional ability to see and manipulate ACLs.
- "id": "A String", # Identifier of the ACL rule.
- "scope": { # The scope of the rule.
- "type": "A String", # The type of the scope. Possible values are:
- # - "default" - The public scope. This is the default value.
- # - "user" - Limits the scope to a single user.
- # - "group" - Limits the scope to a group.
- # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.
- "value": "A String", # The email address of a user or group, or the name of a domain, depending on the scope type. Omitted for type "default".
- },
- "etag": "A String", # ETag of the resource.
- "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").
- }</pre>
+ }</pre>
</div>
<div class="method">
- <code class="details" id="watch">watch(calendarId, body=None, pageToken=None, maxResults=None, syncToken=None, showDeleted=None)</code>
+ <code class="details" id="watch">watch(calendarId, body=None, pageToken=None, syncToken=None, maxResults=None, showDeleted=None)</code>
<pre>Watch for changes to ACL resources.
Args:
@@ -386,44 +386,44 @@
The object takes the form of:
{
- "id": "A String", # A UUID or similar unique string that identifies this channel.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
"address": "A String", # The address where notifications are delivered for this channel.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
- "resourceUri": "A String", # A version-specific identifier for the watched resource.
- "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
- "type": "A String", # The type of delivery mechanism used for this channel.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
+ "type": "A String", # The type of delivery mechanism used for this channel.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
}
pageToken: string, Token specifying which result page to return. Optional.
- maxResults: integer, 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.
syncToken: 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.
Learn more about incremental synchronization.
Optional. The default is to return all entries.
+ maxResults: integer, 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.
showDeleted: 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.
Returns:
An object of the form:
{
- "id": "A String", # A UUID or similar unique string that identifies this channel.
+ "resourceUri": "A String", # A version-specific identifier for the watched resource.
"address": "A String", # The address where notifications are delivered for this channel.
"payload": True or False, # A Boolean value to indicate whether payload is wanted. Optional.
"expiration": "A String", # Date and time of notification channel expiration, expressed as a Unix timestamp, in milliseconds. Optional.
- "resourceUri": "A String", # A version-specific identifier for the watched resource.
- "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
- "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
"token": "A String", # An arbitrary string delivered to the target address with each notification delivered over this channel. Optional.
- "type": "A String", # The type of delivery mechanism used for this channel.
+ "id": "A String", # A UUID or similar unique string that identifies this channel.
+ "resourceId": "A String", # An opaque ID that identifies the resource being watched on this channel. Stable across different API versions.
"params": { # Additional parameters controlling delivery channel behavior. Optional.
"a_key": "A String", # Declares a new parameter by name.
},
+ "type": "A String", # The type of delivery mechanism used for this channel.
+ "kind": "api#channel", # Identifies this as a notification channel used to watch for changes to a resource, which is "api#channel".
}</pre>
</div>