FindReplaceRequest (Google Sheets API v4-rev20241008-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.json.GenericJson
    - - com.google.api.services.sheets.v4.model.FindReplaceRequest

All Implemented Interfaces:

Cloneable, Map<String,Object>
```
public final class FindReplaceRequest
extends com.google.api.client.json.GenericJson
```
Finds and replaces data in cells over a range, sheet, or all sheets.
This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Google Sheets API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Constructor Summary

Constructors
Constructor and Description

FindReplaceRequest()

Constructors
Constructor and Description
`FindReplaceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`FindReplaceRequest`	`clone()`
`Boolean`	`getAllSheets()` True to find/replace over all sheets.
`String`	`getFind()` The value to search.
`Boolean`	`getIncludeFormulas()` True if the search should include cells with formulas.
`Boolean`	`getMatchCase()` True if the search is case sensitive.
`Boolean`	`getMatchEntireCell()` True if the find value should match the entire cell.
`GridRange`	`getRange()` The range to find/replace over.
`String`	`getReplacement()` The value to use as the replacement.
`Boolean`	`getSearchByRegex()` True if the find value is a regex.
`Integer`	`getSheetId()` The sheet to find/replace over.
`FindReplaceRequest`	`set(String fieldName, Object value)`
`FindReplaceRequest`	`setAllSheets(Boolean allSheets)` True to find/replace over all sheets.
`FindReplaceRequest`	`setFind(String find)` The value to search.
`FindReplaceRequest`	`setIncludeFormulas(Boolean includeFormulas)` True if the search should include cells with formulas.
`FindReplaceRequest`	`setMatchCase(Boolean matchCase)` True if the search is case sensitive.
`FindReplaceRequest`	`setMatchEntireCell(Boolean matchEntireCell)` True if the find value should match the entire cell.
`FindReplaceRequest`	`setRange(GridRange range)` The range to find/replace over.
`FindReplaceRequest`	`setReplacement(String replacement)` The value to use as the replacement.
`FindReplaceRequest`	`setSearchByRegex(Boolean searchByRegex)` True if the find value is a regex.
`FindReplaceRequest`	`setSheetId(Integer sheetId)` The sheet to find/replace over.

Methods inherited from class com.google.api.client.json.GenericJson
getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData
entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - FindReplaceRequest
```
public FindReplaceRequest()
```
- Method Detail
  - getAllSheets
```
public Boolean getAllSheets()
```
    True to find/replace over all sheets.
    
    Returns:
    
    value or null for none
  - setAllSheets
```
public FindReplaceRequest setAllSheets(Boolean allSheets)
```
    True to find/replace over all sheets.
    
    Parameters:
    
    allSheets - allSheets or null for none
  - getFind
```
public String getFind()
```
    The value to search.
    
    Returns:
    
    value or null for none
  - setFind
```
public FindReplaceRequest setFind(String find)
```
    The value to search.
    
    Parameters:
    
    find - find or null for none
  - getIncludeFormulas
```
public Boolean getIncludeFormulas()
```
    True if the search should include cells with formulas. False to skip cells with formulas.
    
    Returns:
    
    value or null for none
  - setIncludeFormulas
```
public FindReplaceRequest setIncludeFormulas(Boolean includeFormulas)
```
    True if the search should include cells with formulas. False to skip cells with formulas.
    
    Parameters:
    
    includeFormulas - includeFormulas or null for none
  - getMatchCase
```
public Boolean getMatchCase()
```
    True if the search is case sensitive.
    
    Returns:
    
    value or null for none
  - setMatchCase
```
public FindReplaceRequest setMatchCase(Boolean matchCase)
```
    True if the search is case sensitive.
    
    Parameters:
    
    matchCase - matchCase or null for none
  - getMatchEntireCell
```
public Boolean getMatchEntireCell()
```
    True if the find value should match the entire cell.
    
    Returns:
    
    value or null for none
  - setMatchEntireCell
```
public FindReplaceRequest setMatchEntireCell(Boolean matchEntireCell)
```
    True if the find value should match the entire cell.
    
    Parameters:
    
    matchEntireCell - matchEntireCell or null for none
  - getRange
```
public GridRange getRange()
```
    The range to find/replace over.
    
    Returns:
    
    value or null for none
  - setRange
```
public FindReplaceRequest setRange(GridRange range)
```
    The range to find/replace over.
    
    Parameters:
    
    range - range or null for none
  - getReplacement
```
public String getReplacement()
```
    The value to use as the replacement.
    
    Returns:
    
    value or null for none
  - setReplacement
```
public FindReplaceRequest setReplacement(String replacement)
```
    The value to use as the replacement.
    
    Parameters:
    
    replacement - replacement or null for none
  - getSearchByRegex
```
public Boolean getSearchByRegex()
```
    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.
    
    Returns:
    
    value or null for none
  - setSearchByRegex
```
public FindReplaceRequest setSearchByRegex(Boolean searchByRegex)
```
    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.
    
    Parameters:
    
    searchByRegex - searchByRegex or null for none
  - getSheetId
```
public Integer getSheetId()
```
    The sheet to find/replace over.
    
    Returns:
    
    value or null for none
  - setSheetId
```
public FindReplaceRequest setSheetId(Integer sheetId)
```
    The sheet to find/replace over.
    
    Parameters:
    
    sheetId - sheetId or null for none
  - set
```
public FindReplaceRequest set(String fieldName,
                              Object value)
```
    Overrides:
    
    set in class com.google.api.client.json.GenericJson
  - clone
```
public FindReplaceRequest clone()
```
    Overrides:
    
    clone in class com.google.api.client.json.GenericJson

Class FindReplaceRequest

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Constructor Summary

Method Summary

Methods inherited from class com.google.api.client.json.GenericJson

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

FindReplaceRequest

Method Detail

getAllSheets

setAllSheets

getFind

setFind

getIncludeFormulas

setIncludeFormulas

getMatchCase

setMatchCase

getMatchEntireCell

setMatchEntireCell

getRange

setRange

getReplacement

setReplacement

getSearchByRegex

setSearchByRegex

getSheetId

setSheetId

set

clone