Class: Google::Apis::DriveV2::File::Capabilities

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

Overview

Output only. Capabilities the current user has on this file. Each capability corresponds to a fine-grained action that a user may take.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Capabilities

Returns a new instance of Capabilities.



2672
2673
2674
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2672

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

Instance Attribute Details

#can_accept_ownership ⇒ Boolean Also known as: can_accept_ownership?

Output only. Whether the current user is the pending owner of the file. Not populated for shared drive files. Corresponds to the JSON property canAcceptOwnership

Returns:

  • (Boolean) 


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

def can_accept_ownership
  @can_accept_ownership
end

#can_add_children ⇒ Boolean Also known as: can_add_children?

Output only. Whether the current user can add children to this folder. This is always false when the item is not a folder. Corresponds to the JSON property canAddChildren

Returns:

  • (Boolean) 


2398
2399
2400
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2398

def can_add_children
  @can_add_children
end

#can_add_folder_from_another_drive ⇒ Boolean Also known as: can_add_folder_from_another_drive?

Output only. Whether the current user can add a folder from another drive ( different shared drive or My Drive) to this folder. This is false when the item is not a folder. Only populated for items in shared drives. Corresponds to the JSON property canAddFolderFromAnotherDrive

Returns:

  • (Boolean) 


2406
2407
2408
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2406

def can_add_folder_from_another_drive
  @can_add_folder_from_another_drive
end

#can_add_my_drive_parent ⇒ Boolean Also known as: can_add_my_drive_parent?

Output only. Whether the current user can add a parent for the item without removing an existing parent in the same request. Not populated for shared drive files. Corresponds to the JSON property canAddMyDriveParent

Returns:

  • (Boolean) 


2414
2415
2416
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2414

def can_add_my_drive_parent
  @can_add_my_drive_parent
end

#can_change_copy_requires_writer_permission ⇒ Boolean Also known as: can_change_copy_requires_writer_permission?

Output only. Whether the current user can change the copyRequiresWriterPermission restriction of this file. Corresponds to the JSON property canChangeCopyRequiresWriterPermission

Returns:

  • (Boolean) 


2421
2422
2423
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2421

def can_change_copy_requires_writer_permission
  @can_change_copy_requires_writer_permission
end

#can_change_restricted_download ⇒ Boolean Also known as: can_change_restricted_download?

Output only. Deprecated. Corresponds to the JSON property canChangeRestrictedDownload

Returns:

  • (Boolean) 


2427
2428
2429
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2427

def can_change_restricted_download
  @can_change_restricted_download
end

#can_change_security_update_enabled ⇒ Boolean Also known as: can_change_security_update_enabled?

Output only. Whether the current user can change the securityUpdateEnabled field on link share metadata. Corresponds to the JSON property canChangeSecurityUpdateEnabled

Returns:

  • (Boolean) 


2434
2435
2436
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2434

def can_change_security_update_enabled
  @can_change_security_update_enabled
end

#can_comment ⇒ Boolean Also known as: can_comment?

Output only. Whether the current user can comment on this file. Corresponds to the JSON property canComment

Returns:

  • (Boolean) 


2440
2441
2442
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2440

def can_comment
  @can_comment
end

#can_copy ⇒ Boolean Also known as: can_copy?

Output only. Whether the current user can copy this file. For an item in a shared drive, whether the current user can copy non-folder descendants of this item, or this item itself if it is not a folder. Corresponds to the JSON property canCopy

Returns:

  • (Boolean) 


2448
2449
2450
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2448

def can_copy
  @can_copy
end

#can_delete ⇒ Boolean Also known as: can_delete?

Output only. Whether the current user can delete this file. Corresponds to the JSON property canDelete

Returns:

  • (Boolean) 


2454
2455
2456
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2454

def can_delete
  @can_delete
end

#can_delete_children ⇒ Boolean Also known as: can_delete_children?

Output only. Whether the current user can delete children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. Corresponds to the JSON property canDeleteChildren

Returns:

  • (Boolean) 


2462
2463
2464
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2462

def can_delete_children
  @can_delete_children
end

#can_download ⇒ Boolean Also known as: can_download?

Output only. Whether the current user can download this file. Corresponds to the JSON property canDownload

Returns:

  • (Boolean) 


2468
2469
2470
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2468

def can_download
  @can_download
end

#can_edit ⇒ Boolean Also known as: can_edit?

Output only. Whether the current user can edit this file. Other factors may limit the type of changes a user can make to a file. For example, see canChangeCopyRequiresWriterPermission or canModifyContent. Corresponds to the JSON property canEdit

Returns:

  • (Boolean) 


2476
2477
2478
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2476

def can_edit
  @can_edit
end

#can_list_children ⇒ Boolean Also known as: can_list_children?

Output only. Whether the current user can list the children of this folder. This is always false when the item is not a folder. Corresponds to the JSON property canListChildren

Returns:

  • (Boolean) 


2483
2484
2485
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2483

def can_list_children
  @can_list_children
end

#can_modify_content ⇒ Boolean Also known as: can_modify_content?

Output only. Whether the current user can modify the content of this file. Corresponds to the JSON property canModifyContent

Returns:

  • (Boolean) 


2489
2490
2491
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2489

def can_modify_content
  @can_modify_content
end

#can_modify_content_restriction ⇒ Boolean Also known as: can_modify_content_restriction?

Deprecated: Output only. Use one of canModifyEditorContentRestriction, canModifyOwnerContentRestriction or canRemoveContentRestriction. Corresponds to the JSON property canModifyContentRestriction

Returns:

  • (Boolean) 


2496
2497
2498
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2496

def can_modify_content_restriction
  @can_modify_content_restriction
end

#can_modify_editor_content_restriction ⇒ Boolean Also known as: can_modify_editor_content_restriction?

Output only. Whether the current user can add or modify content restrictions on the file which are editor restricted. Corresponds to the JSON property canModifyEditorContentRestriction

Returns:

  • (Boolean) 


2503
2504
2505
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2503

def can_modify_editor_content_restriction
  @can_modify_editor_content_restriction
end

#can_modify_labels ⇒ Boolean Also known as: can_modify_labels?

Output only. Whether the current user can modify the labels on the file. Corresponds to the JSON property canModifyLabels

Returns:

  • (Boolean) 


2509
2510
2511
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2509

def can_modify_labels
  @can_modify_labels
end

#can_modify_owner_content_restriction ⇒ Boolean Also known as: can_modify_owner_content_restriction?

Output only. Whether the current user can add or modify content restrictions which are owner restricted. Corresponds to the JSON property canModifyOwnerContentRestriction

Returns:

  • (Boolean) 


2516
2517
2518
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2516

def can_modify_owner_content_restriction
  @can_modify_owner_content_restriction
end

#can_move_children_out_of_drive ⇒ Boolean Also known as: can_move_children_out_of_drive?

Output only. Whether the current user can move children of this folder outside of the shared drive. This is false when the item is not a folder. Only populated for items in shared drives. Corresponds to the JSON property canMoveChildrenOutOfDrive

Returns:

  • (Boolean) 


2524
2525
2526
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2524

def can_move_children_out_of_drive
  @can_move_children_out_of_drive
end

#can_move_children_out_of_team_drive ⇒ Boolean Also known as: can_move_children_out_of_team_drive?

Output only. Deprecated: Use canMoveChildrenOutOfDrive instead. Corresponds to the JSON property canMoveChildrenOutOfTeamDrive

Returns:

  • (Boolean) 


2530
2531
2532
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2530

def can_move_children_out_of_team_drive
  @can_move_children_out_of_team_drive
end

#can_move_children_within_drive ⇒ Boolean Also known as: can_move_children_within_drive?

Output only. Whether the current user can move children of this folder within this drive. This is false when the item is not a folder. Note that a request to move the child may still fail depending on the current user's access to the child and to the destination folder. Corresponds to the JSON property canMoveChildrenWithinDrive

Returns:

  • (Boolean) 


2539
2540
2541
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2539

def can_move_children_within_drive
  @can_move_children_within_drive
end

#can_move_children_within_team_drive ⇒ Boolean Also known as: can_move_children_within_team_drive?

Output only. Deprecated: Use canMoveChildrenWithinDrive instead. Corresponds to the JSON property canMoveChildrenWithinTeamDrive

Returns:

  • (Boolean) 


2545
2546
2547
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2545

def can_move_children_within_team_drive
  @can_move_children_within_team_drive
end

#can_move_item_into_team_drive ⇒ Boolean Also known as: can_move_item_into_team_drive?

Output only. Deprecated: Use canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveItemIntoTeamDrive

Returns:

  • (Boolean) 


2551
2552
2553
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2551

def can_move_item_into_team_drive
  @can_move_item_into_team_drive
end

#can_move_item_out_of_drive ⇒ Boolean Also known as: can_move_item_out_of_drive?

Output only. Whether the current user can move this item outside of this drive by changing its parent. Note that a request to change the parent of the item may still fail depending on the new parent that is being added. Corresponds to the JSON property canMoveItemOutOfDrive

Returns:

  • (Boolean) 


2559
2560
2561
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2559

def can_move_item_out_of_drive
  @can_move_item_out_of_drive
end

#can_move_item_out_of_team_drive ⇒ Boolean Also known as: can_move_item_out_of_team_drive?

Output only. Deprecated: Use canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveItemOutOfTeamDrive

Returns:

  • (Boolean) 


2565
2566
2567
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2565

def can_move_item_out_of_team_drive
  @can_move_item_out_of_team_drive
end

#can_move_item_within_drive ⇒ Boolean Also known as: can_move_item_within_drive?

Output only. Whether the current user can move this item within this drive. Note that a request to change the parent of the item may still fail depending on the new parent that is being added and the parent that is being removed. Corresponds to the JSON property canMoveItemWithinDrive

Returns:

  • (Boolean) 


2573
2574
2575
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2573

def can_move_item_within_drive
  @can_move_item_within_drive
end

#can_move_item_within_team_drive ⇒ Boolean Also known as: can_move_item_within_team_drive?

Output only. Deprecated: Use canMoveItemWithinDrive instead. Corresponds to the JSON property canMoveItemWithinTeamDrive

Returns:

  • (Boolean) 


2579
2580
2581
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2579

def can_move_item_within_team_drive
  @can_move_item_within_team_drive
end

#can_move_team_drive_item ⇒ Boolean Also known as: can_move_team_drive_item?

Output only. Deprecated: Use canMoveItemWithinDrive or canMoveItemOutOfDrive instead. Corresponds to the JSON property canMoveTeamDriveItem

Returns:

  • (Boolean) 


2586
2587
2588
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2586

def can_move_team_drive_item
  @can_move_team_drive_item
end

#can_read_drive ⇒ Boolean Also known as: can_read_drive?

Output only. Whether the current user can read the shared drive to which this file belongs. Only populated for items in shared drives. Corresponds to the JSON property canReadDrive

Returns:

  • (Boolean) 


2593
2594
2595
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2593

def can_read_drive
  @can_read_drive
end

#can_read_labels ⇒ Boolean Also known as: can_read_labels?

Output only. Whether the current user can read the labels on the file. Corresponds to the JSON property canReadLabels

Returns:

  • (Boolean) 


2599
2600
2601
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2599

def can_read_labels
  @can_read_labels
end

#can_read_revisions ⇒ Boolean Also known as: can_read_revisions?

Output only. Whether the current user can read the revisions resource of this file. For a shared drive item, whether revisions of non-folder descendants of this item, or this item itself if it is not a folder, can be read. Corresponds to the JSON property canReadRevisions

Returns:

  • (Boolean) 


2607
2608
2609
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2607

def can_read_revisions
  @can_read_revisions
end

#can_read_team_drive ⇒ Boolean Also known as: can_read_team_drive?

Output only. Deprecated: Use canReadDrive instead. Corresponds to the JSON property canReadTeamDrive

Returns:

  • (Boolean) 


2613
2614
2615
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2613

def can_read_team_drive
  @can_read_team_drive
end

#can_remove_children ⇒ Boolean Also known as: can_remove_children?

Output only. Whether the current user can remove children from this folder. This is always false when the item is not a folder. For a folder in a shared drive, use canDeleteChildren or canTrashChildren instead. Corresponds to the JSON property canRemoveChildren

Returns:

  • (Boolean) 


2621
2622
2623
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2621

def can_remove_children
  @can_remove_children
end

#can_remove_content_restriction ⇒ Boolean Also known as: can_remove_content_restriction?

Output only. Whether there is a content restriction on the file that can be removed by the current user. Corresponds to the JSON property canRemoveContentRestriction

Returns:

  • (Boolean) 


2628
2629
2630
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2628

def can_remove_content_restriction
  @can_remove_content_restriction
end

#can_remove_my_drive_parent ⇒ Boolean Also known as: can_remove_my_drive_parent?

Output only. Whether the current user can remove a parent from the item without adding another parent in the same request. Not populated for shared drive files. Corresponds to the JSON property canRemoveMyDriveParent

Returns:

  • (Boolean) 


2636
2637
2638
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2636

def can_remove_my_drive_parent
  @can_remove_my_drive_parent
end

#can_rename ⇒ Boolean Also known as: can_rename?

Output only. Whether the current user can rename this file. Corresponds to the JSON property canRename

Returns:

  • (Boolean) 


2642
2643
2644
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2642

def can_rename
  @can_rename
end

#can_share ⇒ Boolean Also known as: can_share?

Output only. Whether the current user can modify the sharing settings for this file. Corresponds to the JSON property canShare

Returns:

  • (Boolean) 


2649
2650
2651
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2649

def can_share
  @can_share
end

#can_trash ⇒ Boolean Also known as: can_trash?

Output only. Whether the current user can move this file to trash. Corresponds to the JSON property canTrash

Returns:

  • (Boolean) 


2655
2656
2657
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2655

def can_trash
  @can_trash
end

#can_trash_children ⇒ Boolean Also known as: can_trash_children?

Output only. Whether the current user can trash children of this folder. This is false when the item is not a folder. Only populated for items in shared drives. Corresponds to the JSON property canTrashChildren

Returns:

  • (Boolean) 


2663
2664
2665
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2663

def can_trash_children
  @can_trash_children
end

#can_untrash ⇒ Boolean Also known as: can_untrash?

Output only. Whether the current user can restore this file from trash. Corresponds to the JSON property canUntrash

Returns:

  • (Boolean) 


2669
2670
2671
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2669

def can_untrash
  @can_untrash
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
 
# File 'lib/google/apis/drive_v2/classes.rb', line 2677

def update!(**args)
  @can_accept_ownership = args[:can_accept_ownership] if args.key?(:can_accept_ownership)
  @can_add_children = args[:can_add_children] if args.key?(:can_add_children)
  @can_add_folder_from_another_drive = args[:can_add_folder_from_another_drive] if args.key?(:can_add_folder_from_another_drive)
  @can_add_my_drive_parent = args[:can_add_my_drive_parent] if args.key?(:can_add_my_drive_parent)
  @can_change_copy_requires_writer_permission = args[:can_change_copy_requires_writer_permission] if args.key?(:can_change_copy_requires_writer_permission)
  @can_change_restricted_download = args[:can_change_restricted_download] if args.key?(:can_change_restricted_download)
  @can_change_security_update_enabled = args[:can_change_security_update_enabled] if args.key?(:can_change_security_update_enabled)
  @can_comment = args[:can_comment] if args.key?(:can_comment)
  @can_copy = args[:can_copy] if args.key?(:can_copy)
  @can_delete = args[:can_delete] if args.key?(:can_delete)
  @can_delete_children = args[:can_delete_children] if args.key?(:can_delete_children)
  @can_download = args[:can_download] if args.key?(:can_download)
  @can_edit = args[:can_edit] if args.key?(:can_edit)
  @can_list_children = args[:can_list_children] if args.key?(:can_list_children)
  @can_modify_content = args[:can_modify_content] if args.key?(:can_modify_content)
  @can_modify_content_restriction = args[:can_modify_content_restriction] if args.key?(:can_modify_content_restriction)
  @can_modify_editor_content_restriction = args[:can_modify_editor_content_restriction] if args.key?(:can_modify_editor_content_restriction)
  @can_modify_labels = args[:can_modify_labels] if args.key?(:can_modify_labels)
  @can_modify_owner_content_restriction = args[:can_modify_owner_content_restriction] if args.key?(:can_modify_owner_content_restriction)
  @can_move_children_out_of_drive = args[:can_move_children_out_of_drive] if args.key?(:can_move_children_out_of_drive)
  @can_move_children_out_of_team_drive = args[:can_move_children_out_of_team_drive] if args.key?(:can_move_children_out_of_team_drive)
  @can_move_children_within_drive = args[:can_move_children_within_drive] if args.key?(:can_move_children_within_drive)
  @can_move_children_within_team_drive = args[:can_move_children_within_team_drive] if args.key?(:can_move_children_within_team_drive)
  @can_move_item_into_team_drive = args[:can_move_item_into_team_drive] if args.key?(:can_move_item_into_team_drive)
  @can_move_item_out_of_drive = args[:can_move_item_out_of_drive] if args.key?(:can_move_item_out_of_drive)
  @can_move_item_out_of_team_drive = args[:can_move_item_out_of_team_drive] if args.key?(:can_move_item_out_of_team_drive)
  @can_move_item_within_drive = args[:can_move_item_within_drive] if args.key?(:can_move_item_within_drive)
  @can_move_item_within_team_drive = args[:can_move_item_within_team_drive] if args.key?(:can_move_item_within_team_drive)
  @can_move_team_drive_item = args[:can_move_team_drive_item] if args.key?(:can_move_team_drive_item)
  @can_read_drive = args[:can_read_drive] if args.key?(:can_read_drive)
  @can_read_labels = args[:can_read_labels] if args.key?(:can_read_labels)
  @can_read_revisions = args[:can_read_revisions] if args.key?(:can_read_revisions)
  @can_read_team_drive = args[:can_read_team_drive] if args.key?(:can_read_team_drive)
  @can_remove_children = args[:can_remove_children] if args.key?(:can_remove_children)
  @can_remove_content_restriction = args[:can_remove_content_restriction] if args.key?(:can_remove_content_restriction)
  @can_remove_my_drive_parent = args[:can_remove_my_drive_parent] if args.key?(:can_remove_my_drive_parent)
  @can_rename = args[:can_rename] if args.key?(:can_rename)
  @can_share = args[:can_share] if args.key?(:can_share)
  @can_trash = args[:can_trash] if args.key?(:can_trash)
  @can_trash_children = args[:can_trash_children] if args.key?(:can_trash_children)
  @can_untrash = args[:can_untrash] if args.key?(:can_untrash)
end