Class IcebergCatalog.Builder (0.83.0) 

public static final class IcebergCatalog.Builder extends GeneratedMessage.Builder<IcebergCatalog.Builder> implements IcebergCatalogOrBuilder

The Iceberg REST Catalog information.

Protobuf type google.cloud.biglake.v1.IcebergCatalog

Inheritance

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

Static Methods

getDescriptor()

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

Methods

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

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

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
values Iterable<? extends com.google.cloud.biglake.v1.IcebergCatalog.Replica>
Returns
Type Description
IcebergCatalog.Builder

addAllStorageRegions(Iterable<String> values)

public IcebergCatalog.Builder addAllStorageRegions(Iterable<String> values)

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
values Iterable<String>

The storageRegions to add.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

addReplicas(IcebergCatalog.Replica value)

public IcebergCatalog.Builder addReplicas(IcebergCatalog.Replica value)

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
value IcebergCatalog.Replica
Returns
Type Description
IcebergCatalog.Builder

addReplicas(IcebergCatalog.Replica.Builder builderForValue)

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

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
builderForValue IcebergCatalog.Replica.Builder
Returns
Type Description
IcebergCatalog.Builder

addReplicas(int index, IcebergCatalog.Replica value)

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

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value IcebergCatalog.Replica
Returns
Type Description
IcebergCatalog.Builder

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

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

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue IcebergCatalog.Replica.Builder
Returns
Type Description
IcebergCatalog.Builder

addReplicasBuilder()

public IcebergCatalog.Replica.Builder addReplicasBuilder()

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

addReplicasBuilder(int index)

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

addStorageRegions(String value)

public IcebergCatalog.Builder addStorageRegions(String value)

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
value String

The storageRegions to add.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

addStorageRegionsBytes(ByteString value)

public IcebergCatalog.Builder addStorageRegionsBytes(ByteString value)

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
value ByteString

The bytes of the storageRegions to add.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

build()

public IcebergCatalog build()
Returns
Type Description
IcebergCatalog

buildPartial()

public IcebergCatalog buildPartial()
Returns
Type Description
IcebergCatalog

clear()

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

clearBiglakeServiceAccount()

public IcebergCatalog.Builder clearBiglakeServiceAccount()

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

This builder for chaining.

clearBiglakeServiceAccountUniqueId()

public IcebergCatalog.Builder clearBiglakeServiceAccountUniqueId()

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

This builder for chaining.

clearCatalogType()

public IcebergCatalog.Builder clearCatalogType()

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

This builder for chaining.

clearCreateTime()

public IcebergCatalog.Builder clearCreateTime()

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

clearCredentialMode()

public IcebergCatalog.Builder clearCredentialMode()

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

This builder for chaining.

clearDefaultLocation()

public IcebergCatalog.Builder clearDefaultLocation()

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

This builder for chaining.

clearDescription()

public IcebergCatalog.Builder clearDescription()

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

This builder for chaining.

clearFederatedCatalogOptions()

public IcebergCatalog.Builder clearFederatedCatalogOptions()

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

clearName()

public IcebergCatalog.Builder clearName()

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

This builder for chaining.

clearReplicas()

public IcebergCatalog.Builder clearReplicas()

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

clearRestrictedLocationsConfig()

public IcebergCatalog.Builder clearRestrictedLocationsConfig()

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

clearStorageRegions()

public IcebergCatalog.Builder clearStorageRegions()

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

This builder for chaining.

clearUpdateTime()

public IcebergCatalog.Builder clearUpdateTime()

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

getBiglakeServiceAccount()

public 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 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 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 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 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 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 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.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

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
Builder

getCreateTimeOrBuilder()

public 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 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 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.

getDefaultInstanceForType()

public IcebergCatalog getDefaultInstanceForType()
Returns
Type Description
IcebergCatalog

getDefaultLocation()

public 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 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 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 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.

getDescriptorForType()

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

getFederatedCatalogOptions()

public 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.

getFederatedCatalogOptionsBuilder()

public IcebergCatalog.FederatedCatalogOptions.Builder getFederatedCatalogOptionsBuilder()

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

getFederatedCatalogOptionsOrBuilder()

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

getReplicasBuilder(int index)

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

getReplicasBuilderList()

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

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

getReplicasCount()

public 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 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 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 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 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.

getRestrictedLocationsConfigBuilder()

public IcebergCatalog.RestrictedLocationsConfig.Builder getRestrictedLocationsConfigBuilder()

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

getRestrictedLocationsConfigOrBuilder()

public 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 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 int

The index of the element to return.
Returns
Type Description
String

The storageRegions at the given index.

getStorageRegionsBytes(int index)

public 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 int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the storageRegions at the given index.

getStorageRegionsCount()

public 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 ProtocolStringList 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
ProtocolStringList

A list containing the storageRegions.

getUpdateTime()

public 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.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

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
Builder

getUpdateTimeOrBuilder()

public 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 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 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 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 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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeCreateTime(Timestamp value)

public IcebergCatalog.Builder mergeCreateTime(Timestamp value)

Output only. When the catalog was created.

.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
IcebergCatalog.Builder

mergeFederatedCatalogOptions(IcebergCatalog.FederatedCatalogOptions value)

public IcebergCatalog.Builder mergeFederatedCatalogOptions(IcebergCatalog.FederatedCatalogOptions value)

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

Parameter
Name Description
value IcebergCatalog.FederatedCatalogOptions
Returns
Type Description
IcebergCatalog.Builder

mergeFrom(IcebergCatalog other)

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

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

mergeFrom(Message other)

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

mergeRestrictedLocationsConfig(IcebergCatalog.RestrictedLocationsConfig value)

public IcebergCatalog.Builder mergeRestrictedLocationsConfig(IcebergCatalog.RestrictedLocationsConfig value)

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

Parameter
Name Description
value IcebergCatalog.RestrictedLocationsConfig
Returns
Type Description
IcebergCatalog.Builder

mergeUpdateTime(Timestamp value)

public IcebergCatalog.Builder mergeUpdateTime(Timestamp value)

Output only. When the catalog was last updated.

.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
IcebergCatalog.Builder

removeReplicas(int index)

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

setBiglakeServiceAccount(String value)

public IcebergCatalog.Builder setBiglakeServiceAccount(String value)

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

Parameter
Name Description
value String

The biglakeServiceAccount to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setBiglakeServiceAccountBytes(ByteString value)

public IcebergCatalog.Builder setBiglakeServiceAccountBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for biglakeServiceAccount to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setBiglakeServiceAccountUniqueId(String value)

public IcebergCatalog.Builder setBiglakeServiceAccountUniqueId(String value)

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

Parameter
Name Description
value String

The biglakeServiceAccountUniqueId to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setBiglakeServiceAccountUniqueIdBytes(ByteString value)

public IcebergCatalog.Builder setBiglakeServiceAccountUniqueIdBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for biglakeServiceAccountUniqueId to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCatalogType(IcebergCatalog.CatalogType value)

public IcebergCatalog.Builder setCatalogType(IcebergCatalog.CatalogType value)

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

Parameter
Name Description
value IcebergCatalog.CatalogType

The catalogType to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCatalogTypeValue(int value)

public IcebergCatalog.Builder setCatalogTypeValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for catalogType to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCreateTime(Timestamp value)

public IcebergCatalog.Builder setCreateTime(Timestamp value)

Output only. When the catalog was created.

.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
IcebergCatalog.Builder

setCreateTime(Timestamp.Builder builderForValue)

public IcebergCatalog.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. When the catalog was created.

.google.protobuf.Timestamp create_time = 7 [json_name = "create-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
IcebergCatalog.Builder

setCredentialMode(IcebergCatalog.CredentialMode value)

public IcebergCatalog.Builder setCredentialMode(IcebergCatalog.CredentialMode value)

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

Parameter
Name Description
value IcebergCatalog.CredentialMode

The credentialMode to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setCredentialModeValue(int value)

public IcebergCatalog.Builder setCredentialModeValue(int value)

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

Parameter
Name Description
value int

The enum numeric value on the wire for credentialMode to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setDefaultLocation(String value)

public IcebergCatalog.Builder setDefaultLocation(String value)

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

Parameter
Name Description
value String

The defaultLocation to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setDefaultLocationBytes(ByteString value)

public IcebergCatalog.Builder setDefaultLocationBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for defaultLocation to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setDescription(String value)

public IcebergCatalog.Builder setDescription(String value)

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

Parameter
Name Description
value String

The description to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setDescriptionBytes(ByteString value)

public IcebergCatalog.Builder setDescriptionBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for description to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setFederatedCatalogOptions(IcebergCatalog.FederatedCatalogOptions value)

public IcebergCatalog.Builder setFederatedCatalogOptions(IcebergCatalog.FederatedCatalogOptions value)

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

Parameter
Name Description
value IcebergCatalog.FederatedCatalogOptions
Returns
Type Description
IcebergCatalog.Builder

setFederatedCatalogOptions(IcebergCatalog.FederatedCatalogOptions.Builder builderForValue)

public IcebergCatalog.Builder setFederatedCatalogOptions(IcebergCatalog.FederatedCatalogOptions.Builder builderForValue)

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

Parameter
Name Description
builderForValue IcebergCatalog.FederatedCatalogOptions.Builder
Returns
Type Description
IcebergCatalog.Builder

setName(String value)

public IcebergCatalog.Builder setName(String value)

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

Parameter
Name Description
value String

The name to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setNameBytes(ByteString value)

public IcebergCatalog.Builder setNameBytes(ByteString value)

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

Parameter
Name Description
value ByteString

The bytes for name to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setReplicas(int index, IcebergCatalog.Replica value)

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

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
value IcebergCatalog.Replica
Returns
Type Description
IcebergCatalog.Builder

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

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

Output only. The replicas for the catalog metadata.

repeated .google.cloud.biglake.v1.IcebergCatalog.Replica replicas = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters
Name Description
index int
builderForValue IcebergCatalog.Replica.Builder
Returns
Type Description
IcebergCatalog.Builder

setRestrictedLocationsConfig(IcebergCatalog.RestrictedLocationsConfig value)

public IcebergCatalog.Builder setRestrictedLocationsConfig(IcebergCatalog.RestrictedLocationsConfig value)

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

Parameter
Name Description
value IcebergCatalog.RestrictedLocationsConfig
Returns
Type Description
IcebergCatalog.Builder

setRestrictedLocationsConfig(IcebergCatalog.RestrictedLocationsConfig.Builder builderForValue)

public IcebergCatalog.Builder setRestrictedLocationsConfig(IcebergCatalog.RestrictedLocationsConfig.Builder builderForValue)

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

Parameter
Name Description
builderForValue IcebergCatalog.RestrictedLocationsConfig.Builder
Returns
Type Description
IcebergCatalog.Builder

setStorageRegions(int index, String value)

public IcebergCatalog.Builder setStorageRegions(int index, String value)

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

Parameters
Name Description
index int

The index to set the value at.
value String

The storageRegions to set.
Returns
Type Description
IcebergCatalog.Builder

This builder for chaining.

setUpdateTime(Timestamp value)

public IcebergCatalog.Builder setUpdateTime(Timestamp value)

Output only. When the catalog was last updated.

.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
value Timestamp
Returns
Type Description
IcebergCatalog.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public IcebergCatalog.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. When the catalog was last updated.

.google.protobuf.Timestamp update_time = 8 [json_name = "update-time", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
builderForValue Builder
Returns
Type Description
IcebergCatalog.Builder