com.vmware.vcenter.vm.guest

Class Credentials.Builder

java.lang.Object

com.vmware.vcenter.vm.guest.Credentials.Builder

Enclosing class:

Credentials

public static final class Credentials.Builder
extends java.lang.Object

Builder class for Credentials.

Constructor Summary

Constructors

Constructor and Description
Builder(boolean interactiveSession, Credentials.Type type) Constructor with parameters for the required properties of Credentials.

Method Summary

Modifier and Type	Method and Description
Credentials	build()
Credentials.Builder	setPassword(char[] password) password.
Credentials.Builder	setSamlToken(char[] samlToken) SAML Bearer Token.
Credentials.Builder	setUserName(java.lang.String userName) For Credentials.Type.SAML_BEARER_TOKEN, this is the guest user to be associated with the credentials.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder(boolean interactiveSession,
               Credentials.Type type)

Constructor with parameters for the required properties of Credentials.

Method Detail

setUserName

public Credentials.Builder 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.

setPassword

public Credentials.Builder 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.

setSamlToken

public Credentials.Builder 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.

build

public Credentials build()