Package io.unitycatalog.client.model

Enum Class Privilege

java.lang.Object

java.lang.Enum<Privilege>

io.unitycatalog.client.model.Privilege

All Implemented Interfaces:

Serializable, Comparable<Privilege>, Constable

public enum Privilege
extends Enum<Privilege>

The privilege to grant.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CREATE_CATALOG	CREATE CATALOG: Enables users to create new catalogs in a metastore.
CREATE_EXTERNAL_LOCATION	CREATE EXTERNAL LOCATION: Required privilege on both the metastore and referenced storage credential to create external locations.
CREATE_EXTERNAL_TABLE	CREATE EXTERNAL TABLE: Enables creating external tables through external locations.
CREATE_EXTERNAL_VOLUME	CREATE EXTERNAL VOLUME: Enables creating external volumes through external locations.
CREATE_FUNCTION	CREATE FUNCTION: Allows users to create functions or procedures within a schema.
CREATE_MANAGED_STORAGE	CREATE MANAGED STORAGE: Allows designating managed storage locations at catalog or schema levels.
CREATE_MODEL	CREATE MODEL: Permits establishing MLflow registered models in a schema.
CREATE_SCHEMA	CREATE SCHEMA: Enables users to create new schemas in a catalog.
CREATE_STORAGE_CREDENTIAL	CREATE STORAGE CREDENTIAL: Required privilege on the metastore to create storage credentials.
CREATE_TABLE	CREATE TABLE: Allows creating tables or views in a schema.
CREATE_VOLUME	CREATE VOLUME: Enables creating volumes in a schema.
EXECUTE	EXECUTE: Permits invoking user-defined functions or loading models for inference.
MODIFY	MODIFY: Enables adding, updating, and deleting data within tables (requires SELECT privilege also).
READ_FILES	READ FILES: Grants direct read access to files in cloud storage configured as external locations.
READ_VOLUME	READ VOLUME: Permits reading files and directories within volumes.
SELECT	SELECT: Enables querying tables, views, materialized views.
UNKNOWN_DEFAULT_OPEN_API
USE_CATALOG	USE CATALOG: Required to interact with any object within a catalog.
USE_SCHEMA	USE SCHEMA: Required to interact with any object within a schema.
WRITE_FILES	WRITE FILES: Grants direct write access to files in cloud storage configured as external locations.

Method Summary

Modifier and Type	Method	Description
static Privilege	fromValue(String value)
String	getValue()
String	toString()
String	toUrlQueryString(String prefix)	Convert the instance into URL query string.
static Privilege	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Privilege[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CREATE_CATALOG

public static final Privilege CREATE_CATALOG

CREATE CATALOG: Enables users to create new catalogs in a metastore.

USE_CATALOG

public static final Privilege USE_CATALOG

USE CATALOG: Required to interact with any object within a catalog.

CREATE_SCHEMA

public static final Privilege CREATE_SCHEMA

CREATE SCHEMA: Enables users to create new schemas in a catalog.

USE_SCHEMA

public static final Privilege USE_SCHEMA

USE SCHEMA: Required to interact with any object within a schema.

CREATE_TABLE

public static final Privilege CREATE_TABLE

CREATE TABLE: Allows creating tables or views in a schema.

SELECT

public static final Privilege SELECT

SELECT: Enables querying tables, views, materialized views.

MODIFY

public static final Privilege MODIFY

MODIFY: Enables adding, updating, and deleting data within tables (requires SELECT privilege also).

CREATE_FUNCTION

public static final Privilege CREATE_FUNCTION

CREATE FUNCTION: Allows users to create functions or procedures within a schema.

EXECUTE

public static final Privilege EXECUTE

EXECUTE: Permits invoking user-defined functions or loading models for inference.

CREATE_VOLUME

public static final Privilege CREATE_VOLUME

CREATE VOLUME: Enables creating volumes in a schema.

READ_VOLUME

public static final Privilege READ_VOLUME

READ VOLUME: Permits reading files and directories within volumes.

CREATE_MODEL

public static final Privilege CREATE_MODEL

CREATE MODEL: Permits establishing MLflow registered models in a schema.

CREATE_EXTERNAL_LOCATION

public static final Privilege CREATE_EXTERNAL_LOCATION

CREATE EXTERNAL LOCATION: Required privilege on both the metastore and referenced storage credential to create external locations.

READ_FILES

public static final Privilege READ_FILES

READ FILES: Grants direct read access to files in cloud storage configured as external locations.

WRITE_FILES

public static final Privilege WRITE_FILES

WRITE FILES: Grants direct write access to files in cloud storage configured as external locations.

CREATE_EXTERNAL_TABLE

public static final Privilege CREATE_EXTERNAL_TABLE

CREATE EXTERNAL TABLE: Enables creating external tables through external locations.

CREATE_EXTERNAL_VOLUME

public static final Privilege CREATE_EXTERNAL_VOLUME

CREATE EXTERNAL VOLUME: Enables creating external volumes through external locations.

CREATE_MANAGED_STORAGE

public static final Privilege CREATE_MANAGED_STORAGE

CREATE MANAGED STORAGE: Allows designating managed storage locations at catalog or schema levels.

CREATE_STORAGE_CREDENTIAL

public static final Privilege CREATE_STORAGE_CREDENTIAL

CREATE STORAGE CREDENTIAL: Required privilege on the metastore to create storage credentials.

UNKNOWN_DEFAULT_OPEN_API

public static final Privilege UNKNOWN_DEFAULT_OPEN_API

Method Details

values

public static Privilege[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static Privilege valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public String getValue()

toString

public String toString()

Overrides:

toString in class Enum<Privilege>

fromValue

public static Privilege fromValue(String value)

toUrlQueryString

public String toUrlQueryString(String prefix)

Convert the instance into URL query string.

Parameters:

prefix - prefix of the query string

Returns:

URL query string