Class: Google::Apis::SheetsV4::FindReplaceRequest

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
generated/google/apis/sheets_v4/classes.rb,
generated/google/apis/sheets_v4/representations.rb,
generated/google/apis/sheets_v4/representations.rb

Overview

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

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) ⇒ FindReplaceRequest

Returns a new instance of FindReplaceRequest



6727
6728
6729
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6727

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

Instance Attribute Details

#all_sheets ⇒ Boolean Also known as: all_sheets?

True to find/replace over all sheets. Corresponds to the JSON property allSheets

Returns:

  • (Boolean) 


6724
6725
6726
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6724

def all_sheets
  @all_sheets
end

#find ⇒ String

The value to search. Corresponds to the JSON property find

Returns:

  • (String) 


6664
6665
6666
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6664

def find
  @find
end

#include_formulas ⇒ Boolean Also known as: include_formulas?

True if the search should include cells with formulas. False to skip cells with formulas. Corresponds to the JSON property includeFormulas

Returns:

  • (Boolean) 


6652
6653
6654
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6652

def include_formulas
  @include_formulas
end

#match_case ⇒ Boolean Also known as: match_case?

True if the search is case sensitive. Corresponds to the JSON property matchCase

Returns:

  • (Boolean) 


6718
6719
6720
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6718

def match_case
  @match_case
end

#match_entire_cell ⇒ Boolean Also known as: match_entire_cell?

True if the find value should match the entire cell. Corresponds to the JSON property matchEntireCell

Returns:

  • (Boolean) 


6658
6659
6660
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6658

def match_entire_cell
  @match_entire_cell
end

#range ⇒ Google::Apis::SheetsV4::GridRange

A range on a sheet. All indexes are zero-based. Indexes are half open, e.g 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

Returns:



6708
6709
6710
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6708

def range
  @range
end

#replacement ⇒ String

The value to use as the replacement. Corresponds to the JSON property replacement

Returns:

  • (String) 


6682
6683
6684
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6682

def replacement
  @replacement
end

#search_by_regex ⇒ Boolean Also known as: search_by_regex?

True if the find value is a regex. The regular expression and replacement should follow Java regex rules at https://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

Returns:

  • (Boolean) 


6676
6677
6678
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6676

def search_by_regex
  @search_by_regex
end

#sheet_id ⇒ Fixnum

The sheet to find/replace over. Corresponds to the JSON property sheetId

Returns:

  • (Fixnum) 


6713
6714
6715
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6713

def sheet_id
  @sheet_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



6732
6733
6734
6735
6736
6737
6738
6739
6740
6741
6742
 
# File 'generated/google/apis/sheets_v4/classes.rb', line 6732

def update!(**args)
  @include_formulas = args[:include_formulas] if args.key?(:include_formulas)
  @match_entire_cell = args[:match_entire_cell] if args.key?(:match_entire_cell)
  @find = args[:find] if args.key?(:find)
  @search_by_regex = args[:search_by_regex] if args.key?(:search_by_regex)
  @replacement = args[:replacement] if args.key?(:replacement)
  @range = args[:range] if args.key?(:range)
  @sheet_id = args[:sheet_id] if args.key?(:sheet_id)
  @match_case = args[:match_case] if args.key?(:match_case)
  @all_sheets = args[:all_sheets] if args.key?(:all_sheets)
end