Class HiveCatalog.Builder (0.76.0)

0.76.0 (latest) 0.75.0 0.73.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.62.0 0.61.0 0.60.0 0.58.0 0.56.0 0.55.0 0.52.0 0.51.0 0.50.0 0.48.0 0.47.0 0.46.0 0.45.0 0.44.0 0.43.0 0.42.0 0.41.0 0.40.0 0.39.0 0.37.0 0.36.0 0.35.0 0.34.0 0.33.0 0.32.0 0.31.0 0.30.0 0.29.0 0.28.0 0.27.0 0.25.0 0.24.0 0.23.0 0.22.0 0.21.0 0.20.0 0.19.0 0.18.0 0.17.0 0.16.0 0.15.0 0.12.0 0.11.0 0.10.0 0.9.0 0.8.0 0.7.0 0.6.0 0.5.0 0.4.0 0.3.0 0.2.0 0.1.0

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

Inheritance

java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > HiveCatalog.Builder

Implements

HiveCatalogOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessage.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.clear()

GeneratedMessage.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.clone()

GeneratedMessage.Builder.getAllFields()

GeneratedMessage.Builder.getDescriptorForType()

GeneratedMessage.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.getParentForChildren()

GeneratedMessage.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessage.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessage.Builder.getUnknownFieldSetBuilder()

GeneratedMessage.Builder.getUnknownFields()

GeneratedMessage.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.Builder.internalGetFieldAccessorTable()

GeneratedMessage.Builder.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMapFieldReflection(int)

GeneratedMessage.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessage.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessage.Builder.isClean()

GeneratedMessage.Builder.isInitialized()

GeneratedMessage.Builder.markClean()

GeneratedMessage.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessage.Builder.mergeUnknownVarintField(int,int)

GeneratedMessage.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessage.Builder.onBuilt()

GeneratedMessage.Builder.onChanged()

com.google.protobuf.GeneratedMessage.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessage.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessage.Builder.setUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessage.Builder.setUnknownFieldsProto3(com.google.protobuf.UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addAllReplicas(Iterable<? extends HiveCatalog.Replica> values)

public HiveCatalog.Builder addAllReplicas(Iterable<? extends HiveCatalog.Replica> values)

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
values	Iterable<? extends com.google.cloud.biglake.hive.v1beta.HiveCatalog.Replica>

Returns
Type	Description
HiveCatalog.Builder

addReplicas(HiveCatalog.Replica value)

public HiveCatalog.Builder addReplicas(HiveCatalog.Replica value)

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
value	HiveCatalog.Replica

Returns
Type	Description
HiveCatalog.Builder

addReplicas(HiveCatalog.Replica.Builder builderForValue)

public HiveCatalog.Builder addReplicas(HiveCatalog.Replica.Builder builderForValue)

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
builderForValue	HiveCatalog.Replica.Builder

Returns
Type	Description
HiveCatalog.Builder

addReplicas(int index, HiveCatalog.Replica value)

public HiveCatalog.Builder addReplicas(int index, HiveCatalog.Replica value)

Output only. The replicas for the catalog metadata.

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

Parameters
Name	Description
index	int
value	HiveCatalog.Replica

Returns
Type	Description
HiveCatalog.Builder

addReplicas(int index, HiveCatalog.Replica.Builder builderForValue)

public HiveCatalog.Builder addReplicas(int index, HiveCatalog.Replica.Builder builderForValue)

Output only. The replicas for the catalog metadata.

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

Parameters
Name	Description
index	int
builderForValue	HiveCatalog.Replica.Builder

Returns
Type	Description
HiveCatalog.Builder

addReplicasBuilder()

public HiveCatalog.Replica.Builder addReplicasBuilder()

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
HiveCatalog.Replica.Builder

addReplicasBuilder(int index)

public HiveCatalog.Replica.Builder addReplicasBuilder(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.Builder

build()

public HiveCatalog build()

Returns
Type	Description
HiveCatalog

buildPartial()

public HiveCatalog buildPartial()

Returns
Type	Description
HiveCatalog

clear()

public HiveCatalog.Builder clear()

Returns
Type	Description
HiveCatalog.Builder

Overrides

GeneratedMessage.Builder<BuilderType>.clear()

clearDescription()

public HiveCatalog.Builder clearDescription()

Optional. Stores the catalog description. The maximum length is 4000 characters.

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

Returns
Type	Description
HiveCatalog.Builder	This builder for chaining.

clearLocationUri()

public HiveCatalog.Builder clearLocationUri()

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
HiveCatalog.Builder	This builder for chaining.

clearName()

public HiveCatalog.Builder clearName()

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
HiveCatalog.Builder	This builder for chaining.

clearReplicas()

public HiveCatalog.Builder clearReplicas()

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

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.

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessage.Builder<BuilderType>.getDescriptorForType()

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.

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

getReplicasBuilder(int index)

public HiveCatalog.Replica.Builder getReplicasBuilder(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.Builder

getReplicasBuilderList()

public List<HiveCatalog.Replica.Builder> getReplicasBuilderList()

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

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>

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.Builder<BuilderType>.isInitialized()

mergeFrom(HiveCatalog other)

public HiveCatalog.Builder mergeFrom(HiveCatalog other)

Parameter
Name	Description
other	HiveCatalog

Returns
Type	Description
HiveCatalog.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public HiveCatalog.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
HiveCatalog.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public HiveCatalog.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
HiveCatalog.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

removeReplicas(int index)

public HiveCatalog.Builder removeReplicas(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.Builder

setDescription(String value)

public HiveCatalog.Builder setDescription(String value)

Optional. Stores the catalog description. 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
HiveCatalog.Builder	This builder for chaining.

setDescriptionBytes(ByteString value)

public HiveCatalog.Builder setDescriptionBytes(ByteString value)

Optional. Stores the catalog description. 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
HiveCatalog.Builder	This builder for chaining.

setLocationUri(String value)

public HiveCatalog.Builder setLocationUri(String value)

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];

Parameter
Name	Description
value	String The locationUri to set.

Returns
Type	Description
HiveCatalog.Builder	This builder for chaining.

setLocationUriBytes(ByteString value)

public HiveCatalog.Builder setLocationUriBytes(ByteString value)

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];

Parameter
Name	Description
value	ByteString The bytes for locationUri to set.

Returns
Type	Description
HiveCatalog.Builder	This builder for chaining.

setName(String value)

public HiveCatalog.Builder setName(String value)

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

Parameter
Name	Description
value	String The name to set.

Returns
Type	Description
HiveCatalog.Builder	This builder for chaining.

setNameBytes(ByteString value)

public HiveCatalog.Builder setNameBytes(ByteString value)

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

Parameter
Name	Description
value	ByteString The bytes for name to set.

Returns
Type	Description
HiveCatalog.Builder	This builder for chaining.

setReplicas(int index, HiveCatalog.Replica value)

public HiveCatalog.Builder setReplicas(int index, HiveCatalog.Replica value)

Output only. The replicas for the catalog metadata.

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

Parameters
Name	Description
index	int
value	HiveCatalog.Replica

Returns
Type	Description
HiveCatalog.Builder

setReplicas(int index, HiveCatalog.Replica.Builder builderForValue)

public HiveCatalog.Builder setReplicas(int index, HiveCatalog.Replica.Builder builderForValue)

Output only. The replicas for the catalog metadata.

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

Parameters
Name	Description
index	int
builderForValue	HiveCatalog.Replica.Builder

Returns
Type	Description
HiveCatalog.Builder