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 com.google.api.client.json.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

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
HivePartitioningOptions()

Method Summary

Modifier and Type	Method and Description
HivePartitioningOptions	clone()
List<String>	getFields() [Output-only] For permanent external tables, this field is populated with the hive partition keys in the order they were inferred.
String	getMode() [Optional] When set, what mode of hive partitioning to use when reading data.
Boolean	getRequirePartitionFilter() [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
String	getSourceUriPrefix() [Optional] When hive partition detection is requested, a common prefix for all source uris should be supplied.
HivePartitioningOptions	set(String fieldName, Object value)
HivePartitioningOptions	setFields(List<String> fields) [Output-only] For permanent external tables, this field is populated with the hive partition keys in the order they were inferred.
HivePartitioningOptions	setMode(String mode) [Optional] When set, what mode of hive partitioning to use when reading data.
HivePartitioningOptions	setRequirePartitionFilter(Boolean requirePartitionFilter) [Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
HivePartitioningOptions	setSourceUriPrefix(String sourceUriPrefix) [Optional] 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

getFields

public List<String> getFields()

[Output-only] For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.

Returns:

value or null for none

setFields

public HivePartitioningOptions setFields(List<String> fields)

[Output-only] For permanent external tables, this field is populated with the hive partition keys in the order they were inferred. The types of the partition keys can be deduced by checking the table schema (which will include the partition keys). Not every API will populate this field in the output. For example, Tables.Get will populate it, but Tables.List will not contain this field.

Parameters:

fields - fields or null for none

getMode

public String getMode()

[Optional] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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] When set, what mode of hive partitioning to use when reading data. The following 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. (3) CUSTOM: partition key schema is encoded in the source URI prefix. 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

getRequirePartitionFilter

public Boolean getRequirePartitionFilter()

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

Returns:

value or null for none

setRequirePartitionFilter

public HivePartitioningOptions setRequirePartitionFilter(Boolean requirePartitionFilter)

[Optional] If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. Note that this field should only be true when creating a permanent external table or querying a temporary external table. Hive-partitioned loads with requirePartitionFilter explicitly set to true will fail.

Parameters:

requirePartitionFilter - requirePartitionFilter or null for none

getSourceUriPrefix

public String getSourceUriPrefix()

[Optional] 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] 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 com.google.api.client.json.GenericJson

clone

public HivePartitioningOptions clone()

Overrides:

clone in class com.google.api.client.json.GenericJson