com.vmware.vcenter.vm.hardware

Class EthernetTypes.BackingInfo

java.lang.Object

com.vmware.vcenter.vm.hardware.EthernetTypes.BackingInfo

All Implemented Interfaces:

StaticStructure, Structure, Serializable

Enclosing interface:

EthernetTypes

public static final class EthernetTypes.BackingInfo
extends Object
implements Serializable, StaticStructure

The BackingInfo class contains information about the physical resource backing a virtual Ethernet adapter.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	EthernetTypes.BackingInfo.Builder Builder class for EthernetTypes.BackingInfo.

Constructor Summary

Constructors

Constructor and Description
EthernetTypes.BackingInfo() Default constructor.

Method Summary

Methods

Modifier and Type	Method and Description
<T extends Structure> T	_convertTo(Class<T> clazz) Converts this structure into an instance of the provided class structure if possible.
String	_getCanonicalName() Returns the canonical name of the structure.
static String	_getCanonicalTypeName() Returns the canonical type name.
static com.vmware.vapi.bindings.type.StructType	_getClassType() WARNING: Internal API, subject to change in future versions.
StructValue	_getDataValue() Returns this Structure represented in the dynamic DataValue model.
DataValue	_getDynamicField(String fieldName) Get dynamic filed value.
Set<String>	_getDynamicFieldNames() Get the names of the dynamic fields in the structure.
com.vmware.vapi.bindings.type.StructType	_getType() WARNING: Internal API, subject to change in future versions.
boolean	_hasTypeNameOf(Class<? extends Structure> clazz) Checks that the runtime type name matches the type name from the binding class.
static EthernetTypes.BackingInfo	_newInstance(StructValue structValue) WARNING: Internal API, subject to change in future versions. Returns new instance of this binding class and injects the provided data value. WARNING: The returned object is not fully initialized.
void	_setDynamicField(String fieldName, DataValue fieldValue) Sets a dynamic field value.
void	_validate() Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.
boolean	equals(Object obj)
Long	getConnectionCookie() Server-generated cookie that identifies the connection to the port.
String	getDistributedPort() Key of the distributed virtual port that backs the virtual Ethernet adapter.
String	getDistributedSwitchUuid() UUID of the distributed virtual switch that backs the virtual Ethernet adapter.
String	getHostDevice() Name of the device backing the virtual Ethernet adapter.
String	getNetwork() Identifier of the network backing the virtual Ethernet adapter.
String	getNetworkName() Name of the standard portgroup backing the virtual Ethernet adapter.
String	getOpaqueNetworkId() Identifier of the opaque network that backs the virtual Ethernet adapter.
String	getOpaqueNetworkType() Type of the opaque network that backs the virtual Ethernet adapter.
EthernetTypes.BackingType	getType() Backing type for the virtual Ethernet adapter.
int	hashCode()
void	setConnectionCookie(Long connectionCookie) Server-generated cookie that identifies the connection to the port.
void	setDistributedPort(String distributedPort) Key of the distributed virtual port that backs the virtual Ethernet adapter.
void	setDistributedSwitchUuid(String distributedSwitchUuid) UUID of the distributed virtual switch that backs the virtual Ethernet adapter.
void	setHostDevice(String hostDevice) Name of the device backing the virtual Ethernet adapter.
void	setNetwork(String network) Identifier of the network backing the virtual Ethernet adapter.
void	setNetworkName(String networkName) Name of the standard portgroup backing the virtual Ethernet adapter.
void	setOpaqueNetworkId(String opaqueNetworkId) Identifier of the opaque network that backs the virtual Ethernet adapter.
void	setOpaqueNetworkType(String opaqueNetworkType) Type of the opaque network that backs the virtual Ethernet adapter.
void	setType(EthernetTypes.BackingType type) Backing type for the virtual Ethernet adapter.
String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EthernetTypes.BackingInfo

public EthernetTypes.BackingInfo()

Default constructor.

Method Detail

getType

public EthernetTypes.BackingType getType()

Backing type for the virtual Ethernet adapter.

Returns:

The current value of the property.

setType

public void setType(EthernetTypes.BackingType type)

Backing type for the virtual Ethernet adapter.

Parameters:

type - New value for the property.

getNetwork

public String getNetwork()

Identifier of the network backing the virtual Ethernet adapter. If null, the identifier of the network backing could not be determined.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Network.

setNetwork

public void setNetwork(String network)

Identifier of the network backing the virtual Ethernet adapter. If null, the identifier of the network backing could not be determined.

Parameters:

network - New value for the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: Network. When methods return a value of this class as a return value, the property will be an identifier for the resource type: Network.

getNetworkName

public String getNetworkName()

Name of the standard portgroup backing the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.STANDARD_PORTGROUP.

Returns:

The current value of the property.

setNetworkName

public void setNetworkName(String networkName)

Name of the standard portgroup backing the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.STANDARD_PORTGROUP.

Parameters:

networkName - New value for the property.

getHostDevice

public String getHostDevice()

Name of the device backing the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.HOST_DEVICE.

Returns:

The current value of the property.

setHostDevice

public void setHostDevice(String hostDevice)

Name of the device backing the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.HOST_DEVICE.

Parameters:

hostDevice - New value for the property.

getDistributedSwitchUuid

public String getDistributedSwitchUuid()

UUID of the distributed virtual switch that backs the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.DISTRIBUTED_PORTGROUP.

Returns:

The current value of the property.

setDistributedSwitchUuid

public void setDistributedSwitchUuid(String distributedSwitchUuid)

UUID of the distributed virtual switch that backs the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.DISTRIBUTED_PORTGROUP.

Parameters:

distributedSwitchUuid - New value for the property.

getDistributedPort

public String getDistributedPort()

Key of the distributed virtual port that backs the virtual Ethernet adapter. This property will be null if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.

Returns:

The current value of the property.

setDistributedPort

public void setDistributedPort(String distributedPort)

Key of the distributed virtual port that backs the virtual Ethernet adapter. This property will be null if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.

Parameters:

distributedPort - New value for the property.

getConnectionCookie

public Long getConnectionCookie()

Server-generated cookie that identifies the connection to the port. This ookie may be used to verify that the virtual machine is the rightful owner of the port. This property will be null if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.

Returns:

The current value of the property.

setConnectionCookie

public void setConnectionCookie(Long connectionCookie)

Server-generated cookie that identifies the connection to the port. This ookie may be used to verify that the virtual machine is the rightful owner of the port. This property will be null if the virtual Ethernet device is not bound to a distributed virtual port; this can happen if the virtual machine is powered off or the virtual Ethernet device is not connected.

Parameters:

connectionCookie - New value for the property.

getOpaqueNetworkType

public String getOpaqueNetworkType()

Type of the opaque network that backs the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.OPAQUE_NETWORK.

Returns:

The current value of the property.

setOpaqueNetworkType

public void setOpaqueNetworkType(String opaqueNetworkType)

Type of the opaque network that backs the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.OPAQUE_NETWORK.

Parameters:

opaqueNetworkType - New value for the property.

getOpaqueNetworkId

public String getOpaqueNetworkId()

Identifier of the opaque network that backs the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.OPAQUE_NETWORK.

Returns:

The current value of the property.

setOpaqueNetworkId

public void setOpaqueNetworkId(String opaqueNetworkId)

Identifier of the opaque network that backs the virtual Ethernet adapter. This property is optional and it is only relevant when the value of getType() is EthernetTypes.BackingType.OPAQUE_NETWORK.

Parameters:

opaqueNetworkId - New value for the property.

_getType

public com.vmware.vapi.bindings.type.StructType _getType()

Description copied from interface: StaticStructure

WARNING: Internal API, subject to change in future versions. Returns StructType instance representing the static bindings type for this Structure.

Specified by:

_getType in interface StaticStructure

Returns:

the static bindings StructType

_getDataValue

public StructValue _getDataValue()

Description copied from interface: Structure

Returns this Structure represented in the dynamic DataValue model.

Attempts to change the returned StructValue representation are not required to change the state of this structure. Actually the behavior is implementation dependent and is unspecified. In general the returned value shouldn't be changed.

Specified by:

_getDataValue in interface Structure

Returns:

StructValue representing this structure

_validate

public void _validate()

Description copied from interface: StaticStructure

Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding Structure.

More precisely, for each union: given value of the discriminant/tag field (@UnionTag in the IDL) of an union in this structure, validates that:

all fields of the union required for that value of the discriminant are set fields of the union that are not allowed for that value of the discriminant are not set any other fields of the structure (not participating in the union) do not affect the validation result

Specified by:

_validate in interface StaticStructure

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Description copied from interface: StaticStructure

Returns a string representation of this structure. The result is pretty printed in order to be easy to read. It is intended to be used for different debugging/tracing purposes, e.g. dumping structures into logging traces.

In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.

Specified by:

toString in interface StaticStructure

Overrides:

toString in class Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf

public boolean _hasTypeNameOf(Class<? extends Structure> clazz)

Description copied from interface: Structure

Checks that the runtime type name matches the type name from the binding class.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

true if this structures type name matches exactly the provided class type name.

_convertTo

public <T extends Structure> T _convertTo(Class<T> clazz)

Description copied from interface: Structure

Converts this structure into an instance of the provided class structure if possible. A conversion will be possible if the requested structure's fields are all present in this structure.

Specified by:

_convertTo in interface Structure

Parameters:

clazz - type of the result structure. cannot be null.

Returns:

an instance of the requested type if conversion is possible. CoreException is thrown otherwise.

_setDynamicField

public void _setDynamicField(String fieldName,
                    DataValue fieldValue)

Description copied from interface: StaticStructure

Sets a dynamic field value. The dynamic filed is extra filed that is not part of the static fields of the structure.

Specified by:

_setDynamicField in interface StaticStructure

Parameters:

fieldName - canonical name of the dynamic field to set

fieldValue - the value of the field

_getDynamicField

public DataValue _getDynamicField(String fieldName)

Description copied from interface: StaticStructure

Get dynamic filed value. Works only on dynamic fields.

Specified by:

_getDynamicField in interface StaticStructure

Parameters:

fieldName - the canonical name of the dynamic field

Returns:

the DataValue of the dynamic field

_getDynamicFieldNames

public Set<String> _getDynamicFieldNames()

Description copied from interface: StaticStructure

Get the names of the dynamic fields in the structure.

Specified by:

_getDynamicFieldNames in interface StaticStructure

Returns:

set of the canonical field names for the dynamic fields

_getClassType

public static com.vmware.vapi.bindings.type.StructType _getClassType()

WARNING: Internal API, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName

public String _getCanonicalName()

Description copied from interface: Structure

Returns the canonical name of the structure. By default the canonical name is derived from the fully-qualified IDL name by converting to lower case and inserting underscores between words. For example org.example.FooBar would turn into org.example.foo_bar.

Specified by:

_getCanonicalName in interface Structure

Returns:

canonical name

_getCanonicalTypeName

public static String _getCanonicalTypeName()

Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance

public static EthernetTypes.BackingInfo _newInstance(StructValue structValue)

WARNING: Internal API, subject to change in future versions.
Returns new instance of this binding class and injects the provided data value.
WARNING: The returned object is not fully initialized.

Parameters:

structValue - the source of the data contained in the binding object. Could contain more data than fields of this class can describe i.e. newer version of the binding object. Could be null.

Returns:

the static bindings StructType