com.google.api.services.bigquery.model

Class TimePartitioning

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

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class TimePartitioning
extends com.google.api.client.json.GenericJson

Model definition for TimePartitioning.

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

Method Summary

Modifier and Type	Method and Description
TimePartitioning	clone()
Long	getExpirationMs() Optional.
String	getField() Optional.
Boolean	getRequirePartitionFilter() If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
String	getType() Required.
boolean	isRequirePartitionFilter() Convenience method that returns only Boolean.TRUE or Boolean.FALSE.
TimePartitioning	set(String fieldName, Object value)
TimePartitioning	setExpirationMs(Long expirationMs) Optional.
TimePartitioning	setField(String field) Optional.
TimePartitioning	setRequirePartitionFilter(Boolean requirePartitionFilter) If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified.
TimePartitioning	setType(String type) Required.

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

TimePartitioning

public TimePartitioning()

Method Detail

getExpirationMs

public Long getExpirationMs()

Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.

Returns:

value or null for none

setExpirationMs

public TimePartitioning setExpirationMs(Long expirationMs)

Optional. Number of milliseconds for which to keep the storage for a partition. A wrapper is used here because 0 is an invalid value.

Parameters:

expirationMs - expirationMs or null for none

getField

public String getField()

Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.

Returns:

value or null for none

setField

public TimePartitioning setField(String field)

Optional. If not set, the table is partitioned by pseudo column '_PARTITIONTIME'; if set, the table is partitioned by this field. The field must be a top-level TIMESTAMP or DATE field. Its mode must be NULLABLE or REQUIRED. A wrapper is used here because an empty string is an invalid value.

Parameters:

field - field or null for none

getRequirePartitionFilter

public Boolean getRequirePartitionFilter()

If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.

Returns:

value or null for none

setRequirePartitionFilter

public TimePartitioning setRequirePartitionFilter(Boolean requirePartitionFilter)

If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.

Parameters:

requirePartitionFilter - requirePartitionFilter or null for none

isRequirePartitionFilter

public boolean isRequirePartitionFilter()

Convenience method that returns only Boolean.TRUE or Boolean.FALSE.

Boolean properties can have four possible values: null, Data.NULL_BOOLEAN, Boolean.TRUE or Boolean.FALSE.

This method returns Boolean.TRUE if the default of the property is Boolean.TRUE and it is null or Data.NULL_BOOLEAN. Boolean.FALSE is returned if the default of the property is Boolean.FALSE and it is null or Data.NULL_BOOLEAN.

If set to true, queries over this table require a partition filter that can be used for partition elimination to be specified. This field is deprecated; please set the field with the same name on the table itself instead. This field needs a wrapper because we want to output the default value, false, if the user explicitly set it.

getType

public String getType()

Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.

Returns:

value or null for none

setType

public TimePartitioning setType(String type)

Required. The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.

Parameters:

type - type or null for none

set

public TimePartitioning set(String fieldName,
                            Object value)

Overrides:

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

clone

public TimePartitioning clone()

Overrides:

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