com.vmware.vcenter.guest

Class Ipv4

java.lang.Object

com.vmware.vcenter.guest.Ipv4

All Implemented Interfaces:

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

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

The Ipv4 class specifies the IPv4 settings that need to be applied to a virtual network adapter. This class was added in vSphere API 7.0.0.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Ipv4.Builder Builder class for Ipv4.
static class	Ipv4.Type The Type enumeration class specifies different types of the IPv4 configuration.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	Ipv4() Default constructor.
protected	Ipv4(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 Ipv4	_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 Ipv4	_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.util.List<java.lang.String>	getGateways() Gateways for the IPv4 address.
java.lang.String	getIpAddress() The static IPv4 address.
java.lang.Long	getPrefix() The IPv4 CIDR prefix, for example, 24.
Ipv4.Type	getType() The type of the IPv4 configuration.
int	hashCode()
void	setGateways(java.util.List<java.lang.String> gateways) Gateways for the IPv4 address.
void	setIpAddress(java.lang.String ipAddress) The static IPv4 address.
void	setPrefix(java.lang.Long prefix) The IPv4 CIDR prefix, for example, 24.
void	setType(Ipv4.Type type) The type of the IPv4 configuration.
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

Ipv4

public Ipv4()

Default constructor.

Ipv4

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

Method Detail

getType

public Ipv4.Type getType()

The type of the IPv4 configuration. This property was added in vSphere API 7.0.0.0.

Returns:

The current value of the property.

setType

public void setType(Ipv4.Type type)

The type of the IPv4 configuration. This property was added in vSphere API 7.0.0.0.

Parameters:

type - New value for the property.

getIpAddress

public java.lang.String getIpAddress()

The static IPv4 address. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Ipv4.Type.STATIC.

Returns:

The current value of the property.

setIpAddress

public void setIpAddress(java.lang.String ipAddress)

The static IPv4 address. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Ipv4.Type.STATIC.

Parameters:

ipAddress - New value for the property.

getPrefix

public java.lang.Long getPrefix()

The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Ipv4.Type.STATIC.

Returns:

The current value of the property.

setPrefix

public void setPrefix(java.lang.Long prefix)

The IPv4 CIDR prefix, for example, 24. See http://www.oav.net/mirrors/cidr.html for netmask-to-prefix conversion. This property was added in vSphere API 7.0.0.0. This property is optional and it is only relevant when the value of getType() is Ipv4.Type.STATIC.

Parameters:

prefix - New value for the property.

getGateways

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

Gateways for the IPv4 address. This property was added in vSphere API 7.0.0.0. If null, no gateways are set.

Returns:

The current value of the property.

setGateways

public void setGateways(java.util.List<java.lang.String> gateways)

Gateways for the IPv4 address. This property was added in vSphere API 7.0.0.0. If null, no gateways are set.

Parameters:

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

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