target.apidocs.com.google.api.services.calendar.model.AclRule.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-calendar Show documentation

The newest version!







AclRule (Calendar API v3-rev20241101-2.0.0)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.calendar.model
Class AclRule



java.lang.Object


java.util.AbstractMap<String,Object>


com.google.api.client.util.GenericData


com.google.api.client.json.GenericJson


com.google.api.services.calendar.model.AclRule













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class AclRule
extends com.google.api.client.json.GenericJson
Model definition for AclRule.

  This is the Java data model class that specifies how to parse/serialize into the JSON that is
 transmitted over HTTP when working with the Calendar API. For a detailed explanation see:
 https://developers.google.com/api-client-library/java/google-http-java-client/json
 

Author:
Google, Inc.












Nested Class Summary

Nested Classes 

Modifier and Type
Class and Description


static class 
AclRule.Scope
The extent to which calendar access is granted by this ACL rule.







Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
com.google.api.client.util.GenericData.Flags





Nested classes/interfaces inherited from class java.util.AbstractMap
AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>





Nested classes/interfaces inherited from interface java.util.Map
Map.Entry<K,V>








Constructor Summary

Constructors 

Constructor and Description


AclRule() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


AclRule
clone() 


String
getEtag()
ETag of the resource.



String
getId()
Identifier of the Access Control List (ACL) rule.



String
getKind()
Type of the resource ("calendar#aclRule").



String
getRole()
The role assigned to the scope.



AclRule.Scope
getScope()
The extent to which calendar access is granted by this ACL rule.



AclRule
set(String fieldName,
   Object value) 


AclRule
setEtag(String etag)
ETag of the resource.



AclRule
setId(String id)
Identifier of the Access Control List (ACL) rule.



AclRule
setKind(String kind)
Type of the resource ("calendar#aclRule").



AclRule
setRole(String role)
The role assigned to the scope.



AclRule
setScope(AclRule.Scope scope)
The extent to which calendar access is granted by this ACL rule.







Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString





Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys





Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values





Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait





Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll














Constructor Detail





AclRule
public AclRule()









Method Detail





getEtag
public String getEtag()
ETag of the resource.

Returns:
value or null for none








setEtag
public AclRule setEtag(String etag)
ETag of the resource.

Parameters:
etag - etag or null for none








getId
public String getId()
Identifier of the Access Control List (ACL) rule. See Sharing calendars.

Returns:
value or null for none








setId
public AclRule setId(String id)
Identifier of the Access Control List (ACL) rule. See Sharing calendars.

Parameters:
id - id or null for none








getKind
public String getKind()
Type of the resource ("calendar#aclRule").

Returns:
value or null for none








setKind
public AclRule setKind(String kind)
Type of the resource ("calendar#aclRule").

Parameters:
kind - kind or null for none








getRole
public String getRole()
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.

Returns:
value or null for none








setRole
public AclRule setRole(String role)
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.

Parameters:
role - role or null for none








getScope
public AclRule.Scope getScope()
The extent to which calendar access is granted by this ACL rule.

Returns:
value or null for none








setScope
public AclRule setScope(AclRule.Scope scope)
The extent to which calendar access is granted by this ACL rule.

Parameters:
scope - scope or null for none








set
public AclRule set(String fieldName,
                   Object value)

Overrides:
set in class com.google.api.client.json.GenericJson








clone
public AclRule clone()

Overrides:
clone in class com.google.api.client.json.GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`AclRule`	`clone()`
`String`	`getEtag()` ETag of the resource.
`String`	`getId()` Identifier of the Access Control List (ACL) rule.
`String`	`getKind()` Type of the resource ("calendar#aclRule").
`String`	`getRole()` The role assigned to the scope.
`AclRule.Scope`	`getScope()` The extent to which calendar access is granted by this ACL rule.
`AclRule`	`set(String fieldName, Object value)`
`AclRule`	`setEtag(String etag)` ETag of the resource.
`AclRule`	`setId(String id)` Identifier of the Access Control List (ACL) rule.
`AclRule`	`setKind(String kind)` Type of the resource ("calendar#aclRule").
`AclRule`	`setRole(String role)` The role assigned to the scope.
`AclRule`	`setScope(AclRule.Scope scope)` The extent to which calendar access is granted by this ACL rule.