Class: Google::Apis::DriveV3::ContentRestriction

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 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.



980
981
982
# File 'lib/google/apis/drive_v3/classes.rb', line 980

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

Instance Attribute Details

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


938
939
940
# File 'lib/google/apis/drive_v3/classes.rb', line 938

def owner_restricted
  @owner_restricted
end

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


946
947
948
# File 'lib/google/apis/drive_v3/classes.rb', line 946

def read_only
  @read_only
end

#reasonString

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)


953
954
955
# File 'lib/google/apis/drive_v3/classes.rb', line 953

def reason
  @reason
end

#restricting_userGoogle::Apis::DriveV3::User

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



958
959
960
# File 'lib/google/apis/drive_v3/classes.rb', line 958

def restricting_user
  @restricting_user
end

#restriction_timeDateTime

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

Returns:

  • (DateTime)


964
965
966
# File 'lib/google/apis/drive_v3/classes.rb', line 964

def restriction_time
  @restriction_time
end

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


971
972
973
# File 'lib/google/apis/drive_v3/classes.rb', line 971

def system_restricted
  @system_restricted
end

#typeString

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

Returns:

  • (String)


978
979
980
# File 'lib/google/apis/drive_v3/classes.rb', line 978

def type
  @type
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



985
986
987
988
989
990
991
992
993
# File 'lib/google/apis/drive_v3/classes.rb', line 985

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_time = args[:restriction_time] if args.key?(:restriction_time)
  @system_restricted = args[:system_restricted] if args.key?(:system_restricted)
  @type = args[:type] if args.key?(:type)
end