com.vmware.appliance.logging

Class ForwardingTypes.Protocol

java.lang.Object

com.vmware.vapi.bindings.ApiEnumeration<ForwardingTypes.Protocol>

com.vmware.appliance.logging.ForwardingTypes.Protocol

All Implemented Interfaces:

java.io.Serializable

Enclosing interface:

ForwardingTypes

public static final class ForwardingTypes.Protocol
extends ApiEnumeration<ForwardingTypes.Protocol>

The Protocol enumeration class defines transport protocols for outbound log messages. This enumeration was added in vSphere API 6.7.

See enumerated types description.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ForwardingTypes.Protocol.Values Native Java enum representing this enumeration class.

Field Summary

Fields

Modifier and Type	Field and Description
static ForwardingTypes.Protocol	TCP Log messages will be forwarded to the remote host using the TCP protocol.
static ForwardingTypes.Protocol	TLS Log messages will be forwarded to the remote host by using the TLS protocol.
static ForwardingTypes.Protocol	UDP Log messages will be forwarded to the remote host using the UDP protocol.

Method Summary

Methods

Modifier and Type	Method and Description
ForwardingTypes.Protocol.Values	getEnumValue() Returns a native Java enum constant representing this enumeration constant.
boolean	isUnknown() Checks if this enumeration constant is unknown.
static ForwardingTypes.Protocol	valueOf(java.lang.String name) Returns the enumeration constant for the specified name.
static ForwardingTypes.Protocol[]	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

TLS

public static final ForwardingTypes.Protocol TLS

Log messages will be forwarded to the remote host by using the TLS protocol. This constant field was added in vSphere API 6.7.

UDP

public static final ForwardingTypes.Protocol UDP

Log messages will be forwarded to the remote host using the UDP protocol. This constant field was added in vSphere API 6.7.

TCP

public static final ForwardingTypes.Protocol TCP

Log messages will be forwarded to the remote host using the TCP protocol. This constant field was added in vSphere API 6.7.

Method Detail

values

public static ForwardingTypes.Protocol[] 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 ForwardingTypes.Protocol but is not pre-defined.

Returns:

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

valueOf

public static ForwardingTypes.Protocol 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 ForwardingTypes.Protocol will be returned for the specified name, which will not be one of the pre-defined constant instances. Such new instance maps to the ForwardingTypes.Protocol.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 ForwardingTypes.Protocol.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 ForwardingTypes.Protocol.Values._UNKNOWN enum constant is returned.

The native Java enum is ForwardingTypes.Protocol.Values.

Returns:

The Java enum constant. Never null.