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: PermissionDetail, 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.



2098
2099
2100
# File 'generated/google/apis/drive_v3/classes.rb', line 2098

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

Instance Attribute Details

#allow_file_discoveryBoolean 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)


2005
2006
2007
# File 'generated/google/apis/drive_v3/classes.rb', line 2005

def allow_file_discovery
  @allow_file_discovery
end

#deletedBoolean 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)


2012
2013
2014
# File 'generated/google/apis/drive_v3/classes.rb', line 2012

def deleted
  @deleted
end

#display_nameString

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)


2024
2025
2026
# File 'generated/google/apis/drive_v3/classes.rb', line 2024

def display_name
  @display_name
end

#domainString

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

Returns:

  • (String)


2029
2030
2031
# File 'generated/google/apis/drive_v3/classes.rb', line 2029

def domain
  @domain
end

#email_addressString

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

Returns:

  • (String)


2034
2035
2036
# File 'generated/google/apis/drive_v3/classes.rb', line 2034

def email_address
  @email_address
end

#expiration_timeDateTime

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)


2043
2044
2045
# File 'generated/google/apis/drive_v3/classes.rb', line 2043

def expiration_time
  @expiration_time
end

#idString

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)


2050
2051
2052
# File 'generated/google/apis/drive_v3/classes.rb', line 2050

def id
  @id
end

#kindString

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

Returns:

  • (String)


2056
2057
2058
# File 'generated/google/apis/drive_v3/classes.rb', line 2056

def kind
  @kind
end

#permission_detailsArray<Google::Apis::DriveV3::Permission::PermissionDetail>

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



2063
2064
2065
# File 'generated/google/apis/drive_v3/classes.rb', line 2063

def permission_details
  @permission_details
end

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

Returns:

  • (String)


2068
2069
2070
# File 'generated/google/apis/drive_v3/classes.rb', line 2068

def photo_link
  @photo_link
end

#roleString

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)


2080
2081
2082
# File 'generated/google/apis/drive_v3/classes.rb', line 2080

def role
  @role
end

#team_drive_permission_detailsArray<Google::Apis::DriveV3::Permission::TeamDrivePermissionDetail>

Deprecated - use permissionDetails instead. Corresponds to the JSON property teamDrivePermissionDetails



2085
2086
2087
# File 'generated/google/apis/drive_v3/classes.rb', line 2085

def team_drive_permission_details
  @team_drive_permission_details
end

#typeString

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 a anyone type. Corresponds to the JSON property type

Returns:

  • (String)


2096
2097
2098
# File 'generated/google/apis/drive_v3/classes.rb', line 2096

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
# File 'generated/google/apis/drive_v3/classes.rb', line 2103

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)
  @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)
end