Class IcebergCatalog.FederatedCatalogOptions (0.83.0)

public static final class IcebergCatalog.FederatedCatalogOptions extends GeneratedMessage implements IcebergCatalog.FederatedCatalogOptionsOrBuilder

Configuration options for a federated catalog.

Protobuf type google.cloud.biglake.v1.IcebergCatalog.FederatedCatalogOptions

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > IcebergCatalog.FederatedCatalogOptions

Static Fields

GLUE_CATALOG_INFO_FIELD_NUMBER

public static final int GLUE_CATALOG_INFO_FIELD_NUMBER
Field Value
Type Description
int

REFRESH_OPTIONS_FIELD_NUMBER

public static final int REFRESH_OPTIONS_FIELD_NUMBER
Field Value
Type Description
int

REFRESH_STATUS_FIELD_NUMBER

public static final int REFRESH_STATUS_FIELD_NUMBER
Field Value
Type Description
int

SECRET_NAME_FIELD_NUMBER

public static final int SECRET_NAME_FIELD_NUMBER
Field Value
Type Description
int

SERVICE_DIRECTORY_NAME_FIELD_NUMBER

public static final int SERVICE_DIRECTORY_NAME_FIELD_NUMBER
Field Value
Type Description
int

SNOWFLAKE_CATALOG_INFO_FIELD_NUMBER

public static final int SNOWFLAKE_CATALOG_INFO_FIELD_NUMBER
Field Value
Type Description
int

UNITY_CATALOG_INFO_FIELD_NUMBER

public static final int UNITY_CATALOG_INFO_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static IcebergCatalog.FederatedCatalogOptions getDefaultInstance()
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static IcebergCatalog.FederatedCatalogOptions.Builder newBuilder()
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.Builder

newBuilder(IcebergCatalog.FederatedCatalogOptions prototype)

public static IcebergCatalog.FederatedCatalogOptions.Builder newBuilder(IcebergCatalog.FederatedCatalogOptions prototype)
Parameter
Name Description
prototype IcebergCatalog.FederatedCatalogOptions
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.Builder

parseDelimitedFrom(InputStream input)

public static IcebergCatalog.FederatedCatalogOptions parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<IcebergCatalog.FederatedCatalogOptions> parser()
Returns
Type Description
Parser<FederatedCatalogOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public IcebergCatalog.FederatedCatalogOptions getDefaultInstanceForType()
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions

getGlueCatalogInfo()

public 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 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

getParserForType()

public Parser<IcebergCatalog.FederatedCatalogOptions> getParserForType()
Returns
Type Description
Parser<FederatedCatalogOptions>
Overrides

getRefreshOptions()

public 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 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 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 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 IcebergCatalog.FederatedCatalogOptions.RemoteCatalogInfoCase getRemoteCatalogInfoCase()
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.RemoteCatalogInfoCase

getSecretName()

public 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 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.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getServiceDirectoryName()

public 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 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 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 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 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 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 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 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 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 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 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 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 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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public IcebergCatalog.FederatedCatalogOptions.Builder newBuilderForType()
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected IcebergCatalog.FederatedCatalogOptions.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.Builder
Overrides

toBuilder()

public IcebergCatalog.FederatedCatalogOptions.Builder toBuilder()
Returns
Type Description
IcebergCatalog.FederatedCatalogOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException