public static final class IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder extends GeneratedMessage.Builder<IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder> implements IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfoOrBuilderSnowflake Catalog info.
Protobuf type
google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo
Inheritance
java.lang.Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessage.Builder > IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.BuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
build()
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo build()| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo |
|
buildPartial()
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo buildPartial()| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo |
|
clear()
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder clear()| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
|
clearAccountIdentifier()
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder clearAccountIdentifier()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 |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |
clearSnowflakeRole()
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder clearSnowflakeRole()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 |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |
clearWarehouse()
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder clearWarehouse()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 |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |
getAccountIdentifier()
public 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 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. |
getDefaultInstanceForType()
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo |
|
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getSnowflakeRole()
public 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 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 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 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 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 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 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. |
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeFrom(IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo other)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder mergeFrom(IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo other)| Parameter | |
|---|---|
| Name | Description |
other |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
|
setAccountIdentifier(String value)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder setAccountIdentifier(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe accountIdentifier to set. |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |
setAccountIdentifierBytes(ByteString value)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder setAccountIdentifierBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for accountIdentifier to set. |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |
setSnowflakeRole(String value)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder setSnowflakeRole(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe snowflakeRole to set. |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |
setSnowflakeRoleBytes(ByteString value)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder setSnowflakeRoleBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for snowflakeRole to set. |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |
setWarehouse(String value)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder setWarehouse(String value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe warehouse to set. |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |
setWarehouseBytes(ByteString value)
public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder setWarehouseBytes(ByteString value)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];
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for warehouse to set. |
| Returns | |
|---|---|
| Type | Description |
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder |
This builder for chaining. |