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

Show newest version







BigtableColumn (BigQuery API v2-rev20240727-2.0.0)











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 BigtableColumn



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













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




public final class BigtableColumn
extends com.google.api.client.json.GenericJson
Information related to a Bigtable column.

  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


BigtableColumn() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BigtableColumn
clone() 


byte[]
decodeQualifierEncoded()
[Required] Qualifier of the column.



BigtableColumn
encodeQualifierEncoded(byte[] qualifierEncoded)
[Required] Qualifier of the column.



String
getEncoding()
Optional.



String
getFieldName()
Optional.



Boolean
getOnlyReadLatest()
Optional.



String
getQualifierEncoded()
[Required] Qualifier of the column.



String
getQualifierString()
Qualifier string.



String
getType()
Optional.



BigtableColumn
set(String fieldName,
   Object value) 


BigtableColumn
setEncoding(String encoding)
Optional.



BigtableColumn
setFieldName(String fieldName)
Optional.



BigtableColumn
setOnlyReadLatest(Boolean onlyReadLatest)
Optional.



BigtableColumn
setQualifierEncoded(String qualifierEncoded)
[Required] Qualifier of the column.



BigtableColumn
setQualifierString(String qualifierString)
Qualifier string.



BigtableColumn
setType(String type)
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














Constructor Detail





BigtableColumn
public BigtableColumn()









Method Detail





getEncoding
public String getEncoding()
Optional. The encoding of the values when the type is not STRING. Acceptable encoding values
 are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are
 encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column
 family level. However, the setting at this level takes precedence if 'encoding' is set at both
 levels.

Returns:
value or null for none








setEncoding
public BigtableColumn setEncoding(String encoding)
Optional. The encoding of the values when the type is not STRING. Acceptable encoding values
 are: TEXT - indicates values are alphanumeric text strings. BINARY - indicates values are
 encoded using HBase Bytes.toBytes family of functions. 'encoding' can also be set at the column
 family level. However, the setting at this level takes precedence if 'encoding' is set at both
 levels.

Parameters:
encoding - encoding or null for none








getFieldName
public String getFieldName()
Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match
 a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name
 in queries.

Returns:
value or null for none








setFieldName
public BigtableColumn setFieldName(String fieldName)
Optional. If the qualifier is not a valid BigQuery field identifier i.e. does not match
 a-zA-Z*, a valid identifier must be provided as the column field name and is used as field name
 in queries.

Parameters:
fieldName - fieldName or null for none








getOnlyReadLatest
public Boolean getOnlyReadLatest()
Optional. If this is set, only the latest version of value in this column are exposed.
 'onlyReadLatest' can also be set at the column family level. However, the setting at this level
 takes precedence if 'onlyReadLatest' is set at both levels.

Returns:
value or null for none








setOnlyReadLatest
public BigtableColumn setOnlyReadLatest(Boolean onlyReadLatest)
Optional. If this is set, only the latest version of value in this column are exposed.
 'onlyReadLatest' can also be set at the column family level. However, the setting at this level
 takes precedence if 'onlyReadLatest' is set at both levels.

Parameters:
onlyReadLatest - onlyReadLatest or null for none








getQualifierEncoded
public String getQualifierEncoded()
[Required] Qualifier of the column. Columns in the parent column family that has this exact
 qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified
 in the qualifier_string field. Otherwise, a base-64 encoded value must be set to
 qualifier_encoded. The column field name is the same as the column qualifier. However, if the
 qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid
 identifier must be provided as field_name.

Returns:
value or null for none
See Also:
decodeQualifierEncoded()








decodeQualifierEncoded
public byte[] decodeQualifierEncoded()
[Required] Qualifier of the column. Columns in the parent column family that has this exact
 qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified
 in the qualifier_string field. Otherwise, a base-64 encoded value must be set to
 qualifier_encoded. The column field name is the same as the column qualifier. However, if the
 qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid
 identifier must be provided as field_name.

Returns:
Base64 decoded value or null for none
Since:
1.14
See Also:
getQualifierEncoded()








setQualifierEncoded
public BigtableColumn setQualifierEncoded(String qualifierEncoded)
[Required] Qualifier of the column. Columns in the parent column family that has this exact
 qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified
 in the qualifier_string field. Otherwise, a base-64 encoded value must be set to
 qualifier_encoded. The column field name is the same as the column qualifier. However, if the
 qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid
 identifier must be provided as field_name.

Parameters:
qualifierEncoded - qualifierEncoded or null for none
See Also:
#encodeQualifierEncoded()








encodeQualifierEncoded
public BigtableColumn encodeQualifierEncoded(byte[] qualifierEncoded)
[Required] Qualifier of the column. Columns in the parent column family that has this exact
 qualifier are exposed as `.` field. If the qualifier is valid UTF-8 string, it can be specified
 in the qualifier_string field. Otherwise, a base-64 encoded value must be set to
 qualifier_encoded. The column field name is the same as the column qualifier. However, if the
 qualifier is not a valid BigQuery field identifier i.e. does not match a-zA-Z*, a valid
 identifier must be provided as field_name.

Since:
1.14
See Also:

 The value is encoded Base64 or {@code null} for none.
 








getQualifierString
public String getQualifierString()
Qualifier string.

Returns:
value or null for none








setQualifierString
public BigtableColumn setQualifierString(String qualifierString)
Qualifier string.

Parameters:
qualifierString - qualifierString or null for none








getType
public String getType()
Optional. The type to convert the value in cells of this column. The values are expected to be
 encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following
 BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN *
 JSON Default type is BYTES. 'type' can also be set at the column family level. However, the
 setting at this level takes precedence if 'type' is set at both levels.

Returns:
value or null for none








setType
public BigtableColumn setType(String type)
Optional. The type to convert the value in cells of this column. The values are expected to be
 encoded using HBase Bytes.toBytes function when using the BINARY encoding value. Following
 BigQuery types are allowed (case-sensitive): * BYTES * STRING * INTEGER * FLOAT * BOOLEAN *
 JSON Default type is BYTES. 'type' can also be set at the column family level. However, the
 setting at this level takes precedence if 'type' is set at both levels.

Parameters:
type - type or null for none








set
public BigtableColumn set(String fieldName,
                          Object value)

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








clone
public BigtableColumn clone()

Overrides:
clone in class com.google.api.client.json.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–2024 Google. All rights reserved.

Modifier and Type	Method and Description
`BigtableColumn`	`clone()`
`byte[]`	`decodeQualifierEncoded()` [Required] Qualifier of the column.
`BigtableColumn`	`encodeQualifierEncoded(byte[] qualifierEncoded)` [Required] Qualifier of the column.
`String`	`getEncoding()` Optional.
`String`	`getFieldName()` Optional.
`Boolean`	`getOnlyReadLatest()` Optional.
`String`	`getQualifierEncoded()` [Required] Qualifier of the column.
`String`	`getQualifierString()` Qualifier string.
`String`	`getType()` Optional.
`BigtableColumn`	`set(String fieldName, Object value)`
`BigtableColumn`	`setEncoding(String encoding)` Optional.
`BigtableColumn`	`setFieldName(String fieldName)` Optional.
`BigtableColumn`	`setOnlyReadLatest(Boolean onlyReadLatest)` Optional.
`BigtableColumn`	`setQualifierEncoded(String qualifierEncoded)` [Required] Qualifier of the column.
`BigtableColumn`	`setQualifierString(String qualifierString)` Qualifier string.
`BigtableColumn`	`setType(String type)` Optional.