Class HiveCatalog (0.76.0)

public final class HiveCatalog extends GeneratedMessage implements HiveCatalogOrBuilder

The HiveCatalog contains spark/hive databases and tables in the BigLake Metastore. While creating resources under a catalog, ideally ensure that the storage bucket location, spark / hive engine location or any other compute location match. Catalog can be viewed as the destination for migrating an on-prem Hive metastore to GCP.

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

Static Fields

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

LOCATION_URI_FIELD_NUMBER

public static final int LOCATION_URI_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

REPLICAS_FIELD_NUMBER

public static final int REPLICAS_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static HiveCatalog getDefaultInstance()
Returns
Type Description
HiveCatalog

getDescriptor()

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

newBuilder()

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

newBuilder(HiveCatalog prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public HiveCatalog getDefaultInstanceForType()
Returns
Type Description
HiveCatalog

getDescription()

public String getDescription()

Optional. Stores the catalog description. 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. Stores the catalog description. The maximum length is 4000 characters.

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

Returns
Type Description
ByteString

The bytes for description.

getLocationUri()

public String getLocationUri()

Required. The Cloud Storage location path where the catalog exists. Format: gs://bucket/path/to/catalog The maximum length is 4000 characters.

string location_uri = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The locationUri.

getLocationUriBytes()

public ByteString getLocationUriBytes()

Required. The Cloud Storage location path where the catalog exists. Format: gs://bucket/path/to/catalog The maximum length is 4000 characters.

string location_uri = 3 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for locationUri.

getName()

public String getName()

Output only. The resource name. Format: projects/{project_id_or_number}/catalogs/{catalog_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}

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

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

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

getReplicas(int index)

public HiveCatalog.Replica getReplicas(int index)

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.hive.v1beta.HiveCatalog.Replica replicas = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
HiveCatalog.Replica

getReplicasCount()

public int getReplicasCount()

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.hive.v1beta.HiveCatalog.Replica replicas = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

getReplicasList()

public List<HiveCatalog.Replica> getReplicasList()

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.hive.v1beta.HiveCatalog.Replica replicas = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<Replica>

getReplicasOrBuilder(int index)

public HiveCatalog.ReplicaOrBuilder getReplicasOrBuilder(int index)

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.hive.v1beta.HiveCatalog.Replica replicas = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int
Returns
Type Description
HiveCatalog.ReplicaOrBuilder

getReplicasOrBuilderList()

public List<? extends HiveCatalog.ReplicaOrBuilder> getReplicasOrBuilderList()

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.hive.v1beta.HiveCatalog.Replica replicas = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

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

newBuilderForType(AbstractMessage.BuilderParent parent)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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