Interface CreateIcebergCatalogRequestOrBuilder (0.83.0) 

public interface CreateIcebergCatalogRequestOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getIcebergCatalog()

public abstract IcebergCatalog getIcebergCatalog()

Required. The catalog to create. The required fields for creation are:

  • catalog_type. Optionally: credential_mode can be provided, if Credential Vending is desired.

.google.cloud.biglake.v1.IcebergCatalog iceberg_catalog = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IcebergCatalog

The icebergCatalog.

getIcebergCatalogId()

public abstract String getIcebergCatalogId()

Required. The name of the catalog.

string iceberg_catalog_id = 3 [json_name = "iceberg-catalog-id", (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The icebergCatalogId.

getIcebergCatalogIdBytes()

public abstract ByteString getIcebergCatalogIdBytes()

Required. The name of the catalog.

string iceberg_catalog_id = 3 [json_name = "iceberg-catalog-id", (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for icebergCatalogId.

getIcebergCatalogOrBuilder()

public abstract IcebergCatalogOrBuilder getIcebergCatalogOrBuilder()

Required. The catalog to create. The required fields for creation are:

  • catalog_type. Optionally: credential_mode can be provided, if Credential Vending is desired.

.google.cloud.biglake.v1.IcebergCatalog iceberg_catalog = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
IcebergCatalogOrBuilder

getParent()

public abstract String getParent()

Required. The parent resource where this catalog will be created. Format: projects/{project_id}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The parent.

getParentBytes()

public abstract ByteString getParentBytes()

Required. The parent resource where this catalog will be created. Format: projects/{project_id}

string parent = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for parent.

getPrimaryLocation()

public abstract String getPrimaryLocation()

Optional. The primary location where the catalog metadata will be stored.

For Google Cloud Storage bucket catalogs and BigLake catalogs, if this is not specified, then the region is inferred from the bucket's region (default_location bucket for BigLake catalogs). If specified, the region must be in jurisdiction (near the default_location bucket's region and the restricted_locations buckets' regions for BigLake catalogs).

For federated catalogs, this must be specified and be a Lakehouse-supported location (https://docs.cloud.google.com/lakehouse/docs/locations). It should be close to the remote catalog's location for the best performance and cost.

string primary_location = 4 [json_name = "primary_location", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The primaryLocation.

getPrimaryLocationBytes()

public abstract ByteString getPrimaryLocationBytes()

Optional. The primary location where the catalog metadata will be stored.

For Google Cloud Storage bucket catalogs and BigLake catalogs, if this is not specified, then the region is inferred from the bucket's region (default_location bucket for BigLake catalogs). If specified, the region must be in jurisdiction (near the default_location bucket's region and the restricted_locations buckets' regions for BigLake catalogs).

For federated catalogs, this must be specified and be a Lakehouse-supported location (https://docs.cloud.google.com/lakehouse/docs/locations). It should be close to the remote catalog's location for the best performance and cost.

string primary_location = 4 [json_name = "primary_location", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for primaryLocation.

hasIcebergCatalog()

public abstract boolean hasIcebergCatalog()

Required. The catalog to create. The required fields for creation are:

  • catalog_type. Optionally: credential_mode can be provided, if Credential Vending is desired.

.google.cloud.biglake.v1.IcebergCatalog iceberg_catalog = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the icebergCatalog field is set.