Credentials

java.lang.Object
- com.vmware.vcenter.vm.guest.Credentials

All Implemented Interfaces:

com.vmware.vapi.bindings.StaticStructure, com.vmware.vapi.bindings.Structure, java.io.Serializable
```
public final class Credentials
extends java.lang.Object
implements java.io.Serializable, com.vmware.vapi.bindings.StaticStructure
```
The Credentials class defines the guest credentials used for guest operation authentication. This class was added in vSphere API 7.0.2.0.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class Credentials.Builder
Builder class for Credentials.

static class Credentials.Type
Types of guest credentials.

Nested Classes
Modifier and Type	Class and Description
`static class`	`Credentials.Builder` Builder class for `Credentials`.
`static class`	`Credentials.Type` Types of guest credentials.

Field Summary

Fields
Modifier and Type Field and Description

protected com.vmware.vapi.data.StructValue __dynamicStructureFields

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

Constructor Summary

Constructors
Modifier Constructor and Description

Credentials()
Default constructor.

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

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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
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 Credentials`	`_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 Credentials`	`_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)`
`boolean`	`getInteractiveSession()` If `Set`, the method will interact with the logged-in desktop session in the guest.
`char[]`	`getPassword()` password.
`char[]`	`getSamlToken()` SAML Bearer Token.
`Credentials.Type`	`getType()` The guest credentials type.
`java.lang.String`	`getUserName()` For `Credentials.Type.SAML_BEARER_TOKEN`, this is the guest user to be associated with the credentials.
`int`	`hashCode()`
`void`	`setInteractiveSession(boolean interactiveSession)` If `Set`, the method will interact with the logged-in desktop session in the guest.
`void`	`setPassword(char[] password)` password.
`void`	`setSamlToken(char[] samlToken)` SAML Bearer Token.
`void`	`setType(Credentials.Type type)` The guest credentials type.
`void`	`setUserName(java.lang.String userName)` For `Credentials.Type.SAML_BEARER_TOKEN`, this is the guest user to be associated with the credentials.
`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
  - Credentials
```
public Credentials()
```
    Default constructor.
  - Credentials
```
protected Credentials(com.vmware.vapi.data.StructValue __dynamicStructureFields)
```
- Method Detail
  - getInteractiveSession
```
public boolean getInteractiveSession()
```
    If Set, the method will interact with the logged-in desktop session in the guest. This requires that the logged-on user matches the user specified by the Credentials. This is currently only supported for Credentials.Type.USERNAME_PASSWORD. This property was added in vSphere API 7.0.2.0.
    
    Returns:
    
    The current value of the property.
  - setInteractiveSession
```
public void setInteractiveSession(boolean interactiveSession)
```
    If Set, the method will interact with the logged-in desktop session in the guest. This requires that the logged-on user matches the user specified by the Credentials. This is currently only supported for Credentials.Type.USERNAME_PASSWORD. This property was added in vSphere API 7.0.2.0.
    
    Parameters:
    
    interactiveSession - New value for the property.
  - getType
```
public Credentials.Type getType()
```
    The guest credentials type. This property was added in vSphere API 7.0.2.0.
    
    Returns:
    
    The current value of the property.
  - setType
```
public void setType(Credentials.Type type)
```
    The guest credentials type. This property was added in vSphere API 7.0.2.0.
    
    Parameters:
    
    type - New value for the property.
  - getUserName
```
public java.lang.String getUserName()
```
    For Credentials.Type.SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials. For Credentials.Type.USERNAME_PASSWORD this is the guest username. This property was added in vSphere API 7.0.2.0. If no user is specified for Credentials.Type.SAML_BEARER_TOKEN, a guest dependent mapping will decide what guest user account is applied.
    
    Returns:
    
    The current value of the property.
  - setUserName
```
public void setUserName(java.lang.String userName)
```
    For Credentials.Type.SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials. For Credentials.Type.USERNAME_PASSWORD this is the guest username. This property was added in vSphere API 7.0.2.0. If no user is specified for Credentials.Type.SAML_BEARER_TOKEN, a guest dependent mapping will decide what guest user account is applied.
    
    Parameters:
    
    userName - New value for the property.
  - getPassword
```
public char[] getPassword()
```
    password. This property was added in vSphere API 7.0.2.0. This property is optional and it is only relevant when the value of getType() is Credentials.Type.USERNAME_PASSWORD.
    
    Returns:
    
    The current value of the property.
  - setPassword
```
public void setPassword(char[] password)
```
    password. This property was added in vSphere API 7.0.2.0. This property is optional and it is only relevant when the value of getType() is Credentials.Type.USERNAME_PASSWORD.
    
    Parameters:
    
    password - New value for the property.
  - getSamlToken
```
public char[] getSamlToken()
```
    SAML Bearer Token. This property was added in vSphere API 7.0.2.0. This property is optional and it is only relevant when the value of getType() is Credentials.Type.SAML_BEARER_TOKEN.
    
    Returns:
    
    The current value of the property.
  - setSamlToken
```
public void setSamlToken(char[] samlToken)
```
    SAML Bearer Token. This property was added in vSphere API 7.0.2.0. This property is optional and it is only relevant when the value of getType() is Credentials.Type.SAML_BEARER_TOKEN.
    
    Parameters:
    
    samlToken - 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 Credentials _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 Credentials _newInstance2(com.vmware.vapi.data.StructValue structValue)
```
    WARNING: Internal method, subject to change in future versions.
    Serves as a versioning mechanism.

Class Credentials

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

__dynamicStructureFields

Constructor Detail

Credentials

Credentials

Method Detail

getInteractiveSession

setInteractiveSession

getType

setType

getUserName

setUserName

getPassword

setPassword

getSamlToken

setSamlToken

_getType

_getDataValue

_updateDataValue

_validate

equals

hashCode

toString

_hasTypeNameOf

_convertTo

_setDynamicField

_getDynamicField

_getDynamicFieldNames

_getClassType

_getCanonicalName

_getCanonicalTypeName

_newInstance

_newInstance2