VirtualSwitch (Java SDK for NSX Manager API 4.1.2.0.0)

java.lang.Object
- com.vmware.nsx.model.VirtualSwitch

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class VirtualSwitch
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Virtual switch on a compute manager

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class VirtualSwitch.Builder
Builder class for VirtualSwitch.

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`
`static java.lang.String`	`OWNER_NSX_MULTIPLE`
`static java.lang.String`	`OWNER_NSX_NONE`
`static java.lang.String`	`OWNER_NSX_OTHER`
`static java.lang.String`	`OWNER_NSX_SELF`

Constructor Summary

Constructors
Modifier Constructor and Description

VirtualSwitch()
Default constructor.

protected VirtualSwitch(com.vmware.vapi.data.StructValue __dynamicStructureFields)

Constructors
Modifier	Constructor and Description
	`VirtualSwitch()` Default constructor.
`protected`	`VirtualSwitch(com.vmware.vapi.data.StructValue __dynamicStructureFields)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`<T extends com.vmware.vapi.bindings.Structure> T`	`_convertTo(java.lang.Class<T> clazz)`
`java.lang.String`	`_getCanonicalName()`
`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.
`com.vmware.vapi.data.StructValue`	`_getDataValue()`
`com.vmware.vapi.data.DataValue`	`_getDynamicField(java.lang.String fieldName)`
`java.util.Set<java.lang.String>`	`_getDynamicFieldNames()`
`com.vmware.vapi.bindings.type.StructType`	`_getType()`
`boolean`	`_hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)`
`static VirtualSwitch`	`_newInstance(com.vmware.vapi.data.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 VirtualSwitch`	`_newInstance2(com.vmware.vapi.data.StructValue structValue)` WARNING: Internal method, subject to change in future versions. Serves as a versioning mechanism.
`void`	`_setDynamicField(java.lang.String fieldName, com.vmware.vapi.data.DataValue fieldValue)`
`protected void`	`_updateDataValue(com.vmware.vapi.data.StructValue structValue)`
`void`	`_validate()`
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getCmLocalId()` ID of the virtual switch in compute manager This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getDescription()` Description of this resource
`java.lang.String`	`getDisplayName()` Defaults to ID if not set
`java.lang.String`	`getExternalId()` External id of the virtual switch This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.Long`	`getLastSyncTime()` Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.util.List<ResourceLink>`	`getLinks()` The server will populate this field when returing the resource.
`java.lang.String`	`getOriginId()` ID of the compute manager where this virtual switch is discovered.
`java.lang.String`	`getOriginType()` Switch type like VmwareDistributedVirtualSwitch This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.lang.String`	`getOwnerNsx()` Possible values are: `OWNER_NSX_SELF` `OWNER_NSX_OTHER` `OWNER_NSX_MULTIPLE` `OWNER_NSX_NONE` Specifies owner nsx of the virtual switch.
`java.lang.String`	`getResourceType()` The type of this resource.
`java.lang.String`	`getSchema()` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`java.util.List<DiscoveredResourceScope>`	`getScope()` Specifies list of scope of discovered resource.
`SelfResourceLink`	`getSelf()`
`java.util.List<Tag>`	`getTags()` Opaque identifiers meaningful to the API user
`int`	`hashCode()`
`void`	`setCmLocalId(java.lang.String cmLocalId)` ID of the virtual switch in compute manager This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setDescription(java.lang.String description)` Description of this resource
`void`	`setDisplayName(java.lang.String displayName)` Defaults to ID if not set
`void`	`setExternalId(java.lang.String externalId)` External id of the virtual switch This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setLastSyncTime(java.lang.Long lastSyncTime)` Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setLinks(java.util.List<ResourceLink> links)` The server will populate this field when returing the resource.
`void`	`setOriginId(java.lang.String originId)` ID of the compute manager where this virtual switch is discovered.
`void`	`setOriginType(java.lang.String originType)` Switch type like VmwareDistributedVirtualSwitch This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setOwnerNsx(java.lang.String ownerNsx)` Possible values are: `OWNER_NSX_SELF` `OWNER_NSX_OTHER` `OWNER_NSX_MULTIPLE` `OWNER_NSX_NONE` Specifies owner nsx of the virtual switch.
`void`	`setResourceType(java.lang.String resourceType)` The type of this resource.
`void`	`setSchema(java.lang.String schema)` Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
`void`	`setScope(java.util.List<DiscoveredResourceScope> scope)` Specifies list of scope of discovered resource.
`void`	`setSelf(SelfResourceLink self)`
`void`	`setTags(java.util.List<Tag> tags)` Opaque identifiers meaningful to the API user
`java.lang.String`	`toString()`

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

- Field Detail
  - OWNER_NSX_SELF
```
public static final java.lang.String OWNER_NSX_SELF
```
    See Also:
    
    Constant Field Values
  - OWNER_NSX_OTHER
```
public static final java.lang.String OWNER_NSX_OTHER
```
    See Also:
    
    Constant Field Values
  - OWNER_NSX_MULTIPLE
```
public static final java.lang.String OWNER_NSX_MULTIPLE
```
    See Also:
    
    Constant Field Values
  - OWNER_NSX_NONE
```
public static final java.lang.String OWNER_NSX_NONE
```
    See Also:
    
    Constant Field Values
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - VirtualSwitch
```
public VirtualSwitch()
```
    Default constructor.
  - VirtualSwitch
```
protected VirtualSwitch(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getLinks
```
public java.util.List<ResourceLink> getLinks()
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLinks
```
public void setLinks(java.util.List<ResourceLink> links)
```
    The server will populate this field when returing the resource. Ignored on PUT and POST. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    links - New value for the property.
  - getSchema
```
public java.lang.String getSchema()
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setSchema
```
public void setSchema(java.lang.String schema)
```
    Schema for this resource This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    schema - New value for the property.
  - getSelf
```
public SelfResourceLink getSelf()
```
    Returns:
    
    The current value of the property.
  - setSelf
```
public void setSelf(SelfResourceLink self)
```
    Parameters:
    
    self - New value for the property.
  - getLastSyncTime
```
public java.lang.Long getLastSyncTime()
```
    Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setLastSyncTime
```
public void setLastSyncTime(java.lang.Long lastSyncTime)
```
    Timestamp of last modification format: int64 This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    lastSyncTime - New value for the property.
  - getDescription
```
public java.lang.String getDescription()
```
    Description of this resource
    
    Returns:
    
    The current value of the property.
  - setDescription
```
public void setDescription(java.lang.String description)
```
    Description of this resource
    
    Parameters:
    
    description - New value for the property.
  - getDisplayName
```
public java.lang.String getDisplayName()
```
    Defaults to ID if not set
    
    Returns:
    
    The current value of the property.
  - setDisplayName
```
public void setDisplayName(java.lang.String displayName)
```
    Defaults to ID if not set
    
    Parameters:
    
    displayName - New value for the property.
  - getResourceType
```
public java.lang.String getResourceType()
```
    The type of this resource.
    
    Returns:
    
    The current value of the property.
  - setResourceType
```
public void setResourceType(java.lang.String resourceType)
```
    The type of this resource.
    
    Parameters:
    
    resourceType - New value for the property.
  - getScope
```
public java.util.List<DiscoveredResourceScope> getScope()
```
    Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.
    
    Returns:
    
    The current value of the property.
  - setScope
```
public void setScope(java.util.List<DiscoveredResourceScope> scope)
```
    Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.
    
    Parameters:
    
    scope - New value for the property.
  - getTags
```
public java.util.List<Tag> getTags()
```
    Opaque identifiers meaningful to the API user
    
    Returns:
    
    The current value of the property.
  - setTags
```
public void setTags(java.util.List<Tag> tags)
```
    Opaque identifiers meaningful to the API user
    
    Parameters:
    
    tags - New value for the property.
  - getCmLocalId
```
public java.lang.String getCmLocalId()
```
    ID of the virtual switch in compute manager This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setCmLocalId
```
public void setCmLocalId(java.lang.String cmLocalId)
```
    ID of the virtual switch in compute manager This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    cmLocalId - New value for the property.
  - getExternalId
```
public java.lang.String getExternalId()
```
    External id of the virtual switch This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setExternalId
```
public void setExternalId(java.lang.String externalId)
```
    External id of the virtual switch This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    externalId - New value for the property.
  - getOriginId
```
public java.lang.String getOriginId()
```
    ID of the compute manager where this virtual switch is discovered. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setOriginId
```
public void setOriginId(java.lang.String originId)
```
    ID of the compute manager where this virtual switch is discovered. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    originId - New value for the property.
  - getOriginType
```
public java.lang.String getOriginType()
```
    Switch type like VmwareDistributedVirtualSwitch This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Returns:
    
    The current value of the property.
  - setOriginType
```
public void setOriginType(java.lang.String originType)
```
    Switch type like VmwareDistributedVirtualSwitch This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    
    Parameters:
    
    originType - New value for the property.
  - getOwnerNsx
```
public java.lang.String getOwnerNsx()
```
    Possible values are:
    Specifies owner nsx of the virtual switch. Owner nsx can be SELF, OTHER, MULTIPLE or NONE. SELF applies to when virtual switch owned by that nsx. OTHER applies to whenf virtual switch owned by other nsx. MULTIPLE applies to when virtual switch tried to own by multiple nsx at a time. NONE applies to when virtual switch is not owned by any nsx. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Returns:
    
    The current value of the property.
  - setOwnerNsx
```
public void setOwnerNsx(java.lang.String ownerNsx)
```
    Possible values are:
    Specifies owner nsx of the virtual switch. Owner nsx can be SELF, OTHER, MULTIPLE or NONE. SELF applies to when virtual switch owned by that nsx. OTHER applies to whenf virtual switch owned by other nsx. MULTIPLE applies to when virtual switch tried to own by multiple nsx at a time. NONE applies to when virtual switch is not owned by any nsx. This property may be present in responses from the server, but if it is present in a request to server it will be ignored.
    Parameters:
    
    ownerNsx - New value for the property.
  - _getType
```
public com.vmware.vapi.bindings.type.StructType _getType()
```
    Specified by:
    
    _getType in interface com.vmware.vapi.bindings.StaticStructure
  - _getDataValue
```
public com.vmware.vapi.data.StructValue _getDataValue()
```
    Specified by:
    
    _getDataValue in interface com.vmware.vapi.bindings.Structure
  - _updateDataValue
```
protected void _updateDataValue(com.vmware.vapi.data.StructValue structValue)
```
  - _validate
```
public void _validate()
```
    Specified by:
    
    _validate in interface com.vmware.vapi.bindings.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()
```
    Specified by:
    
    toString in interface com.vmware.vapi.bindings.StaticStructure
    
    Overrides:
    
    toString in class java.lang.Object
  - _hasTypeNameOf
```
public boolean _hasTypeNameOf(java.lang.Class<? extends com.vmware.vapi.bindings.Structure> clazz)
```
    Specified by:
    
    _hasTypeNameOf in interface com.vmware.vapi.bindings.Structure
  - _convertTo
```
public <T extends com.vmware.vapi.bindings.Structure> T _convertTo(java.lang.Class<T> clazz)
```
    Specified by:
    
    _convertTo in interface com.vmware.vapi.bindings.Structure
  - _setDynamicField
```
public void _setDynamicField(java.lang.String fieldName,
                             com.vmware.vapi.data.DataValue fieldValue)
```
    Specified by:
    
    _setDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicField
```
public com.vmware.vapi.data.DataValue _getDynamicField(java.lang.String fieldName)
```
    Specified by:
    
    _getDynamicField in interface com.vmware.vapi.bindings.StaticStructure
  - _getDynamicFieldNames
```
public java.util.Set<java.lang.String> _getDynamicFieldNames()
```
    Specified by:
    
    _getDynamicFieldNames in interface com.vmware.vapi.bindings.StaticStructure
  - _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()
```
    Specified by:
    
    _getCanonicalName in interface com.vmware.vapi.bindings.Structure
  - _getCanonicalTypeName
```
public static java.lang.String _getCanonicalTypeName()
```
    Returns the canonical type name. See _getCanonicalName().
    
    Returns:
    
    canonical type name
  - _newInstance
```
public static VirtualSwitch _newInstance(com.vmware.vapi.data.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 VirtualSwitch _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class VirtualSwitch

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

OWNER_NSX_SELF

OWNER_NSX_OTHER

OWNER_NSX_MULTIPLE

OWNER_NSX_NONE

__dynamicStructureFields

Constructor Detail

VirtualSwitch

VirtualSwitch

Method Detail

getLinks

setLinks

getSchema

setSchema

getSelf

setSelf

getLastSyncTime

setLastSyncTime

getDescription

setDescription

getDisplayName

setDisplayName

getResourceType

setResourceType

getScope

setScope

getTags

setTags

getCmLocalId

setCmLocalId

getExternalId

setExternalId

getOriginId

setOriginId

getOriginType

setOriginType

getOwnerNsx

setOwnerNsx

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2