Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo (0.83.0)

public static final class IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo extends GeneratedMessage implements IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfoOrBuilder

Snowflake Catalog info.

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

Inheritance

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

Implements

IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfoOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessage.<ListT>makeMutableCopy(ListT,int)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessage.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.<T>emptyList(java.lang.Class<T>)

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

com.google.protobuf.GeneratedMessage.internalGetMapFieldReflection(int)

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

GeneratedMessage.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ACCOUNT_IDENTIFIER_FIELD_NUMBER

public static final int ACCOUNT_IDENTIFIER_FIELD_NUMBER

Field Value
Type	Description
`int`

SNOWFLAKE_ROLE_FIELD_NUMBER

public static final int SNOWFLAKE_ROLE_FIELD_NUMBER

Field Value
Type	Description
`int`

WAREHOUSE_FIELD_NUMBER

public static final int WAREHOUSE_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo getDefaultInstance()

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder newBuilder()

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder`

newBuilder(IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo prototype)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder newBuilder(IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo prototype)

Parameter
Name	Description
`prototype`	`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder`

parseDelimitedFrom(InputStream input)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo> parser()

Returns
Type	Description
`Parser<SnowflakeCatalogInfo>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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()

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`

getParserForType()

public Parser<IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo> getParserForType()

Returns
Type	Description
`Parser<SnowflakeCatalogInfo>`

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessage.getSerializedSize()

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()

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()

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()

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.

hashCode()

public int hashCode()

Returns
Type	Description
`int`

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
`FieldAccessorTable`

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
`boolean`

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder newBuilderForType()

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder`

newBuilderForType(AbstractMessage.BuilderParent parent)

protected IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
`parent`	`BuilderParent`

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder`

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder toBuilder()

Returns
Type	Description
`IcebergCatalog.FederatedCatalogOptions.SnowflakeCatalogInfo.Builder`

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
`output`	`CodedOutputStream`

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
`IOException`