| |
| <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> |
| <html><head><title>Python: class Resource</title> |
| </head><body bgcolor="#f0f0f8"> |
| <p> |
| <table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section"> |
| <tr bgcolor="#ffc8d8"> |
| <td colspan=3 valign=bottom> <br> |
| <font color="#000000" face="helvetica, arial"><a name="Resource">class <strong>Resource</strong></a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr> |
| |
| <tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td> |
| <td colspan=2><tt>A class for interacting with a resource.<br> </tt></td></tr> |
| <tr><td> </td> |
| <td width="100%">Methods defined here:<br> |
| <dl><dt><a name="Resource-__init__"><strong>__init__</strong></a>(self)</dt></dl> |
| |
| <dl><dt><a name="Resource-delete"><strong>delete</strong></a> = method(self, **kwargs)</dt><dd><tt>Deletes an access control rule.<br> |
| <br> |
| Args:<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| ruleId: string, ACL rule identifier. (required)<br> |
| calendarId: string, Calendar identifier. (required)<br> |
| userip: string, A parameter<br> |
| strict: string, A parameter</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-get"><strong>get</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns an access control rule.<br> |
| <br> |
| Args:<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| ruleId: string, ACL rule identifier. (required)<br> |
| calendarId: string, Calendar identifier. (required)<br> |
| userip: string, A parameter<br> |
| strict: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "scope": { # The scope of the rule.<br> |
| "type": "A String", # The type of the scope. Possible values are:<br> |
| # - "default" - The public scope. This is the default value.<br> |
| # - "user" - Limits the scope to a single user.<br> |
| # - "group" - Limits the scope to a group.<br> |
| # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.<br> |
| "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".<br> |
| },<br> |
| "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").<br> |
| "etag": "A String", # ETag of the resource.<br> |
| "role": "A String", # The role assigned to the scope. Possible values are:<br> |
| # - "none" - Provides no access.<br> |
| # - "freeBusyReader" - Provides read access to free/busy information.<br> |
| # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br> |
| # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br> |
| # - "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.<br> |
| "id": "A String", # Identifier of the ACL rule.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-insert"><strong>insert</strong></a> = method(self, **kwargs)</dt><dd><tt>Creates an access control rule.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "scope": { # The scope of the rule.<br> |
| "type": "A String", # The type of the scope. Possible values are:<br> |
| # - "default" - The public scope. This is the default value.<br> |
| # - "user" - Limits the scope to a single user.<br> |
| # - "group" - Limits the scope to a group.<br> |
| # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.<br> |
| "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".<br> |
| },<br> |
| "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").<br> |
| "etag": "A String", # ETag of the resource.<br> |
| "role": "A String", # The role assigned to the scope. Possible values are:<br> |
| # - "none" - Provides no access.<br> |
| # - "freeBusyReader" - Provides read access to free/busy information.<br> |
| # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br> |
| # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br> |
| # - "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.<br> |
| "id": "A String", # Identifier of the ACL rule.<br> |
| }<br> |
| <br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| strict: string, A parameter<br> |
| calendarId: string, Calendar identifier. (required)<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "scope": { # The scope of the rule.<br> |
| "type": "A String", # The type of the scope. Possible values are:<br> |
| # - "default" - The public scope. This is the default value.<br> |
| # - "user" - Limits the scope to a single user.<br> |
| # - "group" - Limits the scope to a group.<br> |
| # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.<br> |
| "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".<br> |
| },<br> |
| "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").<br> |
| "etag": "A String", # ETag of the resource.<br> |
| "role": "A String", # The role assigned to the scope. Possible values are:<br> |
| # - "none" - Provides no access.<br> |
| # - "freeBusyReader" - Provides read access to free/busy information.<br> |
| # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br> |
| # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br> |
| # - "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.<br> |
| "id": "A String", # Identifier of the ACL rule.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-list"><strong>list</strong></a> = method(self, **kwargs)</dt><dd><tt>Returns the rules in the access control list for the calendar.<br> |
| <br> |
| Args:<br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| strict: string, A parameter<br> |
| calendarId: string, Calendar identifier. (required)<br> |
| userip: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "nextPageToken": "A String", # Token used to access the next page of this result. Omitted if no further results are available.<br> |
| "items": [ # List of rules on the access control list.<br> |
| {<br> |
| "scope": { # The scope of the rule.<br> |
| "type": "A String", # The type of the scope. Possible values are:<br> |
| # - "default" - The public scope. This is the default value.<br> |
| # - "user" - Limits the scope to a single user.<br> |
| # - "group" - Limits the scope to a group.<br> |
| # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.<br> |
| "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".<br> |
| },<br> |
| "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").<br> |
| "etag": "A String", # ETag of the resource.<br> |
| "role": "A String", # The role assigned to the scope. Possible values are:<br> |
| # - "none" - Provides no access.<br> |
| # - "freeBusyReader" - Provides read access to free/busy information.<br> |
| # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br> |
| # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br> |
| # - "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.<br> |
| "id": "A String", # Identifier of the ACL rule.<br> |
| },<br> |
| ],<br> |
| "kind": "calendar#acl", # Type of the collection ("calendar#acl").<br> |
| "etag": "A String", # ETag of the collection.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-patch"><strong>patch</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an access control rule. This method supports patch semantics.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "scope": { # The scope of the rule.<br> |
| "type": "A String", # The type of the scope. Possible values are:<br> |
| # - "default" - The public scope. This is the default value.<br> |
| # - "user" - Limits the scope to a single user.<br> |
| # - "group" - Limits the scope to a group.<br> |
| # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.<br> |
| "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".<br> |
| },<br> |
| "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").<br> |
| "etag": "A String", # ETag of the resource.<br> |
| "role": "A String", # The role assigned to the scope. Possible values are:<br> |
| # - "none" - Provides no access.<br> |
| # - "freeBusyReader" - Provides read access to free/busy information.<br> |
| # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br> |
| # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br> |
| # - "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.<br> |
| "id": "A String", # Identifier of the ACL rule.<br> |
| }<br> |
| <br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| ruleId: string, ACL rule identifier. (required)<br> |
| calendarId: string, Calendar identifier. (required)<br> |
| userip: string, A parameter<br> |
| strict: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "scope": { # The scope of the rule.<br> |
| "type": "A String", # The type of the scope. Possible values are:<br> |
| # - "default" - The public scope. This is the default value.<br> |
| # - "user" - Limits the scope to a single user.<br> |
| # - "group" - Limits the scope to a group.<br> |
| # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.<br> |
| "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".<br> |
| },<br> |
| "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").<br> |
| "etag": "A String", # ETag of the resource.<br> |
| "role": "A String", # The role assigned to the scope. Possible values are:<br> |
| # - "none" - Provides no access.<br> |
| # - "freeBusyReader" - Provides read access to free/busy information.<br> |
| # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br> |
| # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br> |
| # - "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.<br> |
| "id": "A String", # Identifier of the ACL rule.<br> |
| }</tt></dd></dl> |
| |
| <dl><dt><a name="Resource-update"><strong>update</strong></a> = method(self, **kwargs)</dt><dd><tt>Updates an access control rule.<br> |
| <br> |
| Args:<br> |
| body: object, The request body. (required)<br> |
| The object takes the form of:<br> |
| <br> |
| {<br> |
| "scope": { # The scope of the rule.<br> |
| "type": "A String", # The type of the scope. Possible values are:<br> |
| # - "default" - The public scope. This is the default value.<br> |
| # - "user" - Limits the scope to a single user.<br> |
| # - "group" - Limits the scope to a group.<br> |
| # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.<br> |
| "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".<br> |
| },<br> |
| "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").<br> |
| "etag": "A String", # ETag of the resource.<br> |
| "role": "A String", # The role assigned to the scope. Possible values are:<br> |
| # - "none" - Provides no access.<br> |
| # - "freeBusyReader" - Provides read access to free/busy information.<br> |
| # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br> |
| # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br> |
| # - "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.<br> |
| "id": "A String", # Identifier of the ACL rule.<br> |
| }<br> |
| <br> |
| pp: string, A parameter<br> |
| trace: string, A parameter<br> |
| ruleId: string, ACL rule identifier. (required)<br> |
| calendarId: string, Calendar identifier. (required)<br> |
| userip: string, A parameter<br> |
| strict: string, A parameter<br> |
| <br> |
| Returns:<br> |
| An object of the form<br> |
| <br> |
| {<br> |
| "scope": { # The scope of the rule.<br> |
| "type": "A String", # The type of the scope. Possible values are:<br> |
| # - "default" - The public scope. This is the default value.<br> |
| # - "user" - Limits the scope to a single user.<br> |
| # - "group" - Limits the scope to a group.<br> |
| # - "domain" - Limits the scope to a domain. Note: The permissions granted to the "default", or public, scope apply to any user, authenticated or not.<br> |
| "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".<br> |
| },<br> |
| "kind": "calendar#aclRule", # Type of the resource ("calendar#aclRule").<br> |
| "etag": "A String", # ETag of the resource.<br> |
| "role": "A String", # The role assigned to the scope. Possible values are:<br> |
| # - "none" - Provides no access.<br> |
| # - "freeBusyReader" - Provides read access to free/busy information.<br> |
| # - "reader" - Provides read access to the calendar. Private events will appear to users with reader access, but event details will be hidden.<br> |
| # - "writer" - Provides read and write access to the calendar. Private events will appear to users with writer access, and event details will be visible.<br> |
| # - "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.<br> |
| "id": "A String", # Identifier of the ACL rule.<br> |
| }</tt></dd></dl> |
| |
| <hr> |
| Data descriptors defined here:<br> |
| <dl><dt><strong>__dict__</strong></dt> |
| <dd><tt>dictionary for instance variables (if defined)</tt></dd> |
| </dl> |
| <dl><dt><strong>__weakref__</strong></dt> |
| <dd><tt>list of weak references to the object (if defined)</tt></dd> |
| </dl> |
| </td></tr></table> |
| </body></html> |