com.vmware.vcenter.identity

Class ProvidersTypes.IdmProtocol

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ProvidersTypes.IdmProtocol>

com.vmware.vcenter.identity.ProvidersTypes.IdmProtocol

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

ProvidersTypes

public static final class ProvidersTypes.IdmProtocol
extends ApiEnumeration<ProvidersTypes.IdmProtocol>

The IdmProtocol class contains the possible types of communication protocols to the identity management endpoints. This enumeration was added in vSphere API 7.0.0.0.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ProvidersTypes.IdmProtocol.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static ProvidersTypes.IdmProtocol	LDAP LDAP protocol based identity management endpoints.
static ProvidersTypes.IdmProtocol	REST REST protocol based identity management endpoints.
static ProvidersTypes.IdmProtocol	SCIM SCIM V1.1 protocol based identity management endpoints.
static ProvidersTypes.IdmProtocol	SCIM2_0 SCIM V2.0 protocol based identity management endpoints.

Method Summary

Modifier and Type	Method and Description
ProvidersTypes.IdmProtocol.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static ProvidersTypes.IdmProtocol	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static ProvidersTypes.IdmProtocol[]	values() Retrieve all enumeration constants pre-defined by this enumeration class.

Methods inherited from class com.vmware.vapi.bindings.ApiEnumeration

buildNameMap, equals, hashCode, name, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

REST

public static final ProvidersTypes.IdmProtocol REST

REST protocol based identity management endpoints. This constant field was added in vSphere API 7.0.0.0.

SCIM

public static final ProvidersTypes.IdmProtocol SCIM

SCIM V1.1 protocol based identity management endpoints. This constant field was added in vSphere API 7.0.0.0.

SCIM2_0

public static final ProvidersTypes.IdmProtocol SCIM2_0

SCIM V2.0 protocol based identity management endpoints. This constant field was added in vSphere API 7.0.0.0.

LDAP

public static final ProvidersTypes.IdmProtocol LDAP

LDAP protocol based identity management endpoints. This constant field was added in vSphere API 7.0.0.0.

Method Detail

values

public static ProvidersTypes.IdmProtocol[] values()

Retrieve all enumeration constants pre-defined by this enumeration class.

Additional instances might exist at runtime, for example to represent a new constant added to this enumeration class in subsequent version of the API. Such new constant is represented as instance of ProvidersTypes.IdmProtocol but is not pre-defined.

Returns:

Array of all pre-defined enumeration constants. Never null.

valueOf

public static ProvidersTypes.IdmProtocol valueOf(java.lang.String name)

Returns the enumeration constant for the specified name.

If the name matches exactly the identifier used to declare an enumeration constant from this enumeration class, the constant in question will be returned.

Otherwise, a new instance of ProvidersTypes.IdmProtocol will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the ProvidersTypes.IdmProtocol.Values._UNKNOWN enum constant from the native Java enum.

Parameters:

name - The name of the constant to return. Must not be null.

Returns:

Enumeration constant for the specified name. Never null.

isUnknown

public boolean isUnknown()

Checks if this enumeration constant is unknown. Unknown is a constant that is not one of the pre-defined ones for this enumeration class. Also see valueOf(java.lang.String) and values().

Returns:

true if this constant is unknown, and false otherwise.

getEnumValue

public ProvidersTypes.IdmProtocol.Values getEnumValue()

Returns a native Java enum constant representing this enumeration constant. The result is useful for usual handling of Java enum, for example it can be used in switch statements.

If this enumeration constant is unknown, then ProvidersTypes.IdmProtocol.Values._UNKNOWN enum constant is returned.

The native Java enum is ProvidersTypes.IdmProtocol.Values.

Returns:

The Java enum constant. Never null.