Class: Google::Apis::DriveV2::Permission

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

Overview

A permission for a file.

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



2482
2483
2484
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2482

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

Instance Attribute Details

#additional_roles ⇒ Array<String>

Additional roles for this user. Only commenter is currently allowed, though more may be supported in the future. Corresponds to the JSON property additionalRoles

Returns:

  • (Array<String>) 


2373
2374
2375
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2373

def additional_roles
  @additional_roles
end

#auth_key ⇒ String

The authkey parameter required for this permission. Corresponds to the JSON property authKey

Returns:

  • (String) 


2378
2379
2380
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2378

def auth_key
  @auth_key
end

#deleted ⇒ Boolean Also known as: deleted?

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

Returns:

  • (Boolean) 


2384
2385
2386
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2384

def deleted
  @deleted
end

#domain ⇒ String

The domain name of the entity this permission refers to. This is an output- only field which is present when the permission type is user, group or domain. Corresponds to the JSON property domain

Returns:

  • (String) 


2391
2392
2393
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2391

def domain
  @domain
end

#email_address ⇒ String

The email address of the user or group this permission refers to. This is an output-only field which is present when the permission type is user or group. Corresponds to the JSON property emailAddress

Returns:

  • (String) 


2397
2398
2399
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2397

def email_address
  @email_address
end

#etag ⇒ String

The ETag of the permission. Corresponds to the JSON property etag

Returns:

  • (String) 


2402
2403
2404
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2402

def etag
  @etag
end

#expiration_date ⇒ DateTime

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

  • They can only be set on user and group permissions
  • The date must be in the future
  • The date cannot be more than a year in the future
  • The date can only be set on drive.permissions.update requests Corresponds to the JSON property expirationDate

Returns:

  • (DateTime) 


2412
2413
2414
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2412

def expiration_date
  @expiration_date
end

#id ⇒ String

The ID of the user this permission refers to, and identical to the permissionId in the About and Files resources. When making a drive.permissions. insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. Corresponds to the JSON property id

Returns:

  • (String) 


2420
2421
2422
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2420

def id
  @id
end

#kind ⇒ String

This is always drive#permission. Corresponds to the JSON property kind

Returns:

  • (String) 


2425
2426
2427
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2425

def kind
  @kind
end

#name ⇒ String

The name for this permission. Corresponds to the JSON property name

Returns:

  • (String) 


2430
2431
2432
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2430

def name
  @name
end

#photo_link ⇒ String

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

Returns:

  • (String) 


2435
2436
2437
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2435

def photo_link
  @photo_link
end

#role ⇒ String

The primary role for this user. While new values may be supported in the future, the following are currently allowed:

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

Returns:

  • (String) 


2445
2446
2447
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2445

def role
  @role
end

#self_link ⇒ String

A link back to this permission. Corresponds to the JSON property selfLink

Returns:

  • (String) 


2450
2451
2452
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2450

def self_link
  @self_link
end

#team_drive_permission_details ⇒ Array<Google::Apis::DriveV2::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:



2457
2458
2459
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2457

def team_drive_permission_details
  @team_drive_permission_details
end

#type ⇒ String

The account type. Allowed values are:

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

Returns:

  • (String) 


2466
2467
2468
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2466

def type
  @type
end

#value ⇒ String

The email address or domain name for the entity. This is used during inserts and is not populated in responses. When making a drive.permissions.insert request, exactly one of the id or value fields must be specified unless the permission type is anyone, in which case both id and value are ignored. Corresponds to the JSON property value

Returns:

  • (String) 


2474
2475
2476
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2474

def value
  @value
end

#with_link ⇒ Boolean Also known as: with_link?

Whether the link is required for this permission. Corresponds to the JSON property withLink

Returns:

  • (Boolean) 


2479
2480
2481
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2479

def with_link
  @with_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
 
# File 'generated/google/apis/drive_v2/classes.rb', line 2487

def update!(**args)
  @additional_roles = args[:additional_roles] if args.key?(:additional_roles)
  @auth_key = args[:auth_key] if args.key?(:auth_key)
  @deleted = args[:deleted] if args.key?(:deleted)
  @domain = args[:domain] if args.key?(:domain)
  @email_address = args[:email_address] if args.key?(:email_address)
  @etag = args[:etag] if args.key?(:etag)
  @expiration_date = args[:expiration_date] if args.key?(:expiration_date)
  @id = args[:id] if args.key?(:id)
  @kind = args[:kind] if args.key?(:kind)
  @name = args[:name] if args.key?(:name)
  @photo_link = args[:photo_link] if args.key?(:photo_link)
  @role = args[:role] if args.key?(:role)
  @self_link = args[:self_link] if args.key?(:self_link)
  @team_drive_permission_details = args[:team_drive_permission_details] if args.key?(:team_drive_permission_details)
  @type = args[:type] if args.key?(:type)
  @value = args[:value] if args.key?(:value)
  @with_link = args[:with_link] if args.key?(:with_link)
end