com.vmware.vcenter.vcha

Class ConnectionSpec

java.lang.Object

com.vmware.vcenter.vcha.ConnectionSpec

All Implemented Interfaces:

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

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

The ConnectionSpec class contains information required to connect to a vCenter server. The connection to the vCenter server always uses the HTTPS protocol. 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	ConnectionSpec.Builder Builder class for ConnectionSpec.

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	ConnectionSpec() Default constructor.
protected	ConnectionSpec(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 ConnectionSpec	_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 ConnectionSpec	_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	getHostname() IP Address or DNS of the vCenter.
char[]	getPassword() Password for the specified user.
java.lang.Long	getPort() Port number.
java.lang.String	getSslThumbprint() SHA1 hash of the server SSL certificate.
java.lang.String	getUsername() Username to access the server.
int	hashCode()
void	setHostname(java.lang.String hostname) IP Address or DNS of the vCenter.
void	setPassword(char[] password) Password for the specified user.
void	setPort(java.lang.Long port) Port number.
void	setSslThumbprint(java.lang.String sslThumbprint) SHA1 hash of the server SSL certificate.
void	setUsername(java.lang.String username) Username to access the 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

ConnectionSpec

public ConnectionSpec()

Default constructor.

ConnectionSpec

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

Method Detail

getHostname

public java.lang.String getHostname()

IP Address or DNS of the vCenter. This property was added in vSphere API 6.7.1.

Returns:

The current value of the property.

setHostname

public void setHostname(java.lang.String hostname)

IP Address or DNS of the vCenter. This property was added in vSphere API 6.7.1.

Parameters:

hostname - New value for the property.

getPort

public java.lang.Long getPort()

Port number. This property was added in vSphere API 6.7.1. If null, port 443 will be used.

Returns:

The current value of the property.

setPort

public void setPort(java.lang.Long port)

Port number. This property was added in vSphere API 6.7.1. If null, port 443 will be used.

Parameters:

port - New value for the property.

getSslThumbprint

public java.lang.String getSslThumbprint()

SHA1 hash of the server SSL certificate. This property was added in vSphere API 6.7.1. If null, empty ssl thumbprint is assumed.

Returns:

The current value of the property.

setSslThumbprint

public void setSslThumbprint(java.lang.String sslThumbprint)

SHA1 hash of the server SSL certificate. This property was added in vSphere API 6.7.1. If null, empty ssl thumbprint is assumed.

Parameters:

sslThumbprint - New value for the property.

getUsername

public java.lang.String getUsername()

Username to access the server. This property was added in vSphere API 6.7.1. This property is currently required. If null, an error is returned. In the future, if this property is null, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail.

Returns:

The current value of the property.

setUsername

public void setUsername(java.lang.String username)

Username to access the server. This property was added in vSphere API 6.7.1. This property is currently required. If null, an error is returned. In the future, if this property is null, the system will attempt to identify the user. If a user cannot be identified, then the requested operation will fail.

Parameters:

username - New value for the property.

getPassword

public char[] getPassword()

Password for the specified user. This property was added in vSphere API 6.7.1. This property is currently required. If null, an empty password is assumed. In the future, if this property is null, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail.

Returns:

The current value of the property.

setPassword

public void setPassword(char[] password)

Password for the specified user. This property was added in vSphere API 6.7.1. This property is currently required. If null, an empty password is assumed. In the future, if this property is null, the system will attempt to authenticate the user. If a user cannot be identified, then the requested operation will fail.

Parameters:

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

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