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







BigtableColumnFamily (BigQuery API v2-rev20240905-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 BigtableColumnFamily



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













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




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

  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


BigtableColumnFamily() 









Method Summary

All Methods Instance Methods Concrete Methods 

Modifier and Type
Method and Description


BigtableColumnFamily
clone() 


List<BigtableColumn>
getColumns()
Optional.



String
getEncoding()
Optional.



String
getFamilyId()
Identifier of the column family.



Boolean
getOnlyReadLatest()
Optional.



String
getType()
Optional.



BigtableColumnFamily
set(String fieldName,
   Object value) 


BigtableColumnFamily
setColumns(List<BigtableColumn> columns)
Optional.



BigtableColumnFamily
setEncoding(String encoding)
Optional.



BigtableColumnFamily
setFamilyId(String familyId)
Identifier of the column family.



BigtableColumnFamily
setOnlyReadLatest(Boolean onlyReadLatest)
Optional.



BigtableColumnFamily
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





BigtableColumnFamily
public BigtableColumnFamily()









Method Detail





getColumns
public List<BigtableColumn> getColumns()
Optional. Lists of columns that should be exposed as individual fields as opposed to a list of
 (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be
 accessed as `.`. Other columns can be accessed as a list through the `.Column` field.

Returns:
value or null for none








setColumns
public BigtableColumnFamily setColumns(List<BigtableColumn> columns)
Optional. Lists of columns that should be exposed as individual fields as opposed to a list of
 (column name, value) pairs. All columns whose qualifier matches a qualifier in this list can be
 accessed as `.`. Other columns can be accessed as a list through the `.Column` field.

Parameters:
columns - columns or null for none








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. This can be overridden for a specific
 column by listing that column in 'columns' and specifying an encoding for it.

Returns:
value or null for none








setEncoding
public BigtableColumnFamily 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. This can be overridden for a specific
 column by listing that column in 'columns' and specifying an encoding for it.

Parameters:
encoding - encoding or null for none








getFamilyId
public String getFamilyId()
Identifier of the column family.

Returns:
value or null for none








setFamilyId
public BigtableColumnFamily setFamilyId(String familyId)
Identifier of the column family.

Parameters:
familyId - familyId or null for none








getOnlyReadLatest
public Boolean getOnlyReadLatest()
Optional. If this is set only the latest version of value are exposed for all columns in this
 column family. This can be overridden for a specific column by listing that column in 'columns'
 and specifying a different setting for that column.

Returns:
value or null for none








setOnlyReadLatest
public BigtableColumnFamily setOnlyReadLatest(Boolean onlyReadLatest)
Optional. If this is set only the latest version of value are exposed for all columns in this
 column family. This can be overridden for a specific column by listing that column in 'columns'
 and specifying a different setting for that column.

Parameters:
onlyReadLatest - onlyReadLatest or null for none








getType
public String getType()
Optional. The type to convert the value in cells of this column family. 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. This can be overridden for a specific column by listing
 that column in 'columns' and specifying a type for it.

Returns:
value or null for none








setType
public BigtableColumnFamily setType(String type)
Optional. The type to convert the value in cells of this column family. 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. This can be overridden for a specific column by listing
 that column in 'columns' and specifying a type for it.

Parameters:
type - type or null for none








set
public BigtableColumnFamily set(String fieldName,
                                Object value)

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








clone
public BigtableColumnFamily 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
`BigtableColumnFamily`	`clone()`
`List<BigtableColumn>`	`getColumns()` Optional.
`String`	`getEncoding()` Optional.
`String`	`getFamilyId()` Identifier of the column family.
`Boolean`	`getOnlyReadLatest()` Optional.
`String`	`getType()` Optional.
`BigtableColumnFamily`	`set(String fieldName, Object value)`
`BigtableColumnFamily`	`setColumns(List<BigtableColumn> columns)` Optional.
`BigtableColumnFamily`	`setEncoding(String encoding)` Optional.
`BigtableColumnFamily`	`setFamilyId(String familyId)` Identifier of the column family.
`BigtableColumnFamily`	`setOnlyReadLatest(Boolean onlyReadLatest)` Optional.
`BigtableColumnFamily`	`setType(String type)` Optional.