target.apidocs.com.google.api.services.bigquery.model.HivePartitioningOptions.html Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of google-api-services-bigquery Show documentation

There is a newer version: v2-rev20241222-2.0.0

Show newest version







HivePartitioningOptions (BigQuery API v2-rev20190616-1.29.2)











Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method








com.google.api.services.bigquery.model
Class HivePartitioningOptions



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.HivePartitioningOptions













All Implemented Interfaces:
Cloneable, Map<String,Object>




public final class HivePartitioningOptions
extends GenericJson
Model definition for HivePartitioningOptions.

  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
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


HivePartitioningOptions() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


HivePartitioningOptions
clone() 


String
getMode()
[Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data.



String
getSourceUriPrefix()
[Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all
 source uris should be supplied.



HivePartitioningOptions
set(String fieldName,
   Object value) 


HivePartitioningOptions
setMode(String mode)
[Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data.



HivePartitioningOptions
setSourceUriPrefix(String sourceUriPrefix)
[Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all
 source uris should be supplied.







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





HivePartitioningOptions
public HivePartitioningOptions()









Method Detail





getMode
public String getMode()
[Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data.
 Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2)
 STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not
 all storage formats support hive partitioning. Requesting hive partitioning on an unsupported
 format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and
 Parquet.

Returns:
value or null for none








setMode
public HivePartitioningOptions setMode(String mode)
[Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data.
 Two modes are supported. (1) AUTO: automatically infer partition key name(s) and type(s). (2)
 STRINGS: automatically infer partition key name(s). All types are interpreted as strings. Not
 all storage formats support hive partitioning. Requesting hive partitioning on an unsupported
 format will lead to an error. Currently supported types include: AVRO, CSV, JSON, ORC and
 Parquet.

Parameters:
mode - mode or null for none








getSourceUriPrefix
public String getSourceUriPrefix()
[Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all
 source uris should be supplied. The prefix must end immediately before the partition key
 encoding begins. For example, consider files following this data layout.
 gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro
 gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is
 requested with either AUTO or STRINGS detection, the common prefix can be either of
 gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

Returns:
value or null for none








setSourceUriPrefix
public HivePartitioningOptions setSourceUriPrefix(String sourceUriPrefix)
[Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all
 source uris should be supplied. The prefix must end immediately before the partition key
 encoding begins. For example, consider files following this data layout.
 gs://bucket/path_to_table/dt=2019-01-01/country=BR/id=7/file.avro
 gs://bucket/path_to_table/dt=2018-12-31/country=CA/id=3/file.avro When hive partitioning is
 requested with either AUTO or STRINGS detection, the common prefix can be either of
 gs://bucket/path_to_table or gs://bucket/path_to_table/ (trailing slash does not matter).

Parameters:
sourceUriPrefix - sourceUriPrefix or null for none








set
public HivePartitioningOptions set(String fieldName,
                                   Object value)

Overrides:
set in class GenericJson








clone
public HivePartitioningOptions clone()

Overrides:
clone in class GenericJson














Skip navigation links




Overview
Package
Class
Use
Tree
Deprecated
Index
Help




Prev Class
Next Class


Frames
No Frames


All Classes






Summary: 
Nested | 
Field | 
Constr | 
Method


Detail: 
Field | 
Constr | 
Method






Copyright © 2011–2019 Google. All rights reserved.

Modifier and Type	Method and Description
`HivePartitioningOptions`	`clone()`
`String`	`getMode()` [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data.
`String`	`getSourceUriPrefix()` [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied.
`HivePartitioningOptions`	`set(String fieldName, Object value)`
`HivePartitioningOptions`	`setMode(String mode)` [Optional, Trusted Tester] When set, what mode of hive partitioning to use when reading data.
`HivePartitioningOptions`	`setSourceUriPrefix(String sourceUriPrefix)` [Optional, Trusted Tester] When hive partition detection is requested, a common prefix for all source uris should be supplied.