Class HiveTable.Builder (0.76.0)

public static final class HiveTable.Builder extends GeneratedMessage.Builder<HiveTable.Builder> 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 Methods

getDescriptor()

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

Methods

addAllPartitionKeys(Iterable<? extends FieldSchema> values)

public HiveTable.Builder addAllPartitionKeys(Iterable<? extends FieldSchema> values)

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
values Iterable<? extends com.google.cloud.biglake.hive.v1beta.FieldSchema>
Returns
Type Description
HiveTable.Builder

addPartitionKeys(FieldSchema value)

public HiveTable.Builder addPartitionKeys(FieldSchema value)

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
value FieldSchema
Returns
Type Description
HiveTable.Builder

addPartitionKeys(FieldSchema.Builder builderForValue)

public HiveTable.Builder addPartitionKeys(FieldSchema.Builder builderForValue)

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
builderForValue FieldSchema.Builder
Returns
Type Description
HiveTable.Builder

addPartitionKeys(int index, FieldSchema value)

public HiveTable.Builder addPartitionKeys(int index, FieldSchema value)

Optional. The partition keys of the table.

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

Parameters
Name Description
index int
value FieldSchema
Returns
Type Description
HiveTable.Builder

addPartitionKeys(int index, FieldSchema.Builder builderForValue)

public HiveTable.Builder addPartitionKeys(int index, FieldSchema.Builder builderForValue)

Optional. The partition keys of the table.

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

Parameters
Name Description
index int
builderForValue FieldSchema.Builder
Returns
Type Description
HiveTable.Builder

addPartitionKeysBuilder()

public FieldSchema.Builder addPartitionKeysBuilder()

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
FieldSchema.Builder

addPartitionKeysBuilder(int index)

public FieldSchema.Builder addPartitionKeysBuilder(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.Builder

build()

public HiveTable build()
Returns
Type Description
HiveTable

buildPartial()

public HiveTable buildPartial()
Returns
Type Description
HiveTable

clear()

public HiveTable.Builder clear()
Returns
Type Description
HiveTable.Builder
Overrides

clearCreateTime()

public HiveTable.Builder clearCreateTime()

Output only. The creation time of the table.

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

Returns
Type Description
HiveTable.Builder

clearDescription()

public HiveTable.Builder clearDescription()

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

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

Returns
Type Description
HiveTable.Builder

This builder for chaining.

clearName()

public HiveTable.Builder clearName()

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
HiveTable.Builder

This builder for chaining.

clearParameters()

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

clearPartitionKeys()

public HiveTable.Builder clearPartitionKeys()

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
HiveTable.Builder

clearStorageDescriptor()

public HiveTable.Builder clearStorageDescriptor()

Required. Storage descriptor of the table.

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

Returns
Type Description
HiveTable.Builder

clearTableType()

public HiveTable.Builder clearTableType()

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
HiveTable.Builder

This builder for chaining.

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

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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The creation time of the table.

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

Returns
Type Description
Builder

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getMutableParameters() (deprecated)

public Map<String,String> getMutableParameters()

Use alternate mutation accessors instead.

Returns
Type Description
Map<String,String>

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

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

getPartitionKeysBuilder(int index)

public FieldSchema.Builder getPartitionKeysBuilder(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.Builder

getPartitionKeysBuilderList()

public List<FieldSchema.Builder> getPartitionKeysBuilderList()

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

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>

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.

getStorageDescriptorBuilder()

public StorageDescriptor.Builder getStorageDescriptorBuilder()

Required. Storage descriptor of the table.

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

Returns
Type Description
StorageDescriptor.Builder

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.

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.Builder.internalGetMapFieldReflection(int)

internalGetMutableMapFieldReflection(int number)

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public HiveTable.Builder mergeCreateTime(Timestamp value)

Output only. The creation time of the table.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
HiveTable.Builder

mergeFrom(HiveTable other)

public HiveTable.Builder mergeFrom(HiveTable other)
Parameter
Name Description
other HiveTable
Returns
Type Description
HiveTable.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HiveTable.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
HiveTable.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public HiveTable.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
HiveTable.Builder
Overrides

mergeStorageDescriptor(StorageDescriptor value)

public HiveTable.Builder mergeStorageDescriptor(StorageDescriptor value)

Required. Storage descriptor of the table.

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

Parameter
Name Description
value StorageDescriptor
Returns
Type Description
HiveTable.Builder

putAllParameters(Map<String,String> values)

public HiveTable.Builder putAllParameters(Map<String,String> values)

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
values Map<String,String>
Returns
Type Description
HiveTable.Builder

putParameters(String key, String value)

public HiveTable.Builder putParameters(String key, String value)

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
value String
Returns
Type Description
HiveTable.Builder

removeParameters(String key)

public HiveTable.Builder removeParameters(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
HiveTable.Builder

removePartitionKeys(int index)

public HiveTable.Builder removePartitionKeys(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
HiveTable.Builder

setCreateTime(Timestamp value)

public HiveTable.Builder setCreateTime(Timestamp value)

Output only. The creation time of the table.

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

Parameter
Name Description
value Timestamp
Returns
Type Description
HiveTable.Builder

setCreateTime(Timestamp.Builder builderForValue)

public HiveTable.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The creation time of the table.

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

Parameter
Name Description
builderForValue Builder
Returns
Type Description
HiveTable.Builder

setDescription(String value)

public HiveTable.Builder setDescription(String value)

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

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

Parameter
Name Description
value String

The description to set.

Returns
Type Description
HiveTable.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public HiveTable.Builder setDescriptionBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for description to set.

Returns
Type Description
HiveTable.Builder

This builder for chaining.

setName(String value)

public HiveTable.Builder setName(String value)

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) = { ... }

Parameter
Name Description
value String

The name to set.

Returns
Type Description
HiveTable.Builder

This builder for chaining.

setNameBytes(ByteString value)

public HiveTable.Builder setNameBytes(ByteString value)

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) = { ... }

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
HiveTable.Builder

This builder for chaining.

setPartitionKeys(int index, FieldSchema value)

public HiveTable.Builder setPartitionKeys(int index, FieldSchema value)

Optional. The partition keys of the table.

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

Parameters
Name Description
index int
value FieldSchema
Returns
Type Description
HiveTable.Builder

setPartitionKeys(int index, FieldSchema.Builder builderForValue)

public HiveTable.Builder setPartitionKeys(int index, FieldSchema.Builder builderForValue)

Optional. The partition keys of the table.

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

Parameters
Name Description
index int
builderForValue FieldSchema.Builder
Returns
Type Description
HiveTable.Builder

setStorageDescriptor(StorageDescriptor value)

public HiveTable.Builder setStorageDescriptor(StorageDescriptor value)

Required. Storage descriptor of the table.

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

Parameter
Name Description
value StorageDescriptor
Returns
Type Description
HiveTable.Builder

setStorageDescriptor(StorageDescriptor.Builder builderForValue)

public HiveTable.Builder setStorageDescriptor(StorageDescriptor.Builder builderForValue)

Required. Storage descriptor of the table.

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

Parameter
Name Description
builderForValue StorageDescriptor.Builder
Returns
Type Description
HiveTable.Builder

setTableType(String value)

public HiveTable.Builder setTableType(String value)

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

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

Parameter
Name Description
value String

The tableType to set.

Returns
Type Description
HiveTable.Builder

This builder for chaining.

setTableTypeBytes(ByteString value)

public HiveTable.Builder setTableTypeBytes(ByteString value)

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

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

Parameter
Name Description
value ByteString

The bytes for tableType to set.

Returns
Type Description
HiveTable.Builder

This builder for chaining.