SourceNsxApiEndpoint (Java SDK for NSX Manager API 4.1.0.2.0)

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

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class SourceNsxApiEndpoint
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
Details about an existing NSX manager to be migrated

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SourceNsxApiEndpoint.Builder
Builder class for SourceNsxApiEndpoint.

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

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

Fields
Modifier and Type	Field and Description
`protected com.vmware.vapi.data.StructValue`	`__dynamicStructureFields`

Constructor Summary

Constructors
Modifier	Constructor and Description
	`SourceNsxApiEndpoint()` Default constructor.
`protected`	`SourceNsxApiEndpoint(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 SourceNsxApiEndpoint`	`_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 SourceNsxApiEndpoint`	`_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`	`getAuthToken()` Auth token used to make REST calls to the source NSX API endpoint.
`java.lang.String`	`getIp()` IP address or hostname of a source NSX API endpoint.
`java.lang.String`	`getNsxPassword()` Password for connecting to NSX manager.
`java.lang.String`	`getNsxSyncrole()` Signifies Universal Sync role status (STANDALONE, PRIMARY, SECONDARY) of a source NSX API endpoint.
`java.lang.String`	`getNsxUsername()` Username for connecting to NSX manager.
`java.lang.String`	`getNsxVersion()` Build version (major, minor, patch) of a source NSX API endpoint.
`java.lang.String`	`getVcIp()` IP address or host name of VC.
`java.lang.String`	`getVcPassword()` Password for connecting to VC.
`java.lang.Long`	`getVcPort()` VC port that will be used to fetch details.
`java.lang.String`	`getVcUsername()` Username for connecting to VC.
`java.lang.String`	`getVcVersion()` Build version of VC.
`int`	`hashCode()`
`void`	`setAuthToken(java.lang.String authToken)` Auth token used to make REST calls to the source NSX API endpoint.
`void`	`setIp(java.lang.String ip)` IP address or hostname of a source NSX API endpoint.
`void`	`setNsxPassword(java.lang.String nsxPassword)` Password for connecting to NSX manager.
`void`	`setNsxSyncrole(java.lang.String nsxSyncrole)` Signifies Universal Sync role status (STANDALONE, PRIMARY, SECONDARY) of a source NSX API endpoint.
`void`	`setNsxUsername(java.lang.String nsxUsername)` Username for connecting to NSX manager.
`void`	`setNsxVersion(java.lang.String nsxVersion)` Build version (major, minor, patch) of a source NSX API endpoint.
`void`	`setVcIp(java.lang.String vcIp)` IP address or host name of VC.
`void`	`setVcPassword(java.lang.String vcPassword)` Password for connecting to VC.
`void`	`setVcPort(java.lang.Long vcPort)` VC port that will be used to fetch details.
`void`	`setVcUsername(java.lang.String vcUsername)` Username for connecting to VC.
`void`	`setVcVersion(java.lang.String vcVersion)` Build version of VC.
`java.lang.String`	`toString()`

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

- Field Detail
  - __dynamicStructureFields
```
protected com.vmware.vapi.data.StructValue __dynamicStructureFields
```
- Constructor Detail
  - SourceNsxApiEndpoint
```
public SourceNsxApiEndpoint()
```
    Default constructor.
  - SourceNsxApiEndpoint
```
protected SourceNsxApiEndpoint(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getAuthToken
```
public java.lang.String getAuthToken()
```
    Auth token used to make REST calls to the source NSX API endpoint. This field is not applicable in case of vSphere network migration. Please generate the token with a sufficiently large duration so that it does not expire in the middle of the migration. If it does expire, then the token needs to be refreshed manually by invoking this API again with a new token. Alternatively, you can provide the username/password of the source NSX.
    
    Returns:
    
    The current value of the property.
  - setAuthToken
```
public void setAuthToken(java.lang.String authToken)
```
    Auth token used to make REST calls to the source NSX API endpoint. This field is not applicable in case of vSphere network migration. Please generate the token with a sufficiently large duration so that it does not expire in the middle of the migration. If it does expire, then the token needs to be refreshed manually by invoking this API again with a new token. Alternatively, you can provide the username/password of the source NSX.
    
    Parameters:
    
    authToken - New value for the property.
  - getIp
```
public java.lang.String getIp()
```
    IP address or hostname of a source NSX API endpoint. This field is not applicable in case of vSphere network migration. format: hostname-or-ip
    
    Returns:
    
    The current value of the property.
  - setIp
```
public void setIp(java.lang.String ip)
```
    IP address or hostname of a source NSX API endpoint. This field is not applicable in case of vSphere network migration. format: hostname-or-ip
    
    Parameters:
    
    ip - New value for the property.
  - getNsxPassword
```
public java.lang.String getNsxPassword()
```
    Password for connecting to NSX manager. This field is not applicable in case of vSphere network migration.
    
    Returns:
    
    The current value of the property.
  - setNsxPassword
```
public void setNsxPassword(java.lang.String nsxPassword)
```
    Password for connecting to NSX manager. This field is not applicable in case of vSphere network migration.
    
    Parameters:
    
    nsxPassword - New value for the property.
  - getNsxSyncrole
```
public java.lang.String getNsxSyncrole()
```
    Signifies Universal Sync role status (STANDALONE, PRIMARY, SECONDARY) of a source NSX API endpoint. 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.
  - setNsxSyncrole
```
public void setNsxSyncrole(java.lang.String nsxSyncrole)
```
    Signifies Universal Sync role status (STANDALONE, PRIMARY, SECONDARY) of a source NSX API endpoint. 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:
    
    nsxSyncrole - New value for the property.
  - getNsxUsername
```
public java.lang.String getNsxUsername()
```
    Username for connecting to NSX manager. This field is not applicable in case of vSphere network migration.
    
    Returns:
    
    The current value of the property.
  - setNsxUsername
```
public void setNsxUsername(java.lang.String nsxUsername)
```
    Username for connecting to NSX manager. This field is not applicable in case of vSphere network migration.
    
    Parameters:
    
    nsxUsername - New value for the property.
  - getNsxVersion
```
public java.lang.String getNsxVersion()
```
    Build version (major, minor, patch) of a source NSX API endpoint. 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.
  - setNsxVersion
```
public void setNsxVersion(java.lang.String nsxVersion)
```
    Build version (major, minor, patch) of a source NSX API endpoint. 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:
    
    nsxVersion - New value for the property.
  - getVcIp
```
public java.lang.String getVcIp()
```
    IP address or host name of VC. format: hostname-or-ip
    
    Returns:
    
    The current value of the property.
  - setVcIp
```
public void setVcIp(java.lang.String vcIp)
```
    IP address or host name of VC. format: hostname-or-ip
    
    Parameters:
    
    vcIp - New value for the property.
  - getVcPassword
```
public java.lang.String getVcPassword()
```
    Password for connecting to VC.
    
    Returns:
    
    The current value of the property.
  - setVcPassword
```
public void setVcPassword(java.lang.String vcPassword)
```
    Password for connecting to VC.
    
    Parameters:
    
    vcPassword - New value for the property.
  - getVcPort
```
public java.lang.Long getVcPort()
```
    VC port that will be used to fetch details. format: int32
    
    Returns:
    
    The current value of the property.
  - setVcPort
```
public void setVcPort(java.lang.Long vcPort)
```
    VC port that will be used to fetch details. format: int32
    
    Parameters:
    
    vcPort - New value for the property.
  - getVcUsername
```
public java.lang.String getVcUsername()
```
    Username for connecting to VC.
    
    Returns:
    
    The current value of the property.
  - setVcUsername
```
public void setVcUsername(java.lang.String vcUsername)
```
    Username for connecting to VC.
    
    Parameters:
    
    vcUsername - New value for the property.
  - getVcVersion
```
public java.lang.String getVcVersion()
```
    Build version of VC. 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.
  - setVcVersion
```
public void setVcVersion(java.lang.String vcVersion)
```
    Build version of VC. 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:
    
    vcVersion - 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 SourceNsxApiEndpoint _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 SourceNsxApiEndpoint _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class SourceNsxApiEndpoint

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

SourceNsxApiEndpoint

SourceNsxApiEndpoint

Method Detail

getAuthToken

setAuthToken

getIp

setIp

getNsxPassword

setNsxPassword

getNsxSyncrole

setNsxSyncrole

getNsxUsername

setNsxUsername

getNsxVersion

setNsxVersion

getVcIp

setVcIp

getVcPassword

setVcPassword

getVcPort

setVcPort

getVcUsername

setVcUsername

getVcVersion

setVcVersion

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2