class Google::Apis::SheetsV4::ProtectedRange
A protected range.
Attributes
The description of this protected range. Corresponds to the JSON property `description` @return [String]
The editors of a protected range. Corresponds to the JSON property `editors` @return [Google::Apis::SheetsV4::Editors]
The named range this protected range is backed by, if any. When writing, only one of range or named_range_id
may be set. Corresponds to the JSON property `namedRangeId` @return [String]
The ID of the protected range. This field is read-only. Corresponds to the JSON property `protectedRangeId` @return [Fixnum]
A range on a sheet. All indexes are zero-based. Indexes are half open, i.e. the start index is inclusive and the end index is exclusive – [start_index, end_index). Missing indexes indicate the range is unbounded on that side. For example, if `“Sheet1”` is sheet ID 0, then: `Sheet1!A1:A1 == sheet_id: 0, start_row_index: 0, end_row_index: 1, start_column_index: 0, end_column_index: 1` `Sheet1!A3:B4 == sheet_id: 0, start_row_index: 2, end_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1!A:B == sheet_id: 0, start_column_index: 0, end_column_index: 2` `Sheet1!A5:B == sheet_id: 0, start_row_index: 4, start_column_index: 0, end_column_index: 2` `Sheet1 == sheet_id:0` The start index must always be less than or equal to the end index. If the start index equals the end index, then the range is empty. Empty ranges are typically not meaningful and are usually rendered in the UI as `# REF!`. Corresponds to the JSON property `range` @return [Google::Apis::SheetsV4::GridRange]
True if the user who requested this protected range can edit the protected area. This field is read-only. Corresponds to the JSON property `requestingUserCanEdit` @return [Boolean]
True if the user who requested this protected range can edit the protected area. This field is read-only. Corresponds to the JSON property `requestingUserCanEdit` @return [Boolean]
The list of unprotected ranges within a protected sheet. Unprotected ranges are only supported on protected sheets. Corresponds to the JSON property `unprotectedRanges` @return [Array<Google::Apis::SheetsV4::GridRange>]
True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors is ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document. Corresponds to the JSON property `warningOnly` @return [Boolean]
True if this protected range will show a warning when editing. Warning-based protection means that every user can edit data in the protected range, except editing will prompt a warning asking the user to confirm the edit. When writing: if this field is true, then editors is ignored. Additionally, if this field is changed from true to false and the `editors` field is not set (nor included in the field mask), then the editors will be set to all the editors in the document. Corresponds to the JSON property `warningOnly` @return [Boolean]
Public Class Methods
# File lib/google/apis/sheets_v4/classes.rb, line 7668 def initialize(**args) update!(**args) end
Public Instance Methods
Update properties of this object
# File lib/google/apis/sheets_v4/classes.rb, line 7673 def update!(**args) @description = args[:description] if args.key?(:description) @editors = args[:editors] if args.key?(:editors) @named_range_id = args[:named_range_id] if args.key?(:named_range_id) @protected_range_id = args[:protected_range_id] if args.key?(:protected_range_id) @range = args[:range] if args.key?(:range) @requesting_user_can_edit = args[:requesting_user_can_edit] if args.key?(:requesting_user_can_edit) @unprotected_ranges = args[:unprotected_ranges] if args.key?(:unprotected_ranges) @warning_only = args[:warning_only] if args.key?(:warning_only) end