Interface IcebergCatalogOrBuilder (0.62.0)

public interface IcebergCatalogOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

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.

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.

string biglake_service_account = 3 [json_name = "biglake-service-account", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for biglakeServiceAccount.

getCatalogRegions(int index)

public abstract String getCatalogRegions(int index)

Output only. The GCP region(s) where the catalog metadata is stored. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.

repeated string catalog_regions = 6 [json_name = "catalog-regions", (.google.api.field_behavior) = OUTPUT_ONLY];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The catalogRegions at the given index.

getCatalogRegionsBytes(int index)

public abstract ByteString getCatalogRegionsBytes(int index)

Output only. The GCP region(s) where the catalog metadata is stored. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.

repeated string catalog_regions = 6 [json_name = "catalog-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 catalogRegions at the given index.

getCatalogRegionsCount()

public abstract int getCatalogRegionsCount()

Output only. The GCP region(s) where the catalog metadata is stored. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.

repeated string catalog_regions = 6 [json_name = "catalog-regions", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
int

The count of catalogRegions.

getCatalogRegionsList()

public abstract List<String> getCatalogRegionsList()

Output only. The GCP region(s) where the catalog metadata is stored. This will contain one value for all locations, except for the catalogs that are configured to use custom dual region buckets.

repeated string catalog_regions = 6 [json_name = "catalog-regions", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
List<String>

A list containing the catalogRegions.

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 location for the catalog. For the Google Cloud Storage Bucket catalog this is output only.

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 location for the catalog. For the Google Cloud Storage Bucket catalog this is output only.

string default_location = 5 [json_name = "default-location", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for defaultLocation.

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.

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.

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.