class Google::Apis::SheetsV4::FindReplaceRequest

Finds and replaces data in cells over a range, sheet, or all sheets.

Attributes

all_sheets[RW]

True to find/replace over all sheets. Corresponds to the JSON property `allSheets` @return [Boolean]

all_sheets?[RW]

True to find/replace over all sheets. Corresponds to the JSON property `allSheets` @return [Boolean]

find[RW]

The value to search. Corresponds to the JSON property `find` @return [String]

include_formulas[RW]

True if the search should include cells with formulas. False to skip cells with formulas. Corresponds to the JSON property `includeFormulas` @return [Boolean]

include_formulas?[RW]

True if the search should include cells with formulas. False to skip cells with formulas. Corresponds to the JSON property `includeFormulas` @return [Boolean]

match_case[RW]

True if the search is case sensitive. Corresponds to the JSON property `matchCase` @return [Boolean]

match_case?[RW]

True if the search is case sensitive. Corresponds to the JSON property `matchCase` @return [Boolean]

match_entire_cell[RW]

True if the find value should match the entire cell. Corresponds to the JSON property `matchEntireCell` @return [Boolean]

match_entire_cell?[RW]

True if the find value should match the entire cell. Corresponds to the JSON property `matchEntireCell` @return [Boolean]

range[RW]

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]

replacement[RW]

The value to use as the replacement. Corresponds to the JSON property `replacement` @return [String]

search_by_regex[RW]

True if the find value is a regex. The regular expression and replacement should follow Java regex rules at docs.oracle.com/javase/8/docs/api/ java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents `“Google Sheets”` and another has `“Google Docs”`, then searching for `“o.* (.*)”` with a replacement of `“$1 Rocks”` would change the contents of the cells to `“ GSheets Rocks”` and `“GDocs Rocks”` respectively. Corresponds to the JSON property `searchByRegex` @return [Boolean]

search_by_regex?[RW]

True if the find value is a regex. The regular expression and replacement should follow Java regex rules at docs.oracle.com/javase/8/docs/api/ java/util/regex/Pattern.html. The replacement string is allowed to refer to capturing groups. For example, if one cell has the contents `“Google Sheets”` and another has `“Google Docs”`, then searching for `“o.* (.*)”` with a replacement of `“$1 Rocks”` would change the contents of the cells to `“ GSheets Rocks”` and `“GDocs Rocks”` respectively. Corresponds to the JSON property `searchByRegex` @return [Boolean]

sheet_id[RW]

The sheet to find/replace over. Corresponds to the JSON property `sheetId` @return [Fixnum]

Public Class Methods

new(**args) click to toggle source
# File lib/google/apis/sheets_v4/classes.rb, line 5730
def initialize(**args)
   update!(**args)
end

Public Instance Methods

update!(**args) click to toggle source

Update properties of this object

# File lib/google/apis/sheets_v4/classes.rb, line 5735
def update!(**args)
  @all_sheets = args[:all_sheets] if args.key?(:all_sheets)
  @find = args[:find] if args.key?(:find)
  @include_formulas = args[:include_formulas] if args.key?(:include_formulas)
  @match_case = args[:match_case] if args.key?(:match_case)
  @match_entire_cell = args[:match_entire_cell] if args.key?(:match_entire_cell)
  @range = args[:range] if args.key?(:range)
  @replacement = args[:replacement] if args.key?(:replacement)
  @search_by_regex = args[:search_by_regex] if args.key?(:search_by_regex)
  @sheet_id = args[:sheet_id] if args.key?(:sheet_id)
end