target.apidocs.com.google.api.services.bigquery.model.GoogleSheetsOptions.html Maven / Gradle / Ivy
GoogleSheetsOptions (BigQuery API v2-rev20240727-2.0.0)
com.google.api.services.bigquery.model
Class GoogleSheetsOptions
- java.lang.Object
-
- java.util.AbstractMap<String,Object>
-
- com.google.api.client.util.GenericData
-
- com.google.api.client.json.GenericJson
-
- com.google.api.services.bigquery.model.GoogleSheetsOptions
-
public final class GoogleSheetsOptions
extends com.google.api.client.json.GenericJson
Options specific to Google Sheets data sources.
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 BigQuery 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>
-
Constructor Summary
Constructors
Constructor and Description
GoogleSheetsOptions()
-
Method Summary
All Methods Instance Methods Concrete Methods
Modifier and Type
Method and Description
GoogleSheetsOptions
clone()
String
getRange()
Optional.
Long
getSkipLeadingRows()
Optional.
GoogleSheetsOptions
set(String fieldName,
Object value)
GoogleSheetsOptions
setRange(String range)
Optional.
GoogleSheetsOptions
setSkipLeadingRows(Long skipLeadingRows)
Optional.
-
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
-
-
Method Detail
-
getRange
public String getRange()
Optional. Range of a sheet to query from. Only used when non-empty. Typical format:
sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
- Returns:
- value or
null
for none
-
setRange
public GoogleSheetsOptions setRange(String range)
Optional. Range of a sheet to query from. Only used when non-empty. Typical format:
sheet_name!top_left_cell_id:bottom_right_cell_id For example: sheet1!A1:B20
- Parameters:
range
- range or null
for none
-
getSkipLeadingRows
public Long getSkipLeadingRows()
Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the
data. The default value is 0. This property is useful if you have header rows that should be
skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified -
Autodetect tries to detect headers in the first row. If they are not detected, the row is read
as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 -
Instructs autodetect that there are no headers and data should be read starting from the first
row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row
N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract
column names for the detected schema.
- Returns:
- value or
null
for none
-
setSkipLeadingRows
public GoogleSheetsOptions setSkipLeadingRows(Long skipLeadingRows)
Optional. The number of rows at the top of a sheet that BigQuery will skip when reading the
data. The default value is 0. This property is useful if you have header rows that should be
skipped. When autodetect is on, the behavior is the following: * skipLeadingRows unspecified -
Autodetect tries to detect headers in the first row. If they are not detected, the row is read
as data. Otherwise data is read starting from the second row. * skipLeadingRows is 0 -
Instructs autodetect that there are no headers and data should be read starting from the first
row. * skipLeadingRows = N > 0 - Autodetect skips N-1 rows and tries to detect headers in row
N. If headers are not detected, row N is just skipped. Otherwise row N is used to extract
column names for the detected schema.
- Parameters:
skipLeadingRows
- skipLeadingRows or null
for none
-
set
public GoogleSheetsOptions set(String fieldName,
Object value)
- Overrides:
set
in class com.google.api.client.json.GenericJson
-
clone
public GoogleSheetsOptions clone()
- Overrides:
clone
in class com.google.api.client.json.GenericJson
Copyright © 2011–2024 Google. All rights reserved.