public final class IcebergCatalog extends GeneratedMessage implements IcebergCatalogOrBuilder
The Iceberg REST Catalog information.
Protobuf type google.cloud.biglake.v1.IcebergCatalog
Inherited Members
com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)
com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)
com.google.protobuf.GeneratedMessage.canUseUnsafe()
com.google.protobuf.GeneratedMessage.emptyBooleanList()
com.google.protobuf.GeneratedMessage.emptyDoubleList()
com.google.protobuf.GeneratedMessage.emptyFloatList()
com.google.protobuf.GeneratedMessage.emptyIntList()
com.google.protobuf.GeneratedMessage.emptyLongList()
com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)
com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)
com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)
com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)
Static Fields
BIGLAKE_SERVICE_ACCOUNT_FIELD_NUMBER
public static final int BIGLAKE_SERVICE_ACCOUNT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
BIGLAKE_SERVICE_ACCOUNT_UNIQUE_ID_FIELD_NUMBER
public static final int BIGLAKE_SERVICE_ACCOUNT_UNIQUE_ID_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CATALOG_TYPE_FIELD_NUMBER
public static final int CATALOG_TYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREATE_TIME_FIELD_NUMBER
public static final int CREATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CREDENTIAL_MODE_FIELD_NUMBER
public static final int CREDENTIAL_MODE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DEFAULT_LOCATION_FIELD_NUMBER
public static final int DEFAULT_LOCATION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
DESCRIPTION_FIELD_NUMBER
public static final int DESCRIPTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
FEDERATED_CATALOG_OPTIONS_FIELD_NUMBER
public static final int FEDERATED_CATALOG_OPTIONS_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 |
|
RESTRICTED_LOCATIONS_CONFIG_FIELD_NUMBER
public static final int RESTRICTED_LOCATIONS_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
STORAGE_REGIONS_FIELD_NUMBER
public static final int STORAGE_REGIONS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
UPDATE_TIME_FIELD_NUMBER
public static final int UPDATE_TIME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static IcebergCatalog getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static IcebergCatalog.Builder newBuilder()
newBuilder(IcebergCatalog prototype)
public static IcebergCatalog.Builder newBuilder(IcebergCatalog prototype)
public static IcebergCatalog parseDelimitedFrom(InputStream input)
public static IcebergCatalog parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static IcebergCatalog parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static IcebergCatalog parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static IcebergCatalog parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static IcebergCatalog parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static IcebergCatalog parseFrom(CodedInputStream input)
public static IcebergCatalog parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static IcebergCatalog parseFrom(InputStream input)
public static IcebergCatalog parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static IcebergCatalog parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static IcebergCatalog parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<IcebergCatalog> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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];
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.
|
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];
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];
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()
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.
|
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];
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];
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.
|
getParserForType()
public Parser<IcebergCatalog> getParserForType()
Overrides
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
|
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];
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
|
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];
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];
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
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.
|
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];
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.
|
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public IcebergCatalog.Builder newBuilderForType()
newBuilderForType(AbstractMessage.BuilderParent parent)
protected IcebergCatalog.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Overrides
toBuilder()
public IcebergCatalog.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
