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.

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.


2160
2161
2162
# File 'generated/google/apis/drive_v2/classes.rb', line 2160

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

Instance Attribute Details

#additional_rolesArray<String>

Additional roles for this user. Only commenter is currently allowed. Corresponds to the JSON property additionalRoles

Returns:

  • (Array<String>)

2072
2073
2074
# File 'generated/google/apis/drive_v2/classes.rb', line 2072

def additional_roles
  @additional_roles
end

#auth_keyString

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

Returns:

  • (String)

2077
2078
2079
# File 'generated/google/apis/drive_v2/classes.rb', line 2077

def auth_key
  @auth_key
end

#domainString

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)

2083
2084
2085
# File 'generated/google/apis/drive_v2/classes.rb', line 2083

def domain
  @domain
end

#email_addressString

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)

2089
2090
2091
# File 'generated/google/apis/drive_v2/classes.rb', line 2089

def email_address
  @email_address
end

#etagString

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

Returns:

  • (String)

2094
2095
2096
# File 'generated/google/apis/drive_v2/classes.rb', line 2094

def etag
  @etag
end

#expiration_dateDateTime

The time at which this permission will expire (RFC 3339 date-time). Corresponds to the JSON property expirationDate

Returns:

  • (DateTime)

2099
2100
2101
# File 'generated/google/apis/drive_v2/classes.rb', line 2099

def expiration_date
  @expiration_date
end

#idString

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 anyone, in which case both id and value are ignored. Corresponds to the JSON property id

Returns:

  • (String)

2107
2108
2109
# File 'generated/google/apis/drive_v2/classes.rb', line 2107

def id
  @id
end

#kindString

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

Returns:

  • (String)

2112
2113
2114
# File 'generated/google/apis/drive_v2/classes.rb', line 2112

def kind
  @kind
end

#nameString

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

Returns:

  • (String)

2117
2118
2119
# File 'generated/google/apis/drive_v2/classes.rb', line 2117

def name
  @name
end

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

Returns:

  • (String)

2122
2123
2124
# File 'generated/google/apis/drive_v2/classes.rb', line 2122

def photo_link
  @photo_link
end

#roleString

The primary role for this user. Allowed values are:

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

Returns:

  • (String)

2130
2131
2132
# File 'generated/google/apis/drive_v2/classes.rb', line 2130

def role
  @role
end

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

Returns:

  • (String)

2135
2136
2137
# File 'generated/google/apis/drive_v2/classes.rb', line 2135

def self_link
  @self_link
end

#typeString

The account type. Allowed values are:

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

Returns:

  • (String)

2144
2145
2146
# File 'generated/google/apis/drive_v2/classes.rb', line 2144

def type
  @type
end

#valueString

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 anyone, in which case both id and value are ignored. Corresponds to the JSON property value

Returns:

  • (String)

2152
2153
2154
# File 'generated/google/apis/drive_v2/classes.rb', line 2152

def value
  @value
end

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

Returns:

  • (Boolean)

2157
2158
2159
# File 'generated/google/apis/drive_v2/classes.rb', line 2157

def with_link
  @with_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
# File 'generated/google/apis/drive_v2/classes.rb', line 2165

def update!(**args)
  @additional_roles = args[:additional_roles] if args.key?(:additional_roles)
  @auth_key = args[:auth_key] if args.key?(:auth_key)
  @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)
  @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