# Interface HiveCatalogOrBuilder (0.79.0)

0.79.0 (latest) 0.76.0 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 interface HiveCatalogOrBuilder extends MessageOrBuilder

## Implements

[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)

## Methods

### getDescription()

    public abstract String getDescription()

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

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The description. |

### getDescriptionBytes()

    public abstract ByteString getDescriptionBytes()

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

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

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for description. |

### getLocationUri()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The locationUri. |

### getLocationUriBytes()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for locationUri. |

### getName()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/lang/String.html` | The name. |

### getNameBytes()

    public abstract 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** |
| `https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.ByteString.html` | The bytes for name. |

### getReplicas(int index)

    public abstract 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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-biglake/latest/com.google.cloud.biglake.hive.v1beta.HiveCatalog.Replica` |   |

### getReplicasCount()

    public abstract 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** |
| `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |   |

### getReplicasList()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<https://docs.cloud.google.com/java/docs/reference/google-cloud-biglake/latest/com.google.cloud.biglake.hive.v1beta.HiveCatalog.Replica>` |   |

### getReplicasOrBuilder(int index)

    public abstract 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` | `https://docs.oracle.com/javase/tutorial/java/nutsandbolts/datatypes.html` |

| **Returns** ||
|---|---|
| **Type** | **Description** |
| `https://docs.cloud.google.com/java/docs/reference/google-cloud-biglake/latest/com.google.cloud.biglake.hive.v1beta.HiveCatalog.ReplicaOrBuilder` |   |

### getReplicasOrBuilderList()

    public abstract 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** |
| `https://docs.oracle.com/javase/8/docs/api/java/util/List.html<? extends com.google.cloud.biglake.hive.v1beta.HiveCatalog.ReplicaOrBuilder>` |   |