public interface IcebergCatalogOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getBiglakeServiceAccount()
public abstract String getBiglakeServiceAccount()Output only. The service account used for credential vending, output only. Might be empty if Credential vending was never enabled for the catalog. For federated catalogs, the service account will be always provisioned and will be used to access the remote Iceberg REST Catalog using access to Secret Manager secret or identity federation.
string biglake_service_account = 3 [json_name = "biglake-service-account", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The biglakeServiceAccount. |
getBiglakeServiceAccountBytes()
public abstract ByteString getBiglakeServiceAccountBytes()Output only. The service account used for credential vending, output only. Might be empty if Credential vending was never enabled for the catalog. For federated catalogs, the service account will be always provisioned and will be used to access the remote Iceberg REST Catalog using access to Secret Manager secret or identity federation.
string biglake_service_account = 3 [json_name = "biglake-service-account", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for biglakeServiceAccount. |
getBiglakeServiceAccountUniqueId()
public abstract String getBiglakeServiceAccountUniqueId()Output only. The unique ID of the service account. This is used for federation scenarios.
string biglake_service_account_unique_id = 14 [json_name = "biglake-service-account-id", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
String |
The biglakeServiceAccountUniqueId. |
getBiglakeServiceAccountUniqueIdBytes()
public abstract ByteString getBiglakeServiceAccountUniqueIdBytes()Output only. The unique ID of the service account. This is used for federation scenarios.
string biglake_service_account_unique_id = 14 [json_name = "biglake-service-account-id", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for biglakeServiceAccountUniqueId. |
getCatalogType()
public abstract IcebergCatalog.CatalogType getCatalogType()Required. The catalog type. Required for CreateIcebergCatalog.
.google.cloud.biglake.v1.IcebergCatalog.CatalogType catalog_type = 4 [json_name = "catalog-type", (.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.CatalogType |
The catalogType. |
getCatalogTypeValue()
public abstract int getCatalogTypeValue()Required. The catalog type. Required for CreateIcebergCatalog.
.google.cloud.biglake.v1.IcebergCatalog.CatalogType catalog_type = 4 [json_name = "catalog-type", (.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for catalogType. |
getCreateTime()
public abstract Timestamp getCreateTime()Output only. When the catalog was created.
.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The createTime. |
getCreateTimeOrBuilder()
public abstract TimestampOrBuilder getCreateTimeOrBuilder()Output only. When the catalog was created.
.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getCredentialMode()
public abstract IcebergCatalog.CredentialMode getCredentialMode()Optional. The credential mode for the catalog.
.google.cloud.biglake.v1.IcebergCatalog.CredentialMode credential_mode = 2 [json_name = "credential-mode", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.CredentialMode |
The credentialMode. |
getCredentialModeValue()
public abstract int getCredentialModeValue()Optional. The credential mode for the catalog.
.google.cloud.biglake.v1.IcebergCatalog.CredentialMode credential_mode = 2 [json_name = "credential-mode", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for credentialMode. |
getDefaultLocation()
public abstract String getDefaultLocation() Optional. The default storage location for the catalog, e.g.,
gs://my-bucket. For Google Cloud Storage bucket catalogs, this is output
only.
For BigLake catalogs, this field must be provided and point to a Google Cloud Storage bucket or a path within that bucket. This path serves as the base directory for constructing the full path to a table's data and metadata directories when a location is not specified at the namespace or table level. The full path is formed by appending the namespace and table identifiers to the default location.
string default_location = 5 [json_name = "default-location", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The defaultLocation. |
getDefaultLocationBytes()
public abstract ByteString getDefaultLocationBytes() Optional. The default storage location for the catalog, e.g.,
gs://my-bucket. For Google Cloud Storage bucket catalogs, this is output
only.
For BigLake catalogs, this field must be provided and point to a Google Cloud Storage bucket or a path within that bucket. This path serves as the base directory for constructing the full path to a table's data and metadata directories when a location is not specified at the namespace or table level. The full path is formed by appending the namespace and table identifiers to the default location.
string default_location = 5 [json_name = "default-location", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for defaultLocation. |
getDescription()
public abstract String getDescription()Optional. A user-provided description of the catalog. The description must be a UTF-8 string with a maximum length of 1024 characters.
string description = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public abstract ByteString getDescriptionBytes()Optional. A user-provided description of the catalog. The description must be a UTF-8 string with a maximum length of 1024 characters.
string description = 12 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getFederatedCatalogOptions()
public abstract IcebergCatalog.FederatedCatalogOptions getFederatedCatalogOptions()Optional. Configuration options for federated catalogs.
.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions federated_catalog_options = 13 [json_name = "federated-catalog-options", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions |
The federatedCatalogOptions. |
getFederatedCatalogOptionsOrBuilder()
public abstract IcebergCatalog.FederatedCatalogOptionsOrBuilder getFederatedCatalogOptionsOrBuilder()Optional. Configuration options for federated catalogs.
.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions federated_catalog_options = 13 [json_name = "federated-catalog-options", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptionsOrBuilder |
|
getName()
public abstract String getName() Identifier. The catalog name, projects/my-project/catalogs/my-catalog.
This field is immutable.
This field is ignored for CreateIcebergCatalog.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes() Identifier. The catalog name, projects/my-project/catalogs/my-catalog.
This field is immutable.
This field is ignored for CreateIcebergCatalog.
string name = 1 [(.google.api.field_behavior) = IDENTIFIER];
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for name. |
getReplicas(int index)
public abstract IcebergCatalog.Replica getReplicas(int index)Output only. The replicas for the catalog metadata.
repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.Replica |
|
getReplicasCount()
public abstract int getReplicasCount()Output only. The replicas for the catalog metadata.
repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
|
getReplicasList()
public abstract List<IcebergCatalog.Replica> getReplicasList()Output only. The replicas for the catalog metadata.
repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<Replica> |
|
getReplicasOrBuilder(int index)
public abstract IcebergCatalog.ReplicaOrBuilder getReplicasOrBuilder(int index)Output only. The replicas for the catalog metadata.
repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.ReplicaOrBuilder |
|
getReplicasOrBuilderList()
public abstract List<? extends IcebergCatalog.ReplicaOrBuilder> getReplicasOrBuilderList()Output only. The replicas for the catalog metadata.
repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.biglake.v1.IcebergCatalog.ReplicaOrBuilder> |
|
getRestrictedLocationsConfig()
public abstract IcebergCatalog.RestrictedLocationsConfig getRestrictedLocationsConfig()Optional. Restricted locations configuration. This field is currently only used for BigLake catalogs.
If this field is unset, or if
restricted_locations_config.restricted_locations is empty, all
accessible locations are allowed. If
restricted_locations_config.restricted_locations is not empty, only
locations in default_location and
restricted_locations_config.restricted_locations are allowed.
.google.cloud.biglake.v1.IcebergCatalog.RestrictedLocationsConfig restricted_locations_config = 15 [json_name = "restricted-locations-config", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.RestrictedLocationsConfig |
The restrictedLocationsConfig. |
getRestrictedLocationsConfigOrBuilder()
public abstract IcebergCatalog.RestrictedLocationsConfigOrBuilder getRestrictedLocationsConfigOrBuilder()Optional. Restricted locations configuration. This field is currently only used for BigLake catalogs.
If this field is unset, or if
restricted_locations_config.restricted_locations is empty, all
accessible locations are allowed. If
restricted_locations_config.restricted_locations is not empty, only
locations in default_location and
restricted_locations_config.restricted_locations are allowed.
.google.cloud.biglake.v1.IcebergCatalog.RestrictedLocationsConfig restricted_locations_config = 15 [json_name = "restricted-locations-config", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.RestrictedLocationsConfigOrBuilder |
|
getStorageRegions(int index)
public abstract String getStorageRegions(int index) Output only. The GCP region(s) of the default location's bucket, e.g.
us-central1, nam4 or us. This will contain one value for all
locations, except for the catalogs that are configured to use custom dual
region buckets, in which case it will contain the two regions of the
bucket. The region(s) of this field should be in the jurisdiction of or
nearby the primary location of the catalog.
repeated string storage_regions = 10 [json_name = "storage-regions", (.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The storageRegions at the given index. |
getStorageRegionsBytes(int index)
public abstract ByteString getStorageRegionsBytes(int index) Output only. The GCP region(s) of the default location's bucket, e.g.
us-central1, nam4 or us. This will contain one value for all
locations, except for the catalogs that are configured to use custom dual
region buckets, in which case it will contain the two regions of the
bucket. The region(s) of this field should be in the jurisdiction of or
nearby the primary location of the catalog.
repeated string storage_regions = 10 [json_name = "storage-regions", (.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the storageRegions at the given index. |
getStorageRegionsCount()
public abstract int getStorageRegionsCount() Output only. The GCP region(s) of the default location's bucket, e.g.
us-central1, nam4 or us. This will contain one value for all
locations, except for the catalogs that are configured to use custom dual
region buckets, in which case it will contain the two regions of the
bucket. The region(s) of this field should be in the jurisdiction of or
nearby the primary location of the catalog.
repeated string storage_regions = 10 [json_name = "storage-regions", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The count of storageRegions. |
getStorageRegionsList()
public abstract List<String> getStorageRegionsList() Output only. The GCP region(s) of the default location's bucket, e.g.
us-central1, nam4 or us. This will contain one value for all
locations, except for the catalogs that are configured to use custom dual
region buckets, in which case it will contain the two regions of the
bucket. The region(s) of this field should be in the jurisdiction of or
nearby the primary location of the catalog.
repeated string storage_regions = 10 [json_name = "storage-regions", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the storageRegions. |
getUpdateTime()
public abstract Timestamp getUpdateTime()Output only. When the catalog was last updated.
.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The updateTime. |
getUpdateTimeOrBuilder()
public abstract TimestampOrBuilder getUpdateTimeOrBuilder()Output only. When the catalog was last updated.
.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
hasCreateTime()
public abstract boolean hasCreateTime()Output only. When the catalog was created.
.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the createTime field is set. |
hasFederatedCatalogOptions()
public abstract boolean hasFederatedCatalogOptions()Optional. Configuration options for federated catalogs.
.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions federated_catalog_options = 13 [json_name = "federated-catalog-options", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the federatedCatalogOptions field is set. |
hasRestrictedLocationsConfig()
public abstract boolean hasRestrictedLocationsConfig()Optional. Restricted locations configuration. This field is currently only used for BigLake catalogs.
If this field is unset, or if
restricted_locations_config.restricted_locations is empty, all
accessible locations are allowed. If
restricted_locations_config.restricted_locations is not empty, only
locations in default_location and
restricted_locations_config.restricted_locations are allowed.
.google.cloud.biglake.v1.IcebergCatalog.RestrictedLocationsConfig restricted_locations_config = 15 [json_name = "restricted-locations-config", (.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the restrictedLocationsConfig field is set. |
hasUpdateTime()
public abstract boolean hasUpdateTime()Output only. When the catalog was last updated.
.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the updateTime field is set. |