Interface IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfoOrBuilder (0.83.0)

public static interface IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getAccountIdentifier()

public abstract String getAccountIdentifier()

Required. The account identifier in Snowflake (See: https://docs.snowflake.com/en/user-guide/admin-account-identifier). It is the prefix to log into your Snowflake deployment URL. For example: https://<account_identifier>.snowflakecomputing.com.

optional string account_identifier = 1 [json_name = "account-identifier", (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The accountIdentifier.

getAccountIdentifierBytes()

public abstract ByteString getAccountIdentifierBytes()

Required. The account identifier in Snowflake (See: https://docs.snowflake.com/en/user-guide/admin-account-identifier). It is the prefix to log into your Snowflake deployment URL. For example: https://<account_identifier>.snowflakecomputing.com.

optional string account_identifier = 1 [json_name = "account-identifier", (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for accountIdentifier.

getSnowflakeRole()

public abstract String getSnowflakeRole()

Optional. The specific Snowflake role name to request in the OAuth token scope (via session:role:$ROLE) for the Iceberg REST Catalog session. This role grants the GCP BigLake service account the necessary permissions to interact with the Iceberg catalog, namespaces, and tables.

Note: The role provided here must be the DEFAULT_ROLE or be granted to, the Snowflake service user mapped to the BigLake service account.

optional string snowflake_role = 3 [json_name = "snowflake-role", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The snowflakeRole.

getSnowflakeRoleBytes()

public abstract ByteString getSnowflakeRoleBytes()

Optional. The specific Snowflake role name to request in the OAuth token scope (via session:role:$ROLE) for the Iceberg REST Catalog session. This role grants the GCP BigLake service account the necessary permissions to interact with the Iceberg catalog, namespaces, and tables.

Note: The role provided here must be the DEFAULT_ROLE or be granted to, the Snowflake service user mapped to the BigLake service account.

optional string snowflake_role = 3 [json_name = "snowflake-role", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for snowflakeRole.

getWarehouse()

public abstract String getWarehouse()

Required. The warehouse to connect to in Snowflake REST Catalog. https://<account_identifier>.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=<database_name>.

This is the Snowflake database name containing the Iceberg metadata to be federated.

Must be non-empty.

optional string warehouse = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
String

The warehouse.

getWarehouseBytes()

public abstract ByteString getWarehouseBytes()

Required. The warehouse to connect to in Snowflake REST Catalog. https://<account_identifier>.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=<database_name>.

This is the Snowflake database name containing the Iceberg metadata to be federated.

Must be non-empty.

optional string warehouse = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
ByteString

The bytes for warehouse.

hasAccountIdentifier()

public abstract boolean hasAccountIdentifier()

Required. The account identifier in Snowflake (See: https://docs.snowflake.com/en/user-guide/admin-account-identifier). It is the prefix to log into your Snowflake deployment URL. For example: https://<account_identifier>.snowflakecomputing.com.

optional string account_identifier = 1 [json_name = "account-identifier", (.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the accountIdentifier field is set.

hasSnowflakeRole()

public abstract boolean hasSnowflakeRole()

Optional. The specific Snowflake role name to request in the OAuth token scope (via session:role:$ROLE) for the Iceberg REST Catalog session. This role grants the GCP BigLake service account the necessary permissions to interact with the Iceberg catalog, namespaces, and tables.

Note: The role provided here must be the DEFAULT_ROLE or be granted to, the Snowflake service user mapped to the BigLake service account.

optional string snowflake_role = 3 [json_name = "snowflake-role", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the snowflakeRole field is set.

hasWarehouse()

public abstract boolean hasWarehouse()

Required. The warehouse to connect to in Snowflake REST Catalog. https://<account_identifier>.snowflakecomputing.com/polaris/api/catalog/v1/config?warehouse=<database_name>.

This is the Snowflake database name containing the Iceberg metadata to be federated.

Must be non-empty.

optional string warehouse = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
Type Description
boolean

Whether the warehouse field is set.