Enum Class EnvironmentVisibility

java.lang.Object

java.lang.Enum<EnvironmentVisibility>

com.eqixiac.equinix.core.model.multicloud.EnvironmentVisibility

All Implemented Interfaces:

Serializable, Comparable<EnvironmentVisibility>, Constable

public enum EnvironmentVisibility
extends Enum<EnvironmentVisibility>

Visibility of a specification environment in a provider's customer-facing APIs (environment.yaml#/EnvironmentVisibility); carried by Environment.environmentVisibility, output only. Constant names equal the wire values.

Beta: derived from the open specification at commit bbfc763 (see the package documentation).

UNKNOWN is a read-side fallback for values added after this SDK release, and the value EnvironmentRef reports when no visibility was supplied; never send it.

Author:

ianjones

Nested Class Summary

Nested classes/interfaces inherited from class Enum

Enum.EnumDesc<E>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ENVIRONMENT_VISIBILITY_PRIVATE	Limited visibility, as jointly defined by the two providers, to an individual customer or a small number of customers.
ENVIRONMENT_VISIBILITY_PUBLIC	Visible to all customers of the provider with little to no restriction.
UNKNOWN	Read-side fallback for a value this enum does not list, or for an absent value.

Method Summary

Modifier and Type	Method	Description
static EnvironmentVisibility	fromString(String value)	Parses a wire value.
static EnvironmentVisibility	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EnvironmentVisibility[]	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

ENVIRONMENT_VISIBILITY_PRIVATE

public static final EnvironmentVisibility ENVIRONMENT_VISIBILITY_PRIVATE

Limited visibility, as jointly defined by the two providers, to an individual customer or a small number of customers.

ENVIRONMENT_VISIBILITY_PUBLIC

public static final EnvironmentVisibility ENVIRONMENT_VISIBILITY_PUBLIC

Visible to all customers of the provider with little to no restriction.

UNKNOWN

public static final EnvironmentVisibility UNKNOWN

Read-side fallback for a value this enum does not list, or for an absent value.

Method Details

values

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

fromString

public static EnvironmentVisibility fromString(String value)

Parses a wire value. Surrounding whitespace is trimmed and case is ignored.

Parameters:

value - the wire value, for example ENVIRONMENT_VISIBILITY_PUBLIC; may be null

Returns:

the matching constant, or UNKNOWN when value is null, blank or not listed