com.vmware.vcenter.vcha

Class IpSpec

java.lang.Object

com.vmware.vcenter.vcha.IpSpec

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable

public final class IpSpec
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure

The IpSpec class contains IP information used to configure a network interface. This class was added in vSphere API 6.7.1.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	IpSpec.Builder Builder class for IpSpec.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

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 IpSpec	_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 IpSpec	_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	getDefaultGateway() The IP address of the Gateway for this interface.
java.util.List<java.lang.String>	getDnsServers() The list of IP addresses of the DNS servers for this interface.
IpFamily	getIpFamily() Family of the IP address to configure the interface.
Ipv4Spec	getIpv4() If the family of the ip is IPV4, then this will point to IPv4 address specification.
Ipv6Spec	getIpv6() If the family of the ip is IPV6, then this will point to IPv6 address specification.
int	hashCode()
void	setDefaultGateway(java.lang.String defaultGateway) The IP address of the Gateway for this interface.
void	setDnsServers(java.util.List<java.lang.String> dnsServers) The list of IP addresses of the DNS servers for this interface.
void	setIpFamily(IpFamily ipFamily) Family of the IP address to configure the interface.
void	setIpv4(Ipv4Spec ipv4) If the family of the ip is IPV4, then this will point to IPv4 address specification.
void	setIpv6(Ipv6Spec ipv6) If the family of the ip is IPV6, then this will point to IPv6 address specification.
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

IpSpec

public IpSpec()

Default constructor.

IpSpec

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

Method Detail

getIpFamily

public IpFamily getIpFamily()

Family of the IP address to configure the interface. This property was added in vSphere API 6.7.1.

Returns:

The current value of the property.

setIpFamily

public void setIpFamily(IpFamily ipFamily)

Family of the IP address to configure the interface. This property was added in vSphere API 6.7.1.

Parameters:

ipFamily - New value for the property.

getIpv4

public Ipv4Spec getIpv4()

If the family of the ip is IPV4, then this will point to IPv4 address specification. This property was added in vSphere API 6.7.1. This property is optional and it is only relevant when the value of getIpFamily() is com.vmware.vcenter.vcha.IpFamily#IP_V4.

Returns:

The current value of the property.

setIpv4

public void setIpv4(Ipv4Spec ipv4)

If the family of the ip is IPV4, then this will point to IPv4 address specification. This property was added in vSphere API 6.7.1. This property is optional and it is only relevant when the value of getIpFamily() is com.vmware.vcenter.vcha.IpFamily#IP_V4.

Parameters:

ipv4 - New value for the property.

getIpv6

public Ipv6Spec getIpv6()

If the family of the ip is IPV6, then this will point to IPv6 address specification. This property was added in vSphere API 6.7.1. This property is optional and it is only relevant when the value of getIpFamily() is com.vmware.vcenter.vcha.IpFamily#IP_V6.

Returns:

The current value of the property.

setIpv6

public void setIpv6(Ipv6Spec ipv6)

If the family of the ip is IPV6, then this will point to IPv6 address specification. This property was added in vSphere API 6.7.1. This property is optional and it is only relevant when the value of getIpFamily() is com.vmware.vcenter.vcha.IpFamily#IP_V6.

Parameters:

ipv6 - New value for the property.

getDefaultGateway

public java.lang.String getDefaultGateway()

The IP address of the Gateway for this interface. This property was added in vSphere API 6.7.1. If null, gateway will not be used for the network interface.

Returns:

The current value of the property.

setDefaultGateway

public void setDefaultGateway(java.lang.String defaultGateway)

The IP address of the Gateway for this interface. This property was added in vSphere API 6.7.1. If null, gateway will not be used for the network interface.

Parameters:

defaultGateway - New value for the property.

getDnsServers

public java.util.List<java.lang.String> getDnsServers()

The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This property was added in vSphere API 6.7.1. If null, DNS servers will not be used for the network interface.

Returns:

The current value of the property.

setDnsServers

public void setDnsServers(java.util.List<java.lang.String> dnsServers)

The list of IP addresses of the DNS servers for this interface. This list is a comma separated list. This property was added in vSphere API 6.7.1. If null, DNS servers will not be used for the network interface.

Parameters:

dnsServers - 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 IpSpec _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 IpSpec _newInstance2(com.vmware.vapi.data.StructValue structValue)

WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism.