Class HiveTable (0.76.0)

public final class HiveTable extends GeneratedMessage implements HiveTableOrBuilder

Stores the hive table information. It includes the table name, schema (column names and types), data location, storage format, serde info, etc. This message closely matches the Table object in the IMetastoreClient

Protobuf type google.cloud.biglake.hive.v1beta.HiveTable

Implements

HiveTableOrBuilder

Static Fields

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PARAMETERS_FIELD_NUMBER

public static final int PARAMETERS_FIELD_NUMBER
Field Value
Type Description
int

PARTITION_KEYS_FIELD_NUMBER

public static final int PARTITION_KEYS_FIELD_NUMBER
Field Value
Type Description
int

STORAGE_DESCRIPTOR_FIELD_NUMBER

public static final int STORAGE_DESCRIPTOR_FIELD_NUMBER
Field Value
Type Description
int

TABLE_TYPE_FIELD_NUMBER

public static final int TABLE_TYPE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HiveTable getDefaultInstance()
Returns
Type Description
HiveTable

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static HiveTable.Builder newBuilder()
Returns
Type Description
HiveTable.Builder

newBuilder(HiveTable prototype)

public static HiveTable.Builder newBuilder(HiveTable prototype)
Parameter
Name Description
prototype HiveTable
Returns
Type Description
HiveTable.Builder

parseDelimitedFrom(InputStream input)

public static HiveTable parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HiveTable
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HiveTable parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveTable
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static HiveTable parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
HiveTable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static HiveTable parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveTable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static HiveTable parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
HiveTable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static HiveTable parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveTable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static HiveTable parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
HiveTable
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static HiveTable parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveTable
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static HiveTable parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
HiveTable
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static HiveTable parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveTable
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static HiveTable parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
HiveTable
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static HiveTable parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveTable
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<HiveTable> parser()
Returns
Type Description
Parser<HiveTable>

Methods

containsParameters(String key)

public boolean containsParameters(String key)

Optional. Stores the properties associated with the table. The maximum size is 4MiB.

map<string, string> parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
boolean

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getCreateTime()

public Timestamp getCreateTime()

Output only. The creation time of the table.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The creation time of the table.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public HiveTable getDefaultInstanceForType()
Returns
Type Description
HiveTable

getDescription()

public String getDescription()

Optional. Description of the table. The maximum length is 4000 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Description of the table. The maximum length is 4000 characters.

string description = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for description.

getName()

public String getName()

Output only. The resource name. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. The resource name. Format: projects/{project_id_or_number}/catalogs/{catalog_id}/databases/{database_id}/tables/{table_id}

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for name.

getParameters() (deprecated)

public Map<String,String> getParameters()

Use #getParametersMap() instead.

Returns
Type Description
Map<String,String>

getParametersCount()

public int getParametersCount()

Optional. Stores the properties associated with the table. The maximum size is 4MiB.

map<string, string> parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getParametersMap()

public Map<String,String> getParametersMap()

Optional. Stores the properties associated with the table. The maximum size is 4MiB.

map<string, string> parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
Map<String,String>

getParametersOrDefault(String key, String defaultValue)

public String getParametersOrDefault(String key, String defaultValue)

Optional. Stores the properties associated with the table. The maximum size is 4MiB.

map<string, string> parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameters
Name Description
key String
defaultValue String
Returns
Type Description
String

getParametersOrThrow(String key)

public String getParametersOrThrow(String key)

Optional. Stores the properties associated with the table. The maximum size is 4MiB.

map<string, string> parameters = 8 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
key String
Returns
Type Description
String

getParserForType()

public Parser<HiveTable> getParserForType()
Returns
Type Description
Parser<HiveTable>
Overrides

getPartitionKeys(int index)

public FieldSchema getPartitionKeys(int index)

Optional. The partition keys of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema partition_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FieldSchema

getPartitionKeysCount()

public int getPartitionKeysCount()

Optional. The partition keys of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema partition_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getPartitionKeysList()

public List<FieldSchema> getPartitionKeysList()

Optional. The partition keys of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema partition_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<FieldSchema>

getPartitionKeysOrBuilder(int index)

public FieldSchemaOrBuilder getPartitionKeysOrBuilder(int index)

Optional. The partition keys of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema partition_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
FieldSchemaOrBuilder

getPartitionKeysOrBuilderList()

public List<? extends FieldSchemaOrBuilder> getPartitionKeysOrBuilderList()

Optional. The partition keys of the table.

repeated .google.cloud.biglake.hive.v1beta.FieldSchema partition_keys = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.biglake.hive.v1beta.FieldSchemaOrBuilder>

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStorageDescriptor()

public StorageDescriptor getStorageDescriptor()

Required. Storage descriptor of the table.

.google.cloud.biglake.hive.v1beta.StorageDescriptor storage_descriptor = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StorageDescriptor

The storageDescriptor.

getStorageDescriptorOrBuilder()

public StorageDescriptorOrBuilder getStorageDescriptorOrBuilder()

Required. Storage descriptor of the table.

.google.cloud.biglake.hive.v1beta.StorageDescriptor storage_descriptor = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
StorageDescriptorOrBuilder

getTableType()

public String getTableType()

Output only. The type of the table. This is EXTERNAL for BigLake hive tables.

string table_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The tableType.

getTableTypeBytes()

public ByteString getTableTypeBytes()

Output only. The type of the table. This is EXTERNAL for BigLake hive tables.

string table_type = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for tableType.

hasCreateTime()

public boolean hasCreateTime()

Output only. The creation time of the table.

.google.protobuf.Timestamp create_time = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasStorageDescriptor()

public boolean hasStorageDescriptor()

Required. Storage descriptor of the table.

.google.cloud.biglake.hive.v1beta.StorageDescriptor storage_descriptor = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the storageDescriptor field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

internalGetMapFieldReflection(int number)

protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
Parameter
Name Description
number int
Returns
Type Description
com.google.protobuf.MapFieldReflectionAccessor
Overrides
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public HiveTable.Builder newBuilderForType()
Returns
Type Description
HiveTable.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected HiveTable.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
HiveTable.Builder
Overrides

toBuilder()

public HiveTable.Builder toBuilder()
Returns
Type Description
HiveTable.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException