Interface IcebergCatalog.FederatedCatalogOptionsOrBuilder (0.83.0)

public static interface IcebergCatalog.FederatedCatalogOptionsOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getGlueCatalogInfo()

public abstract IcebergCatalog.FederatedCatalogOptions.GlueCatalogInfo getGlueCatalogInfo()

Optional. Info specific to an AWS Glue Catalog.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.GlueCatalogInfo glue_catalog_info = 4 [json_name = "glue-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.GlueCatalogInfo

The glueCatalogInfo.

getGlueCatalogInfoOrBuilder()

public abstract IcebergCatalog.FederatedCatalogOptions.GlueCatalogInfoOrBuilder getGlueCatalogInfoOrBuilder()

Optional. Info specific to an AWS Glue Catalog.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.GlueCatalogInfo glue_catalog_info = 4 [json_name = "glue-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.GlueCatalogInfoOrBuilder

getRefreshOptions()

public abstract IcebergCatalog.FederatedCatalogOptions.RefreshOptions getRefreshOptions()

Optional. Refresh configuration.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.RefreshOptions refresh_options = 3 [json_name = "refresh-options", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.RefreshOptions

The refreshOptions.

getRefreshOptionsOrBuilder()

public abstract IcebergCatalog.FederatedCatalogOptions.RefreshOptionsOrBuilder getRefreshOptionsOrBuilder()

Optional. Refresh configuration.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.RefreshOptions refresh_options = 3 [json_name = "refresh-options", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.RefreshOptionsOrBuilder

getRefreshStatus()

public abstract IcebergCatalog.FederatedCatalogOptions.RefreshStatus getRefreshStatus()

Output only. The status of the background refresh operations.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.RefreshStatus refresh_status = 6 [json_name = "refresh-status", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.RefreshStatus

The refreshStatus.

getRefreshStatusOrBuilder()

public abstract IcebergCatalog.FederatedCatalogOptions.RefreshStatusOrBuilder getRefreshStatusOrBuilder()

Output only. The status of the background refresh operations.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.RefreshStatus refresh_status = 6 [json_name = "refresh-status", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.RefreshStatusOrBuilder

getRemoteCatalogInfoCase()

public abstract IcebergCatalog.FederatedCatalogOptions.RemoteCatalogInfoCase getRemoteCatalogInfoCase()
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.RemoteCatalogInfoCase

getSecretName()

public abstract String getSecretName()

Optional. The secret resource name in Secret Manager, in the format projects/{project_id}/locations/{location}/secrets/{secret_id} or projects/{project_id}/locations/{location}/secrets/{secret_id}/versions/{version_id}.

The project ID must match the catalog's project and location must match the catalog's location. If the version is not specified, the latest version will be used.

This field is not used when google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo.service_principal_application_id or google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.snowflake_role is set.

optional string secret_name = 1 [json_name = "secret-name", (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The secretName.

getSecretNameBytes()

public abstract ByteString getSecretNameBytes()

Optional. The secret resource name in Secret Manager, in the format projects/{project_id}/locations/{location}/secrets/{secret_id} or projects/{project_id}/locations/{location}/secrets/{secret_id}/versions/{version_id}.

The project ID must match the catalog's project and location must match the catalog's location. If the version is not specified, the latest version will be used.

This field is not used when google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo.service_principal_application_id or google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.snowflake_role is set.

optional string secret_name = 1 [json_name = "secret-name", (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for secretName.

getServiceDirectoryName()

public abstract String getServiceDirectoryName()

Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}.

optional string service_directory_name = 5 [json_name = "service-directory-name", (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
String

The serviceDirectoryName.

getServiceDirectoryNameBytes()

public abstract ByteString getServiceDirectoryNameBytes()

Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}.

optional string service_directory_name = 5 [json_name = "service-directory-name", (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for serviceDirectoryName.

getSnowflakeCatalogInfo()

public abstract IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo getSnowflakeCatalogInfo()

Optional. Info specific to a Snowflake Catalog.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo snowflake_catalog_info = 7 [json_name = "snowflake-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo

The snowflakeCatalogInfo.

getSnowflakeCatalogInfoOrBuilder()

public abstract IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfoOrBuilder getSnowflakeCatalogInfoOrBuilder()

Optional. Info specific to a Snowflake Catalog.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo snowflake_catalog_info = 7 [json_name = "snowflake-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfoOrBuilder

getUnityCatalogInfo()

public abstract IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo getUnityCatalogInfo()

Optional. Info specific to a Unity Catalog by Databricks.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo unity_catalog_info = 2 [json_name = "unity-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo

The unityCatalogInfo.

getUnityCatalogInfoOrBuilder()

public abstract IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfoOrBuilder getUnityCatalogInfoOrBuilder()

Optional. Info specific to a Unity Catalog by Databricks.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo unity_catalog_info = 2 [json_name = "unity-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfoOrBuilder

hasGlueCatalogInfo()

public abstract boolean hasGlueCatalogInfo()

Optional. Info specific to an AWS Glue Catalog.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.GlueCatalogInfo glue_catalog_info = 4 [json_name = "glue-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the glueCatalogInfo field is set.

hasRefreshOptions()

public abstract boolean hasRefreshOptions()

Optional. Refresh configuration.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.RefreshOptions refresh_options = 3 [json_name = "refresh-options", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the refreshOptions field is set.

hasRefreshStatus()

public abstract boolean hasRefreshStatus()

Output only. The status of the background refresh operations.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.RefreshStatus refresh_status = 6 [json_name = "refresh-status", (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the refreshStatus field is set.

hasSecretName()

public abstract boolean hasSecretName()

Optional. The secret resource name in Secret Manager, in the format projects/{project_id}/locations/{location}/secrets/{secret_id} or projects/{project_id}/locations/{location}/secrets/{secret_id}/versions/{version_id}.

The project ID must match the catalog's project and location must match the catalog's location. If the version is not specified, the latest version will be used.

This field is not used when google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo.service_principal_application_id or google.cloud.biglake.v1main.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.snowflake_role is set.

optional string secret_name = 1 [json_name = "secret-name", (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the secretName field is set.

hasServiceDirectoryName()

public abstract boolean hasServiceDirectoryName()

Optional. The service directory resource name for routing traffic over a private network connection through Cross-Cloud Interconnect, in the format projects/{project_id}/locations/{location_id}/namespaces/{namespace_id}/services/{service_id}.

optional string service_directory_name = 5 [json_name = "service-directory-name", (.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
boolean

Whether the serviceDirectoryName field is set.

hasSnowflakeCatalogInfo()

public abstract boolean hasSnowflakeCatalogInfo()

Optional. Info specific to a Snowflake Catalog.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo snowflake_catalog_info = 7 [json_name = "snowflake-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the snowflakeCatalogInfo field is set.

hasUnityCatalogInfo()

public abstract boolean hasUnityCatalogInfo()

Optional. Info specific to a Unity Catalog by Databricks.

.google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions.UnityCatalogInfo unity_catalog_info = 2 [json_name = "unity-catalog-info", (.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the unityCatalogInfo field is set.