public final class NSXConfig extends java.lang.Object implements java.io.Serializable, StaticStructure
NSXConfig
class describes the configuration for NSX-T Edge services.
This class was added in vSphere API 8.0.0.1.Modifier and Type | Class and Description |
---|---|
static class |
NSXConfig.Builder
Builder class for
NSXConfig . |
Modifier and Type | Field and Description |
---|---|
protected StructValue |
__dynamicStructureFields |
Modifier | Constructor and Description |
---|---|
|
NSXConfig()
Default constructor.
|
protected |
NSXConfig(StructValue __dynamicStructureFields) |
Modifier and Type | Method and Description |
---|---|
<T extends Structure> |
_convertTo(java.lang.Class<T> clazz)
Converts this structure into an instance of the provided class structure
if possible.
|
java.lang.String |
_getCanonicalName()
Returns the canonical name of the structure.
|
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.
|
StructValue |
_getDataValue()
Returns this
Structure represented in the dynamic
DataValue model. |
DataValue |
_getDynamicField(java.lang.String fieldName)
Get a dynamic field value, doesn't allow access to static fields (which
have getters/setters).
|
java.util.Set<java.lang.String> |
_getDynamicFieldNames()
Get the names of the dynamic fields in the structure.
|
com.vmware.vapi.bindings.type.StructType |
_getType()
WARNING: Internal method, subject to change in future versions.
|
boolean |
_hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Checks if the runtime type name of this structure matches the type
represented by the specified binding class.
|
static NSXConfig |
_newInstance(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 NSXConfig |
_newInstance2(StructValue structValue)
WARNING: Internal method, subject to change in future versions.
Serves as a versioning mechanism. |
void |
_setDynamicField(java.lang.String fieldName,
DataValue fieldValue)
Sets a dynamic field value.
|
protected void |
_updateDataValue(StructValue structValue) |
void |
_validate()
Validates the state of the discriminated unions and HasFieldsOf
restrictions (if any) in this Java language binding
Structure . |
boolean |
equals(java.lang.Object obj) |
java.lang.String |
getDefaultIngressTLSCertificate()
getDefaultIngressTLSCertificate()
defines a default certificate that is served on Ingress services, when another
certificate is not presented. |
java.lang.String |
getEdgeClusterID()
getEdgeClusterID()
defines the NSX Edge Cluster to be used for Kubernetes Services of type
LoadBalancer, Kubernetes Ingresses, and NSX SNAT. |
java.util.List<IPRange> |
getEgressIPRanges()
getEgressIPRanges()
lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT
from container IPs to external IPs. |
LoadBalancerSize |
getLoadBalancerSize()
getLoadBalancerSize()
describes the load balancer sizing options available. |
NSXRoutingMode |
getRoutingMode()
getRoutingMode()
enables the network topology in either NAT mode or Routed Mode. |
java.lang.String |
getT0Gateway()
getT0Gateway()
specifies the default Tier-0 gateway ID for the namespaces configuration. |
int |
hashCode() |
void |
setDefaultIngressTLSCertificate(java.lang.String defaultIngressTLSCertificate)
getDefaultIngressTLSCertificate()
defines a default certificate that is served on Ingress services, when another
certificate is not presented. |
void |
setEdgeClusterID(java.lang.String edgeClusterID)
getEdgeClusterID()
defines the NSX Edge Cluster to be used for Kubernetes Services of type
LoadBalancer, Kubernetes Ingresses, and NSX SNAT. |
void |
setEgressIPRanges(java.util.List<IPRange> egressIPRanges)
getEgressIPRanges()
lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT
from container IPs to external IPs. |
void |
setLoadBalancerSize(LoadBalancerSize loadBalancerSize)
getLoadBalancerSize()
describes the load balancer sizing options available. |
void |
setRoutingMode(NSXRoutingMode routingMode)
getRoutingMode()
enables the network topology in either NAT mode or Routed Mode. |
void |
setT0Gateway(java.lang.String t0Gateway)
getT0Gateway()
specifies the default Tier-0 gateway ID for the namespaces configuration. |
java.lang.String |
toString()
Returns a string representation of this structure.
|
protected StructValue __dynamicStructureFields
public NSXConfig()
protected NSXConfig(StructValue __dynamicStructureFields)
public java.lang.String getEdgeClusterID()
getEdgeClusterID()
defines the NSX Edge Cluster to be used for Kubernetes Services of type
LoadBalancer, Kubernetes Ingresses, and NSX SNAT. This property was added in
vSphere API 8.0.0.1.
Defaults to a the edge cluster created earliest.public void setEdgeClusterID(java.lang.String edgeClusterID)
getEdgeClusterID()
defines the NSX Edge Cluster to be used for Kubernetes Services of type
LoadBalancer, Kubernetes Ingresses, and NSX SNAT. This property was added in
vSphere API 8.0.0.1.
Defaults to a the edge cluster created earliest.edgeClusterID
- New value for the property.public java.lang.String getDefaultIngressTLSCertificate()
getDefaultIngressTLSCertificate()
defines a default certificate that is served on Ingress services, when another
certificate is not presented. This configuration applies to all namespaces by
default. This property was added in vSphere API 8.0.0.1.
If unset, there will be no certificate served on Ingress.public void setDefaultIngressTLSCertificate(java.lang.String defaultIngressTLSCertificate)
getDefaultIngressTLSCertificate()
defines a default certificate that is served on Ingress services, when another
certificate is not presented. This configuration applies to all namespaces by
default. This property was added in vSphere API 8.0.0.1.
If unset, there will be no certificate served on Ingress.defaultIngressTLSCertificate
- New value for the property.public NSXRoutingMode getRoutingMode()
getRoutingMode()
enables the network topology in either NAT mode or Routed Mode. Enabling routed
mode will result in all the workloads i.e vSphere PODs, VMs and Tanzu clusters
Node IPs to be directly accessible from networks beyond the Tier-0 router. Once
a namespace mode is applied, it cannot be changed. This property was added in
vSphere API 8.0.0.1.
The default setting is NAT mode.public void setRoutingMode(NSXRoutingMode routingMode)
getRoutingMode()
enables the network topology in either NAT mode or Routed Mode. Enabling routed
mode will result in all the workloads i.e vSphere PODs, VMs and Tanzu clusters
Node IPs to be directly accessible from networks beyond the Tier-0 router. Once
a namespace mode is applied, it cannot be changed. This property was added in
vSphere API 8.0.0.1.
The default setting is NAT mode.routingMode
- New value for the property.public java.util.List<IPRange> getEgressIPRanges()
getEgressIPRanges()
lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT
from container IPs to external IPs. These ranges must not overlap with other IP
ranges on this network. This property was added in vSphere API 8.0.0.1.
If this range is empty, network traffic will not be able to exit the cluster.public void setEgressIPRanges(java.util.List<IPRange> egressIPRanges)
getEgressIPRanges()
lists the IP Ranges from which NSX assigns IP addresses used for performing SNAT
from container IPs to external IPs. These ranges must not overlap with other IP
ranges on this network. This property was added in vSphere API 8.0.0.1.
If this range is empty, network traffic will not be able to exit the cluster.egressIPRanges
- New value for the property.public java.lang.String getT0Gateway()
getT0Gateway()
specifies the default Tier-0 gateway ID for the namespaces configuration. This
property was added in vSphere API 8.0.0.1.
If unset, the default Tier-0 gateway from the edge cluster is used.NSXTier0Gateway
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: NSXTier0Gateway
.public void setT0Gateway(java.lang.String t0Gateway)
getT0Gateway()
specifies the default Tier-0 gateway ID for the namespaces configuration. This
property was added in vSphere API 8.0.0.1.
If unset, the default Tier-0 gateway from the edge cluster is used.t0Gateway
- New value for the property.
When clients pass a value of this class as a parameter, the property must be an
identifier for the resource type: NSXTier0Gateway
. When methods return a
value of this class as a return value, the property will be an identifier for
the resource type: NSXTier0Gateway
.public LoadBalancerSize getLoadBalancerSize()
getLoadBalancerSize()
describes the load balancer sizing options available. Larger sizes support more
active virtual servers, but consume more resources. This property was added in
vSphere API 8.0.0.1.
If unset, the size defaults to small.public void setLoadBalancerSize(LoadBalancerSize loadBalancerSize)
getLoadBalancerSize()
describes the load balancer sizing options available. Larger sizes support more
active virtual servers, but consume more resources. This property was added in
vSphere API 8.0.0.1.
If unset, the size defaults to small.loadBalancerSize
- New value for the property.public com.vmware.vapi.bindings.type.StructType _getType()
StaticStructure
StructType
instance representing the static bindings
type for this Structure
._getType
in interface StaticStructure
StructType
public StructValue _getDataValue()
Structure
Structure
represented in the dynamic
DataValue
model.
Attempts to change the returned StructValue
representation are not required to change the state of this structure.
Actually the behavior is implementation dependent and is unspecified.
In general the returned value shouldn't be changed.
_getDataValue
in interface Structure
StructValue
representing this structureprotected void _updateDataValue(StructValue structValue)
public void _validate()
StaticStructure
Structure
.
More precisely, for each union: given value of the discriminant/tag
field (@UnionTag
in the IDL) of an union in this structure,
validates that:
_validate
in interface StaticStructure
public boolean equals(java.lang.Object obj)
equals
in class java.lang.Object
public int hashCode()
hashCode
in class java.lang.Object
public java.lang.String toString()
StaticStructure
In general no code should depend on the format of the resulting string. E.g. there must be no attempts to parse for re-creation of the original instance.
toString
in interface StaticStructure
toString
in class java.lang.Object
public boolean _hasTypeNameOf(java.lang.Class<? extends Structure> clazz)
Structure
This can be used as efficient check to determine if this instance
can be successfully converted
to the target
type.
_hasTypeNameOf
in interface Structure
clazz
- bindings class for the target structure; must not be null
public <T extends Structure> T _convertTo(java.lang.Class<T> clazz)
Structure
_convertTo
in interface Structure
clazz
- type of the result structure. cannot be null.CoreException
is thrown otherwise.public void _setDynamicField(java.lang.String fieldName, DataValue fieldValue)
StaticStructure
_setDynamicField
in interface StaticStructure
fieldName
- canonical name of the dynamic field to setfieldValue
- the value of the fieldpublic DataValue _getDynamicField(java.lang.String fieldName)
StaticStructure
_getDynamicField
in interface StaticStructure
fieldName
- the canonical name of the dynamic fieldDataValue
of the dynamic fieldpublic java.util.Set<java.lang.String> _getDynamicFieldNames()
StaticStructure
_getDynamicFieldNames
in interface StaticStructure
public static com.vmware.vapi.bindings.type.StructType _getClassType()
StructType
instance representing the static bindings
type for this Structure
.public java.lang.String _getCanonicalName()
Structure
org.example.FooBar
would turn into
org.example.foo_bar
._getCanonicalName
in interface Structure
public static java.lang.String _getCanonicalTypeName()
_getCanonicalName()
.public static NSXConfig _newInstance(StructValue structValue)
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.StructType
public static NSXConfig _newInstance2(StructValue structValue)