Package org.odpi.openmetadata.adapters.connectors.governanceactions.subscriptions

Enum Class ManageDigitalSubscriptionActionTarget

java.lang.Object

java.lang.Enum<ManageDigitalSubscriptionActionTarget>

org.odpi.openmetadata.adapters.connectors.governanceactions.subscriptions.ManageDigitalSubscriptionActionTarget

All Implemented Interfaces:

Serializable, Comparable<ManageDigitalSubscriptionActionTarget>, Constable

public enum ManageDigitalSubscriptionActionTarget
extends Enum<ManageDigitalSubscriptionActionTarget>

ActionTargetEnum characterises the action targets that this governance action service works with.

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
CANCELLING_ACTION_TYPE	The governance action type that implements the cancel-subscription action.
DIGITAL_PRODUCT_OWNER	An actor that owns the resource being subscribed to.
DIGITAL_SUBSCRIPTION	The digital subscription that is being managed.
DIGITAL_SUBSCRIPTION_ITEM	The element that is being subscribed to.
DIGITAL_SUBSCRIPTION_REQUESTER	An actor requesting the digital subscription.
DIGITAL_SUBSCRIPTION_SOURCE	The Asset that is the source of the subscription.
DIGITAL_SUBSCRIPTION_TARGET	The Asset that is the target of the subscription.
LICENSE_TYPE	The type of licence that is granted to the subscriber's asset.
NOTIFICATION_TYPE	The notification type that is used to control the subscription manager.
PROVISIONING_ACTION_TYPE	The governance action type that implements the provisioning action.
SERVICE_LEVEL_OBJECTIVE	The service level object offered by this subscription.

Field Summary

Fields

Modifier and Type	Field	Description
final String	description	Description of the target.

Method Summary

Modifier and Type	Method	Description
ActionTargetType	getActionTargetType()	Return an target type for use in the governance service's provider.
static List<ActionTargetType>	getActionTargetTypes()	Return the targets defined in this enum for all action targets.
static List<ActionTargetType>	getCancelSubscriptionActionTargetTypes()	Return the targets defined in this enum for create subscription.
static List<ActionTargetType>	getCreateSubscriptionActionTargetTypes()	Return the targets defined in this enum for create subscription.
String	getDeployedImplementationType()	Return a more specific definition of a permitted target.
String	getDescription()	Return the description of the target.
String	getName()	Return the target name.
Map<String,String>	getOtherPropertyValues()	Return a map of property name to property value that the target should have to be valid for this integration connector.
String	getTypeName()	Return the type name (or super type name) of a permitted target.
String	toString()	JSON-style toString
static ManageDigitalSubscriptionActionTarget	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ManageDigitalSubscriptionActionTarget[]	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

DIGITAL_SUBSCRIPTION

public static final ManageDigitalSubscriptionActionTarget DIGITAL_SUBSCRIPTION

The digital subscription that is being managed.

DIGITAL_SUBSCRIPTION_REQUESTER

public static final ManageDigitalSubscriptionActionTarget DIGITAL_SUBSCRIPTION_REQUESTER

An actor requesting the digital subscription.

DIGITAL_PRODUCT_OWNER

public static final ManageDigitalSubscriptionActionTarget DIGITAL_PRODUCT_OWNER

An actor that owns the resource being subscribed to.

DIGITAL_SUBSCRIPTION_ITEM

public static final ManageDigitalSubscriptionActionTarget DIGITAL_SUBSCRIPTION_ITEM

The element that is being subscribed to.

DIGITAL_SUBSCRIPTION_TARGET

public static final ManageDigitalSubscriptionActionTarget DIGITAL_SUBSCRIPTION_TARGET

The Asset that is the target of the subscription.

DIGITAL_SUBSCRIPTION_SOURCE

public static final ManageDigitalSubscriptionActionTarget DIGITAL_SUBSCRIPTION_SOURCE

The Asset that is the source of the subscription.

PROVISIONING_ACTION_TYPE

public static final ManageDigitalSubscriptionActionTarget PROVISIONING_ACTION_TYPE

The governance action type that implements the provisioning action.

CANCELLING_ACTION_TYPE

public static final ManageDigitalSubscriptionActionTarget CANCELLING_ACTION_TYPE

The governance action type that implements the cancel-subscription action.

NOTIFICATION_TYPE

public static final ManageDigitalSubscriptionActionTarget NOTIFICATION_TYPE

The notification type that is used to control the subscription manager.

LICENSE_TYPE

public static final ManageDigitalSubscriptionActionTarget LICENSE_TYPE

The type of licence that is granted to the subscriber's asset.

SERVICE_LEVEL_OBJECTIVE

public static final ManageDigitalSubscriptionActionTarget SERVICE_LEVEL_OBJECTIVE

The service level object offered by this subscription.

Field Details

description

public final String description

Description of the target.

Method Details

values

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

getName

public String getName()

Return the target name.

Returns:

string name

getDescription

public String getDescription()

Return the description of the target.

Returns:

string description

getTypeName

public String getTypeName()

Return the type name (or super type name) of a permitted target.

Returns:

name of an open metadata type

getDeployedImplementationType

public String getDeployedImplementationType()

Return a more specific definition of a permitted target.

Returns:

deployed implementation type name

getOtherPropertyValues

public Map<String,String> getOtherPropertyValues()

Return a map of property name to property value that the target should have to be valid for this integration connector.

Returns:

map of string to string

getActionTargetTypes

public static List<ActionTargetType> getActionTargetTypes()

Return the targets defined in this enum for all action targets.

Returns:

list

getCreateSubscriptionActionTargetTypes

public static List<ActionTargetType> getCreateSubscriptionActionTargetTypes()

Return the targets defined in this enum for create subscription.

Returns:

list

getCancelSubscriptionActionTargetTypes

public static List<ActionTargetType> getCancelSubscriptionActionTargetTypes()

Return the targets defined in this enum for create subscription.

Returns:

list

getActionTargetType

public ActionTargetType getActionTargetType()

Return an target type for use in the governance service's provider.

Returns:

target type

toString

public String toString()

JSON-style toString

Overrides:

toString in class Enum<ManageDigitalSubscriptionActionTarget>

Returns:

return string containing the property names and values