target.apidocs.com.google.api.services.bigquery.model.TimePartitioning.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







TimePartitioning (BigQuery API v2-rev20201022-1.30.10)











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

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


TimePartitioning
clone() 


Long
getExpirationMs()
[Optional] Number of milliseconds for which to keep the storage for partitions in the table.



String
getField()
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either
 '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type.



Boolean
getRequirePartitionFilter() 


String
getType()
[Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one
 partition per day, hour, month, and year, respectively.



TimePartitioning
set(String fieldName,
   Object value) 


TimePartitioning
setExpirationMs(Long expirationMs)
[Optional] Number of milliseconds for which to keep the storage for partitions in the table.



TimePartitioning
setField(String field)
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either
 '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type.



TimePartitioning
setRequirePartitionFilter(Boolean requirePartitionFilter) 


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.







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 partitions in the table.
 The storage in a partition will have an expiration time of its partition time plus this value.

Returns:
value or null for none








setExpirationMs
public TimePartitioning setExpirationMs(Long expirationMs)
[Optional] Number of milliseconds for which to keep the storage for partitions in the table.
 The storage in a partition will have an expiration time of its partition time plus this value.

Parameters:
expirationMs - expirationMs or null for none








getField
public String getField()
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either
 '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified,
 the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE
 field. Its mode must be NULLABLE or REQUIRED.

Returns:
value or null for none








setField
public TimePartitioning setField(String field)
[Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either
 '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type. If field is specified,
 the table is instead partitioned by this field. The field must be a top-level TIMESTAMP or DATE
 field. Its mode must be NULLABLE or REQUIRED.

Parameters:
field - field or null for none








getRequirePartitionFilter
public Boolean getRequirePartitionFilter()

Returns:
value or null for none








setRequirePartitionFilter
public TimePartitioning setRequirePartitionFilter(Boolean requirePartitionFilter)

Parameters:
requirePartitionFilter - requirePartitionFilter or null for none








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. When the type is not specified, the
 default behavior is DAY.

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. When the type is not specified, the
 default behavior is DAY.

Parameters:
type - type or null for none








set
public TimePartitioning set(String fieldName,
                            Object value)

Overrides:
set in class GenericJson








clone
public TimePartitioning 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–2020 Google. All rights reserved.

Modifier and Type	Method and Description
`TimePartitioning`	`clone()`
`Long`	`getExpirationMs()` [Optional] Number of milliseconds for which to keep the storage for partitions in the table.
`String`	`getField()` [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type.
`Boolean`	`getRequirePartitionFilter()`
`String`	`getType()` [Required] The supported types are DAY, HOUR, MONTH, and YEAR, which will generate one partition per day, hour, month, and year, respectively.
`TimePartitioning`	`set(String fieldName, Object value)`
`TimePartitioning`	`setExpirationMs(Long expirationMs)` [Optional] Number of milliseconds for which to keep the storage for partitions in the table.
`TimePartitioning`	`setField(String field)` [Beta] [Optional] If not set, the table is partitioned by pseudo column, referenced via either '_PARTITIONTIME' as TIMESTAMP type, or '_PARTITIONDATE' as DATE type.
`TimePartitioning`	`setRequirePartitionFilter(Boolean requirePartitionFilter)`
`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.