com.vmware.vcenter.vm.hardware

Class SerialTypes.BackingInfo

java.lang.Object

com.vmware.vcenter.vm.hardware.SerialTypes.BackingInfo

All Implemented Interfaces:

StaticStructure, Structure, Serializable

Enclosing interface:

SerialTypes

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

The BackingInfo class contains information about the physical resource backing a virtual serial port.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor and Description
SerialTypes.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 SerialTypes.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)
Boolean	getAutoDetect() Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.
String	getFile() Path of the file backing the virtual serial port.
String	getHostDevice() Name of the device backing the virtual serial port.
URI	getNetworkLocation() URI specifying the location of the network service backing the virtual serial port.
Boolean	getNoRxLoss() Flag that enables optimized data transfer over the pipe.
String	getPipe() Name of the pipe backing the virtual serial port.
URI	getProxy() Proxy service that provides network access to the network backing.
SerialTypes.BackingType	getType() Backing type for the virtual serial port.
int	hashCode()
void	setAutoDetect(Boolean autoDetect) Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.
void	setFile(String file) Path of the file backing the virtual serial port.
void	setHostDevice(String hostDevice) Name of the device backing the virtual serial port.
void	setNetworkLocation(URI networkLocation) URI specifying the location of the network service backing the virtual serial port.
void	setNoRxLoss(Boolean noRxLoss) Flag that enables optimized data transfer over the pipe.
void	setPipe(String pipe) Name of the pipe backing the virtual serial port.
void	setProxy(URI proxy) Proxy service that provides network access to the network backing.
void	setType(SerialTypes.BackingType type) Backing type for the virtual serial port.
String	toString() Returns a string representation of this structure.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SerialTypes.BackingInfo

public SerialTypes.BackingInfo()

Default constructor.

Method Detail

getType

public SerialTypes.BackingType getType()

Backing type for the virtual serial port.

Returns:

The current value of the property.

setType

public void setType(SerialTypes.BackingType type)

Backing type for the virtual serial port.

Parameters:

type - New value for the property.

getFile

public String getFile()

Path of the file backing the virtual serial port. This property is optional and it is only relevant when the value of getType() is SerialTypes.BackingType.FILE.

Returns:

The current value of the property.

setFile

public void setFile(String file)

Path of the file backing the virtual serial port. This property is optional and it is only relevant when the value of getType() is SerialTypes.BackingType.FILE.

Parameters:

file - New value for the property.

getHostDevice

public String getHostDevice()

Name of the device backing the virtual serial port.

This property will be null if getAutoDetect() is true and the virtual serial port is not connected or no suitable device is available on the host.

Returns:

The current value of the property.

setHostDevice

public void setHostDevice(String hostDevice)

Name of the device backing the virtual serial port.

This property will be null if getAutoDetect() is true and the virtual serial port is not connected or no suitable device is available on the host.

Parameters:

hostDevice - New value for the property.

getAutoDetect

public Boolean getAutoDetect()

Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device. This property is optional and it is only relevant when the value of getType() is SerialTypes.BackingType.HOST_DEVICE.

Returns:

The current value of the property.

setAutoDetect

public void setAutoDetect(Boolean autoDetect)

Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device. This property is optional and it is only relevant when the value of getType() is SerialTypes.BackingType.HOST_DEVICE.

Parameters:

autoDetect - New value for the property.

getPipe

public String getPipe()

Name of the pipe backing the virtual serial port. This property is optional and it is only relevant when the value of getType() is one of SerialTypes.BackingType.PIPE_SERVER or SerialTypes.BackingType.PIPE_CLIENT.

Returns:

The current value of the property.

setPipe

public void setPipe(String pipe)

Name of the pipe backing the virtual serial port. This property is optional and it is only relevant when the value of getType() is one of SerialTypes.BackingType.PIPE_SERVER or SerialTypes.BackingType.PIPE_CLIENT.

Parameters:

pipe - New value for the property.

getNoRxLoss

public Boolean getNoRxLoss()

Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss. This property is optional and it is only relevant when the value of getType() is one of SerialTypes.BackingType.PIPE_SERVER or SerialTypes.BackingType.PIPE_CLIENT.

Returns:

The current value of the property.

setNoRxLoss

public void setNoRxLoss(Boolean noRxLoss)

Flag that enables optimized data transfer over the pipe. When the value is true, the host buffers data to prevent data overrun. This allows the virtual machine to read all of the data transferred over the pipe with no data loss. This property is optional and it is only relevant when the value of getType() is one of SerialTypes.BackingType.PIPE_SERVER or SerialTypes.BackingType.PIPE_CLIENT.

Parameters:

noRxLoss - New value for the property.

getNetworkLocation

public URI getNetworkLocation()

URI specifying the location of the network service backing the virtual serial port.

• If getType() is SerialTypes.BackingType.NETWORK_SERVER, this property is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
• If getType() is SerialTypes.BackingType.NETWORK_CLIENT, this property is the location used by the virtual machine to connect to the remote server.

This property is optional and it is only relevant when the value of getType() is one of SerialTypes.BackingType.NETWORK_SERVER or SerialTypes.BackingType.NETWORK_CLIENT.

Returns:

The current value of the property.

setNetworkLocation

public void setNetworkLocation(URI networkLocation)

URI specifying the location of the network service backing the virtual serial port.

• If getType() is SerialTypes.BackingType.NETWORK_SERVER, this property is the location used by clients to connect to this server. The hostname part of the URI should either be empty or should specify the address of the host on which the virtual machine is running.
• If getType() is SerialTypes.BackingType.NETWORK_CLIENT, this property is the location used by the virtual machine to connect to the remote server.

This property is optional and it is only relevant when the value of getType() is one of SerialTypes.BackingType.NETWORK_SERVER or SerialTypes.BackingType.NETWORK_CLIENT.

Parameters:

networkLocation - New value for the property.

getProxy

public URI getProxy()

Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy. If null, no proxy service is configured.

Returns:

The current value of the property.

setProxy

public void setProxy(URI proxy)

Proxy service that provides network access to the network backing. If set, the virtual machine initiates a connection with the proxy service and forwards the traffic to the proxy. If null, no proxy service is configured.

Parameters:

proxy - 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 SerialTypes.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