SerialTypes.BackingInfo (vSphere Automation SDK for Java 7.0.1.0)

java.lang.Object
- com.vmware.vcenter.vm.hardware.SerialTypes.BackingInfo

All Implemented Interfaces:

StaticStructure, Structure, java.io.Serializable

Enclosing interface:

SerialTypes
```
public static final class SerialTypes.BackingInfo
extends java.lang.Object
implements java.io.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.

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

Field Summary

Fields
Modifier and Type Field and Description

protected StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier Constructor and Description

BackingInfo()
Default constructor.

protected BackingInfo(StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`BackingInfo()` Default constructor.
`protected`	`BackingInfo(StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends Structure> T`	`_convertTo(java.lang.Class<T> clazz)` Converts this structure into an instance of the provided class structure if possible.
`java.lang.String`	`_getCanonicalName()` Returns the canonical name of the structure.
`static java.lang.String`	`_getCanonicalTypeName()` Returns the canonical type name.
`static com.vmware.vapi.bindings.type.StructType`	`_getClassType()` WARNING: Internal method, subject to change in future versions.
`StructValue`	`_getDataValue()` Returns this `Structure` represented in the dynamic `DataValue` model.
`DataValue`	`_getDynamicField(java.lang.String fieldName)` Get dynamic filed value.
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()` Get the names of the dynamic fields in the structure.
`com.vmware.vapi.bindings.type.StructType`	`_getType()` WARNING: Internal method, subject to change in future versions.
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)` Checks if the runtime type name of this structure matches the type represented by the specified binding class.
`static SerialTypes.BackingInfo`	`_newInstance(StructValue structValue)` WARNING: Internal method, 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.
`static SerialTypes.BackingInfo`	`_newInstance2(StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, DataValue fieldValue)` Sets a dynamic field value.
`protected void`	`_updateDataValue(StructValue structValue)`
`void`	`_validate()` Validates the state of the discriminated unions and HasFieldsOf restrictions (if any) in this Java language binding `Structure`.
`boolean`	`equals(java.lang.Object obj)`
`java.lang.Boolean`	`getAutoDetect()` Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.
`java.lang.String`	`getFile()` Path of the file backing the virtual serial port.
`java.lang.String`	`getHostDevice()` Name of the device backing the virtual serial port.
`java.net.URI`	`getNetworkLocation()` URI specifying the location of the network service backing the virtual serial port.
`java.lang.Boolean`	`getNoRxLoss()` Flag that enables optimized data transfer over the pipe.
`java.lang.String`	`getPipe()` Name of the pipe backing the virtual serial port.
`java.net.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(java.lang.Boolean autoDetect)` Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.
`void`	`setFile(java.lang.String file)` Path of the file backing the virtual serial port.
`void`	`setHostDevice(java.lang.String hostDevice)` Name of the device backing the virtual serial port.
`void`	`setNetworkLocation(java.net.URI networkLocation)` URI specifying the location of the network service backing the virtual serial port.
`void`	`setNoRxLoss(java.lang.Boolean noRxLoss)` Flag that enables optimized data transfer over the pipe.
`void`	`setPipe(java.lang.String pipe)` Name of the pipe backing the virtual serial port.
`void`	`setProxy(java.net.URI proxy)` Proxy service that provides network access to the network backing.
`void`	`setType(SerialTypes.BackingType type)` Backing type for the virtual serial port.
`java.lang.String`	`toString()` Returns a string representation of this structure.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Field Detail
  - __dynamicStructureFields
```
protected StructValue __dynamicStructureFields
```
- Constructor Detail
  - BackingInfo
```
public BackingInfo()
```
    Default constructor.
  - BackingInfo
```
protected BackingInfo(StructValue __dynamicStructureFields)
```
- 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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.net.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(java.net.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 java.net.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(java.net.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 method, 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
  - _updateDataValue
```
protected void _updateDataValue(StructValue structValue)
```
  - _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(java.lang.Object obj)

Overrides:: equals in class java.lang.Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class java.lang.Object

toString
```
public java.lang.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 java.lang.Object

Returns:

a string representation of this static structure instance

_hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
```
Description copied from interface: Structure

Checks if the runtime type name of this structure matches the type represented by the specified binding class.
This can be used as efficient check to determine if this instance can be successfully converted to the target type.

Specified by:

_hasTypeNameOf in interface Structure

Parameters:

clazz - bindings class for the target structure; must not be null

Returns:

true if this structures type name matches exactly the specified class' type name.

_convertTo
```
public <T extends Structure> T _convertTo(java.lang.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(java.lang.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(java.lang.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 java.util.Set<java.lang.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 method, subject to change in future versions.

Returns:

StructType instance representing the static bindings type for this Structure.

_getCanonicalName
```
public java.lang.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 java.lang.String _getCanonicalTypeName()
```
Returns the canonical type name. See _getCanonicalName().

Returns:

canonical type name

_newInstance
```
public static SerialTypes.BackingInfo _newInstance(StructValue structValue)
```
WARNING: Internal method, 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

_newInstance2
```
public static SerialTypes.BackingInfo _newInstance2(StructValue structValue)
```
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.

Class SerialTypes.BackingInfo

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

BackingInfo

BackingInfo

Method Detail

getType

setType

getFile

setFile

getHostDevice

setHostDevice

getAutoDetect

setAutoDetect

getPipe

setPipe

getNoRxLoss

setNoRxLoss

getNetworkLocation

setNetworkLocation

getProxy

setProxy

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2