Package org.odpi.openmetadata.frameworks.connectors.properties.users

Enum Class ZoneAccessType

java.lang.Object

java.lang.Enum<ZoneAccessType>

org.odpi.openmetadata.frameworks.connectors.properties.users.ZoneAccessType

All Implemented Interfaces:

Serializable, Comparable<ZoneAccessType>, Constable

public enum ZoneAccessType
extends Enum<ZoneAccessType>

The ZoneAccessType enum defines the type of access granted to assets in a particular Governance Zone.

• ReadAssets: The user may read assets in the zone (supportedZones).
• UpdateAssets: The user may change the metadata description of the asset.
• DeleteAssets: The user may remove the asset from the catalog (archive, soft-delete or purge).
• ChangeAssetMembership: The user may update the zone membership of an asset in this zone.

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
CHANGE_ASSET_MEMBERSHIP	The user may update the zone membership of an asset in this zone.
CREATE_ASSETS	The user may change the metadata description of the asset.
DELETE_ASSETS	The user may remove the asset from the catalog (archive, soft-delete or purge).
READ_ASSETS	The user may read assets in the zone.
UPDATE_ASSETS	The user may change the metadata description of the asset.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Return the description for the enum.
String	getName()	Return the descriptive name for the enum.
int	getOrdinal()	Return the numerical value for the enum.
String	toString()	toString() JSON-style
static ZoneAccessType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ZoneAccessType[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

READ_ASSETS

public static final ZoneAccessType READ_ASSETS

The user may read assets in the zone.

CREATE_ASSETS

public static final ZoneAccessType CREATE_ASSETS

The user may change the metadata description of the asset.

UPDATE_ASSETS

public static final ZoneAccessType UPDATE_ASSETS

The user may change the metadata description of the asset.

DELETE_ASSETS

public static final ZoneAccessType DELETE_ASSETS

The user may remove the asset from the catalog (archive, soft-delete or purge).

CHANGE_ASSET_MEMBERSHIP

public static final ZoneAccessType CHANGE_ASSET_MEMBERSHIP

The user may update the zone membership of an asset in this zone.

Method Details

values

public static ZoneAccessType[] 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 ZoneAccessType 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

getOrdinal

public int getOrdinal()

Return the numerical value for the enum.

Returns:

int enum value ordinal

getName

public String getName()

Return the descriptive name for the enum.

Returns:

String name

getDescription

public String getDescription()

Return the description for the enum.

Returns:

String description

toString

public String toString()

toString() JSON-style

Overrides:

toString in class Enum<ZoneAccessType>

Returns:

string description