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

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/drive_v3/classes.rb,
lib/google/apis/drive_v3/representations.rb,
lib/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. Some resource methods (such as permissions.update) require a permissionId. Use the permissions.list method to retrieve the ID for a file, folder, or shared drive.

Defined Under Namespace

Classes: PermissionDetail, TeamDrivePermissionDetail

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Permission

Returns a new instance of Permission.



2966
2967
2968
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2966

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) 


2869
2870
2871
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2869

def allow_file_discovery
  @allow_file_discovery
end

#deleted ⇒ Boolean Also known as: deleted?

Output only. 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) 


2876
2877
2878
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2876

def deleted
  @deleted
end

#display_name ⇒ String

Output only. The "pretty" name of the value of the permission. The following is a list of examples for each type of permission: * user - User's full name, as defined for their Google account, such as "Joe Smith." * group - Name of the Google Group, such as "The Company Administrators." * domain - String domain name, such as "thecompany.com." * anyone - No displayName is present. Corresponds to the JSON property displayName

Returns:

  • (String) 


2887
2888
2889
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2887

def display_name
  @display_name
end

#domain ⇒ String

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

Returns:

  • (String) 


2892
2893
2894
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2892

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) 


2897
2898
2899
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2897

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) 


2905
2906
2907
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2905

def expiration_time
  @expiration_time
end

#id ⇒ String

Output only. The ID of this permission. This is a unique identifier for the grantee, and is published in User resources as permissionId. IDs should be treated as opaque values. Corresponds to the JSON property id

Returns:

  • (String) 


2912
2913
2914
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2912

def id
  @id
end

#kind ⇒ String

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

Returns:

  • (String) 


2918
2919
2920
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2918

def kind
  @kind
end

#pending_owner ⇒ Boolean Also known as: pending_owner?

Whether the account associated with this permission is a pending owner. Only populated for user type permissions for files that are not in a shared drive. Corresponds to the JSON property pendingOwner

Returns:

  • (Boolean) 


2924
2925
2926
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2924

def pending_owner
  @pending_owner
end

#permission_details ⇒ Array<Google::Apis::DriveV3::Permission::PermissionDetail>

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

Returns:



2932
2933
2934
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2932

def permission_details
  @permission_details
end

#photo_link ⇒ String

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

Returns:

  • (String) 


2937
2938
2939
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2937

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) 


2944
2945
2946
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2944

def role
  @role
end

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

Output only. Deprecated: Output only. Use permissionDetails instead. Corresponds to the JSON property teamDrivePermissionDetails

Returns:



2949
2950
2951
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2949

def team_drive_permission_details
  @team_drive_permission_details
end

#type ⇒ String

The type of the grantee. Valid values are: * user * group * domain * anyone When creating a permission, if type is user or group, you must provide an emailAddress for the user or group. When type is domain, you must provide a domain. There isn't extra information required for an anyone type. Corresponds to the JSON property type

Returns:

  • (String) 


2958
2959
2960
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2958

def type
  @type
end

#view ⇒ String

Indicates the view for this permission. Only populated for permissions that belong to a view. 'published' is the only supported value. Corresponds to the JSON property view

Returns:

  • (String) 


2964
2965
2966
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2964

def view
  @view
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
 
# File 'lib/google/apis/drive_v3/classes.rb', line 2971

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)
  @pending_owner = args[:pending_owner] if args.key?(:pending_owner)
  @permission_details = args[:permission_details] if args.key?(:permission_details)
  @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)
  @view = args[:view] if args.key?(:view)
end