com.vmware.vcenter.vm.hardware

Class SerialTypes.BackingInfo.Builder

java.lang.Object

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

Enclosing class:

SerialTypes.BackingInfo

public static final class SerialTypes.BackingInfo.Builder
extends Object

Builder class for SerialTypes.BackingInfo.

Constructor Summary

Constructors

Constructor and Description
SerialTypes.BackingInfo.Builder(SerialTypes.BackingType type) Constructor with parameters for the required properties of SerialTypes.BackingInfo.

Method Summary

Methods

Modifier and Type	Method and Description
SerialTypes.BackingInfo	build()
SerialTypes.BackingInfo.Builder	setAutoDetect(Boolean autoDetect) Flag indicating whether the virtual serial port is configured to automatically detect a suitable host device.
SerialTypes.BackingInfo.Builder	setFile(String file) Path of the file backing the virtual serial port.
SerialTypes.BackingInfo.Builder	setHostDevice(String hostDevice) Name of the device backing the virtual serial port.
SerialTypes.BackingInfo.Builder	setNetworkLocation(URI networkLocation) URI specifying the location of the network service backing the virtual serial port.
SerialTypes.BackingInfo.Builder	setNoRxLoss(Boolean noRxLoss) Flag that enables optimized data transfer over the pipe.
SerialTypes.BackingInfo.Builder	setPipe(String pipe) Name of the pipe backing the virtual serial port.
SerialTypes.BackingInfo.Builder	setProxy(URI proxy) Proxy service that provides network access to the network backing.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerialTypes.BackingInfo.Builder

public SerialTypes.BackingInfo.Builder(SerialTypes.BackingType type)

Constructor with parameters for the required properties of SerialTypes.BackingInfo.

Method Detail

setFile

public SerialTypes.BackingInfo.Builder 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.

setHostDevice

public SerialTypes.BackingInfo.Builder 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.

setAutoDetect

public SerialTypes.BackingInfo.Builder 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.

setPipe

public SerialTypes.BackingInfo.Builder 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.

setNoRxLoss

public SerialTypes.BackingInfo.Builder 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.

setNetworkLocation

public SerialTypes.BackingInfo.Builder setNetworkLocation(URI networkLocation)

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

• If SerialTypes.BackingInfo.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 SerialTypes.BackingInfo.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.

setProxy

public SerialTypes.BackingInfo.Builder 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.

build

public SerialTypes.BackingInfo build()