Enum Class ResourceKind

java.lang.Object

java.lang.Enum<ResourceKind>

com.eqixiac.equinix.design.plan.ResourceKind

All Implemented Interfaces:

Serializable, Comparable<ResourceKind>, Constable

public enum ResourceKind
extends Enum<ResourceKind>

The kinds of element a deployment plan holds, in the order they are created.

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BACKBONE_LINK	A Cloud Router to Cloud Router connection between two plan metros.
CLOUD_ROUTER	A Fabric Cloud Router (POST /fabric/v4/routers).
INTERCONNECT	A Fabric Interconnect: planned, never executable through the public API.
MULTICLOUD_LINK	A native provider-to-provider link: planned and priced, created by the customer outside Fabric.
PROVIDER_CONNECTION	A Cloud Router to service-provider connection (POST /fabric/v4/connections).
ROUTING_PROTOCOL	A DIRECT or BGP routing protocol on a planned connection.
UNKNOWN	Read-side fallback for a value this release does not know.

Method Summary

Modifier and Type	Method	Description
boolean	isConnection()	Whether the element is a Fabric connection (provider connection or backbone link).
boolean	isExecutable()	Whether the SDK creates elements of this kind through the Fabric API.
static ResourceKind	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResourceKind[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class Enum

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

Methods inherited from class Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

CLOUD_ROUTER

public static final ResourceKind CLOUD_ROUTER

A Fabric Cloud Router (POST /fabric/v4/routers).

PROVIDER_CONNECTION

public static final ResourceKind PROVIDER_CONNECTION

A Cloud Router to service-provider connection (POST /fabric/v4/connections).

BACKBONE_LINK

public static final ResourceKind BACKBONE_LINK

A Cloud Router to Cloud Router connection between two plan metros.

ROUTING_PROTOCOL

public static final ResourceKind ROUTING_PROTOCOL

A DIRECT or BGP routing protocol on a planned connection.

INTERCONNECT

public static final ResourceKind INTERCONNECT

A Fabric Interconnect: planned, never executable through the public API.

MULTICLOUD_LINK

public static final ResourceKind MULTICLOUD_LINK

A native provider-to-provider link: planned and priced, created by the customer outside Fabric.

UNKNOWN

public static final ResourceKind UNKNOWN

Read-side fallback for a value this release does not know.

Method Details

values

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

isExecutable

public boolean isExecutable()

Whether the SDK creates elements of this kind through the Fabric API.

Returns:

true for routers, connections, backbone links and routing protocols

isConnection

public boolean isConnection()

Whether the element is a Fabric connection (provider connection or backbone link).

Returns:

true for PROVIDER_CONNECTION and BACKBONE_LINK