Class: Google::Apis::DriveV3::Permission

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/drive_v3/classes.rb,
generated/google/apis/drive_v3/representations.rb,
generated/google/apis/drive_v3/representations.rb

Overview

A permission for a file. A permission grants a user, group, domain or the world access to a file or a folder hierarchy.

Defined Under Namespace

Classes: TeamDrivePermissionDetail

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ Permission

Returns a new instance of Permission



1545
1546
1547
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1545

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#allow_file_discovery ⇒ Boolean Also known as: allow_file_discovery?

Whether the permission allows the file to be discovered through search. This is only applicable for permissions of type domain or anyone. Corresponds to the JSON property allowFileDiscovery

Returns:

  • (Boolean) 


1466
1467
1468
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1466

def allow_file_discovery
  @allow_file_discovery
end

#deleted ⇒ Boolean Also known as: deleted?

Whether the account associated with this permission has been deleted. This field only pertains to user and group permissions. Corresponds to the JSON property deleted

Returns:

  • (Boolean) 


1473
1474
1475
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1473

def deleted
  @deleted
end

#display_name ⇒ String

A displayable name for users, groups or domains. Corresponds to the JSON property displayName

Returns:

  • (String) 


1479
1480
1481
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1479

def display_name
  @display_name
end

#domain ⇒ String

The domain to which this permission refers. Corresponds to the JSON property domain

Returns:

  • (String) 


1484
1485
1486
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1484

def domain
  @domain
end

#email_address ⇒ String

The email address of the user or group to which this permission refers. Corresponds to the JSON property emailAddress

Returns:

  • (String) 


1489
1490
1491
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1489

def email_address
  @email_address
end

#expiration_time ⇒ DateTime

The time at which this permission will expire (RFC 3339 date-time). Expiration times have the following restrictions:

  • They can only be set on user and group permissions
  • The time must be in the future
  • The time cannot be more than a year in the future Corresponds to the JSON property expirationTime

Returns:

  • (DateTime) 


1498
1499
1500
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1498

def expiration_time
  @expiration_time
end

#id ⇒ String

The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. Corresponds to the JSON property id

Returns:

  • (String) 


1504
1505
1506
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1504

def id
  @id
end

#kind ⇒ String

Identifies what kind of resource this is. Value: the fixed string "drive# permission". Corresponds to the JSON property kind

Returns:

  • (String) 


1510
1511
1512
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1510

def kind
  @kind
end

#photo_link ⇒ String

A link to the user's profile photo, if available. Corresponds to the JSON property photoLink

Returns:

  • (String) 


1515
1516
1517
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1515

def photo_link
  @photo_link
end

#role ⇒ String

The role granted by this permission. While new values may be supported in the future, the following are currently allowed:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader Corresponds to the JSON property role

Returns:

  • (String) 


1527
1528
1529
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1527

def role
  @role
end

#team_drive_permission_details ⇒ Array<Google::Apis::DriveV3::Permission::TeamDrivePermissionDetail>

Details of whether the permissions on this Team Drive item are inherited or directly on this item. This is an output-only field which is present only for Team Drive items. Corresponds to the JSON property teamDrivePermissionDetails

Returns:



1534
1535
1536
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1534

def team_drive_permission_details
  @team_drive_permission_details
end

#type ⇒ String

The type of the grantee. Valid values are:

  • user
  • group
  • domain
  • anyone Corresponds to the JSON property type

Returns:

  • (String) 


1543
1544
1545
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1543

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
 
# File 'generated/google/apis/drive_v3/classes.rb', line 1550

def update!(**args)
  @allow_file_discovery = args[:allow_file_discovery] if args.key?(:allow_file_discovery)
  @deleted = args[:deleted] if args.key?(:deleted)
  @display_name = args[:display_name] if args.key?(:display_name)
  @domain = args[:domain] if args.key?(:domain)
  @email_address = args[:email_address] if args.key?(:email_address)
  @expiration_time = args[:expiration_time] if args.key?(:expiration_time)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @photo_link = args[:photo_link] if args.key?(:photo_link)
  @role = args[:role] if args.key?(:role)
  @team_drive_permission_details = args[:team_drive_permission_details] if args.key?(:team_drive_permission_details)
  @type = args[:type] if args.key?(:type)
end