com.vmware.vcenter.namespace_management.supervisors

Class ControlPlane

java.lang.Object

com.vmware.vcenter.namespace_management.supervisors.ControlPlane

All Implemented Interfaces:

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

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

ControlPlane class describes the control plane configuration. It allows you to adjust configuration such as size, network, and storage required to support the control plane runtime.

. This class was added in vSphere API 8.0.0.1.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

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

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ControlPlane() Default constructor.
protected	ControlPlane(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 ControlPlane	_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 ControlPlane	_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	getLoginBanner() getLoginBanner() is a disclaimer displayed prior to login via the Kubectl plugin.
Network	getNetwork() The management getNetwork() is used by vCenter and the control plane to manage the cluster.
SizingHint	getSize() getSize() controls the size and resources allocated to the Kubernetes API server and the worker nodes.
java.lang.String	getStoragePolicy() getStoragePolicy() identifies the storage policy backing the Supervisor Kubernetes API server.
int	hashCode()
void	setLoginBanner(java.lang.String loginBanner) getLoginBanner() is a disclaimer displayed prior to login via the Kubectl plugin.
void	setNetwork(Network network) The management getNetwork() is used by vCenter and the control plane to manage the cluster.
void	setSize(SizingHint size) getSize() controls the size and resources allocated to the Kubernetes API server and the worker nodes.
void	setStoragePolicy(java.lang.String storagePolicy) getStoragePolicy() identifies the storage policy backing the Supervisor Kubernetes API server.
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

ControlPlane

public ControlPlane()

Default constructor.

ControlPlane

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

Method Detail

getNetwork

public Network getNetwork()

The management getNetwork() is used by vCenter and the control plane to manage the cluster. vCenter and the NSX (if used) management plane must be accessible from this network.

The Supervisor requires that management network traffic is not L3 routable from workload network traffic.

. This property was added in vSphere API 8.0.0.1.

Returns:

The current value of the property.

setNetwork

public void setNetwork(Network network)

The management getNetwork() is used by vCenter and the control plane to manage the cluster. vCenter and the NSX (if used) management plane must be accessible from this network.

The Supervisor requires that management network traffic is not L3 routable from workload network traffic.

. This property was added in vSphere API 8.0.0.1.

Parameters:

network - New value for the property.

getLoginBanner

public java.lang.String getLoginBanner()

getLoginBanner() is a disclaimer displayed prior to login via the Kubectl plugin.

. This property was added in vSphere API 8.0.0.1. If this banner is null, no message will be displayed to users.

Returns:

The current value of the property.

setLoginBanner

public void setLoginBanner(java.lang.String loginBanner)

getLoginBanner() is a disclaimer displayed prior to login via the Kubectl plugin.

. This property was added in vSphere API 8.0.0.1. If this banner is null, no message will be displayed to users.

Parameters:

loginBanner - New value for the property.

getSize

public SizingHint getSize()

getSize() controls the size and resources allocated to the Kubernetes API server and the worker nodes.

. This property was added in vSphere API 8.0.0.1. Defaults to SMALL.

Returns:

The current value of the property.

setSize

public void setSize(SizingHint size)

getSize() controls the size and resources allocated to the Kubernetes API server and the worker nodes.

. This property was added in vSphere API 8.0.0.1. Defaults to SMALL.

Parameters:

size - New value for the property.

getStoragePolicy

public java.lang.String getStoragePolicy()

getStoragePolicy() identifies the storage policy backing the Supervisor Kubernetes API server.

. This property was added in vSphere API 8.0.0.1. This resource is required.

Returns:

The current value of the property. When clients pass a value of this class as a parameter, the property must be an identifier for the resource type: SpsStorageProfile. When methods return a value of this class as a return value, the property will be an identifier for the resource type: SpsStorageProfile.

setStoragePolicy

public void setStoragePolicy(java.lang.String storagePolicy)

getStoragePolicy() identifies the storage policy backing the Supervisor Kubernetes API server.

. This property was added in vSphere API 8.0.0.1. This resource is required.

Parameters:

storagePolicy - 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: SpsStorageProfile. When methods return a value of this class as a return value, the property will be an identifier for the resource type: SpsStorageProfile.

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

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