Class: Google::Apis::DriveV2::ContentRestriction

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

A restriction for accessing the content of the file.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ContentRestriction

Returns a new instance of ContentRestriction.



1400
1401
1402
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1400

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

Instance Attribute Details

#owner_restricted ⇒ Boolean Also known as: owner_restricted?

Whether the content restriction can only be modified or removed by a user who owns the file. For files in shared drives, any user with organizer capabilities can modify or remove this content restriction. Corresponds to the JSON property ownerRestricted

Returns:

  • (Boolean) 


1358
1359
1360
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1358

def owner_restricted
  @owner_restricted
end

#read_only ⇒ Boolean Also known as: read_only?

Whether the content of the file is read-only. If a file is read-only, a new revision of the file may not be added, comments may not be added or modified, and the title of the file may not be modified. Corresponds to the JSON property readOnly

Returns:

  • (Boolean) 


1366
1367
1368
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1366

def read_only
  @read_only
end

#reason ⇒ String

Reason for why the content of the file is restricted. This is only mutable on requests that also set readOnly=true. Corresponds to the JSON property reason

Returns:

  • (String) 


1373
1374
1375
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1373

def reason
  @reason
end

#restricting_user ⇒ Google::Apis::DriveV2::User

Information about a Drive user. Corresponds to the JSON property restrictingUser

Returns:



1378
1379
1380
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1378

def restricting_user
  @restricting_user
end

#restriction_date ⇒ DateTime

The time at which the content restriction was set (formatted RFC 3339 timestamp). Only populated if readOnly is true. Corresponds to the JSON property restrictionDate

Returns:

  • (DateTime) 


1384
1385
1386
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1384

def restriction_date
  @restriction_date
end

#system_restricted ⇒ Boolean Also known as: system_restricted?

Output only. Whether the content restriction was applied by the system, for example due to an esignature. Users cannot modify or remove system restricted content restrictions. Corresponds to the JSON property systemRestricted

Returns:

  • (Boolean) 


1391
1392
1393
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1391

def system_restricted
  @system_restricted
end

#type ⇒ String

Output only. The type of the content restriction. Currently the only possible value is globalContentRestriction. Corresponds to the JSON property type

Returns:

  • (String) 


1398
1399
1400
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1398

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1405
1406
1407
1408
1409
1410
1411
1412
1413
 
# File 'lib/google/apis/drive_v2/classes.rb', line 1405

def update!(**args)
  @owner_restricted = args[:owner_restricted] if args.key?(:owner_restricted)
  @read_only = args[:read_only] if args.key?(:read_only)
  @reason = args[:reason] if args.key?(:reason)
  @restricting_user = args[:restricting_user] if args.key?(:restricting_user)
  @restriction_date = args[:restriction_date] if args.key?(:restriction_date)
  @system_restricted = args[:system_restricted] if args.key?(:system_restricted)
  @type = args[:type] if args.key?(:type)
end