Package co.ecg.alpaca.toolkit.generated

Class SystemAccessDevice.SystemAccessDeviceModifyRequest

java.lang.Object

co.ecg.alpaca.toolkit.messaging.request.Request<DefaultResponse>

co.ecg.alpaca.toolkit.generated.SystemAccessDevice.SystemAccessDeviceModifyRequest

Enclosing class:

SystemAccessDevice

@ChoiceGroup("systemAccessDevice") @ChoiceGroup("deviceExternalId")
public static class SystemAccessDevice.SystemAccessDeviceModifyRequest
extends Request<DefaultResponse>

Request to modify a specified system access device. The response is either a SuccessResponse or an ErrorResponse. The following elements are only used in AS data mode and ignored in XS data mode: isWebexTeamsDevice defaultPathHeader deviceExternalId

Author:

AlpacaGenerator

Nested Class Summary

Nested classes/interfaces inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

Request.Protocol

Field Summary

Fields

Modifier and Type	Field	Description
protected Optional<@Valid DeviceManagementUserNamePassword16>	accessDeviceCredentials
protected Optional<@Size(min=1,max=1024) String>	defaultPathHeader
protected Optional<@Size(min=1,max=80) String>	description
protected @Size(max=36) String	deviceExternalId
protected Boolean	isWebexTeamsDevice
protected Optional<@Size(min=1,max=12) String>	macAddress
protected Optional<@Size(min=1,max=80) String>	netAddress
protected Optional<@Size(min=1,max=80) String>	outboundProxyServerNetAddress
protected Optional<@Size(min=1,max=1024) String>	physicalLocation
protected Optional<Integer>	port
protected @Size(min=1,max=20) String	protocol
protected Optional<@Size(min=1,max=80) String>	serialNumber
protected Optional<@Size(min=1,max=80) String>	stunServerNetAddress
protected @Valid SystemAccessDevice	systemAccessDevice
protected ExtendedTransportProtocol	transportProtocol
protected Boolean	useCustomUserNamePassword

Fields inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

log

Constructor Summary

Constructors

Constructor	Description
SystemAccessDeviceModifyRequest()
SystemAccessDeviceModifyRequest(SystemAccessDevice systemAccessDevice)
SystemAccessDeviceModifyRequest(BroadWorksServer broadWorksServer)
SystemAccessDeviceModifyRequest(BroadWorksServer broadWorksServer, String deviceExternalId)

Method Summary

Modifier and Type	Method	Description
void	formRequest()	Forms the XML Document for this Request Object.
Optional<@Valid DeviceManagementUserNamePassword16>	getAccessDeviceCredentials()
Optional<@Size(min=1,max=1024) String>	getDefaultPathHeader()
Optional<@Size(min=1,max=80) String>	getDescription()
String	getDeviceExternalId()
Boolean	getIsWebexTeamsDevice()
Optional<@Size(min=1,max=12) String>	getMacAddress()
Optional<@Size(min=1,max=80) String>	getNetAddress()
Optional<@Size(min=1,max=80) String>	getOutboundProxyServerNetAddress()
Optional<@Size(min=1,max=1024) String>	getPhysicalLocation()
Optional<Integer>	getPort()
String	getProtocol()
Optional<@Size(min=1,max=80) String>	getSerialNumber()
Optional<@Size(min=1,max=80) String>	getStunServerNetAddress()
SystemAccessDevice	getSystemAccessDevice()
ExtendedTransportProtocol	getTransportProtocol()
Boolean	getUseCustomUserNamePassword()
SystemAccessDevice.SystemAccessDeviceModifyRequest	setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setDefaultPathHeader(String defaultPathHeader)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setDescription(String description)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setDeviceExternalId(String deviceExternalId)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setIsWebexTeamsDevice(Boolean isWebexTeamsDevice)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setMacAddress(String macAddress)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setNetAddress(String netAddress)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setPhysicalLocation(String physicalLocation)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setPort(Integer port)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setProtocol(String protocol)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setSerialNumber(String serialNumber)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setStunServerNetAddress(String stunServerNetAddress)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setSystemAccessDevice(SystemAccessDevice systemAccessDevice)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setTransportProtocol(ExtendedTransportProtocol transportProtocol)
SystemAccessDevice.SystemAccessDeviceModifyRequest	setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetAccessDeviceCredentials()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetDefaultPathHeader()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetDescription()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetMacAddress()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetNetAddress()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetOutboundProxyServerNetAddress()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetPhysicalLocation()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetPort()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetSerialNumber()
SystemAccessDevice.SystemAccessDeviceModifyRequest	unsetStunServerNetAddress()

Methods inherited from class co.ecg.alpaca.toolkit.messaging.request.Request

appendChild, appendChild, appendChild, asyncFire, createElement, createNilElement, createNilElement, createTextElement, equals, fire, fire, getBroadWorksServer, getCacheString, getCommandElement, getCommandType, getDomDocument, getId, getOCSProtocol, getRequestTimeoutMillis, getResponseClass, getRetries, getRetryCodes, getRootElement, getValidationErrorsAsString, hashCode, isIgnoreCache, isMemberOfBundle, isValid, setBroadWorksServer, setCommandElement, setCommandType, setDomDocument, setEcho, setIgnoreCache, setMemberOfBundle, setRequestId, setRequestTimeoutMillis, setResponseClass, setRetries, setRetryCodes, setRootElement, toString, validate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

systemAccessDevice

@Valid
protected transient @Valid SystemAccessDevice systemAccessDevice

deviceExternalId

@Size(max=36)
protected @Size(max=36) String deviceExternalId

protocol

@Size(min=1,
      max=20)
protected @Size(min=1,max=20) String protocol

netAddress

protected Optional<@Size(min=1,max=80) String> netAddress

port

protected Optional<Integer> port

outboundProxyServerNetAddress

protected Optional<@Size(min=1,max=80) String> outboundProxyServerNetAddress

stunServerNetAddress

protected Optional<@Size(min=1,max=80) String> stunServerNetAddress

macAddress

protected Optional<@Size(min=1,max=12) String> macAddress

serialNumber

protected Optional<@Size(min=1,max=80) String> serialNumber

description

protected Optional<@Size(min=1,max=80) String> description

physicalLocation

protected Optional<@Size(min=1,max=1024) String> physicalLocation

transportProtocol

protected ExtendedTransportProtocol transportProtocol

useCustomUserNamePassword

protected Boolean useCustomUserNamePassword

accessDeviceCredentials

protected Optional<@Valid DeviceManagementUserNamePassword16> accessDeviceCredentials

isWebexTeamsDevice

protected Boolean isWebexTeamsDevice

defaultPathHeader

protected Optional<@Size(min=1,max=1024) String> defaultPathHeader

Constructor Details

SystemAccessDeviceModifyRequest

public SystemAccessDeviceModifyRequest()

SystemAccessDeviceModifyRequest

public SystemAccessDeviceModifyRequest(BroadWorksServer broadWorksServer)

SystemAccessDeviceModifyRequest

public SystemAccessDeviceModifyRequest(SystemAccessDevice systemAccessDevice)

SystemAccessDeviceModifyRequest

public SystemAccessDeviceModifyRequest(BroadWorksServer broadWorksServer,
 String deviceExternalId)

Method Details

setSystemAccessDevice

public SystemAccessDevice.SystemAccessDeviceModifyRequest setSystemAccessDevice(SystemAccessDevice systemAccessDevice)

getSystemAccessDevice

public SystemAccessDevice getSystemAccessDevice()

setDeviceExternalId

public SystemAccessDevice.SystemAccessDeviceModifyRequest setDeviceExternalId(String deviceExternalId)

getDeviceExternalId

public String getDeviceExternalId()

setProtocol

public SystemAccessDevice.SystemAccessDeviceModifyRequest setProtocol(String protocol)

getProtocol

public String getProtocol()

unsetNetAddress

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetNetAddress()

setNetAddress

public SystemAccessDevice.SystemAccessDeviceModifyRequest setNetAddress(String netAddress)

getNetAddress

public Optional<@Size(min=1,max=80) String> getNetAddress()

unsetPort

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetPort()

setPort

public SystemAccessDevice.SystemAccessDeviceModifyRequest setPort(Integer port)

getPort

public Optional<Integer> getPort()

unsetOutboundProxyServerNetAddress

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetOutboundProxyServerNetAddress()

setOutboundProxyServerNetAddress

public SystemAccessDevice.SystemAccessDeviceModifyRequest setOutboundProxyServerNetAddress(String outboundProxyServerNetAddress)

getOutboundProxyServerNetAddress

public Optional<@Size(min=1,max=80) String> getOutboundProxyServerNetAddress()

unsetStunServerNetAddress

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetStunServerNetAddress()

setStunServerNetAddress

public SystemAccessDevice.SystemAccessDeviceModifyRequest setStunServerNetAddress(String stunServerNetAddress)

getStunServerNetAddress

public Optional<@Size(min=1,max=80) String> getStunServerNetAddress()

unsetMacAddress

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetMacAddress()

setMacAddress

public SystemAccessDevice.SystemAccessDeviceModifyRequest setMacAddress(String macAddress)

getMacAddress

public Optional<@Size(min=1,max=12) String> getMacAddress()

unsetSerialNumber

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetSerialNumber()

setSerialNumber

public SystemAccessDevice.SystemAccessDeviceModifyRequest setSerialNumber(String serialNumber)

getSerialNumber

public Optional<@Size(min=1,max=80) String> getSerialNumber()

unsetDescription

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetDescription()

setDescription

public SystemAccessDevice.SystemAccessDeviceModifyRequest setDescription(String description)

getDescription

public Optional<@Size(min=1,max=80) String> getDescription()

unsetPhysicalLocation

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetPhysicalLocation()

setPhysicalLocation

public SystemAccessDevice.SystemAccessDeviceModifyRequest setPhysicalLocation(String physicalLocation)

getPhysicalLocation

public Optional<@Size(min=1,max=1024) String> getPhysicalLocation()

setTransportProtocol

public SystemAccessDevice.SystemAccessDeviceModifyRequest setTransportProtocol(ExtendedTransportProtocol transportProtocol)

getTransportProtocol

public ExtendedTransportProtocol getTransportProtocol()

setUseCustomUserNamePassword

public SystemAccessDevice.SystemAccessDeviceModifyRequest setUseCustomUserNamePassword(Boolean useCustomUserNamePassword)

getUseCustomUserNamePassword

public Boolean getUseCustomUserNamePassword()

unsetAccessDeviceCredentials

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetAccessDeviceCredentials()

setAccessDeviceCredentials

public SystemAccessDevice.SystemAccessDeviceModifyRequest setAccessDeviceCredentials(DeviceManagementUserNamePassword16 accessDeviceCredentials)

getAccessDeviceCredentials

public Optional<@Valid DeviceManagementUserNamePassword16> getAccessDeviceCredentials()

setIsWebexTeamsDevice

public SystemAccessDevice.SystemAccessDeviceModifyRequest setIsWebexTeamsDevice(Boolean isWebexTeamsDevice)

getIsWebexTeamsDevice

public Boolean getIsWebexTeamsDevice()

unsetDefaultPathHeader

public SystemAccessDevice.SystemAccessDeviceModifyRequest unsetDefaultPathHeader()

setDefaultPathHeader

public SystemAccessDevice.SystemAccessDeviceModifyRequest setDefaultPathHeader(String defaultPathHeader)

getDefaultPathHeader

public Optional<@Size(min=1,max=1024) String> getDefaultPathHeader()

formRequest

public void formRequest()

Forms the XML Document for this Request Object. Called by the Request upon fire().

Overrides:

formRequest in class Request<DefaultResponse>