Configuration that allows the execution of jobs on a specific GAMS Engine instance. More...

Public Member Functions
	GAMSEngineConfiguration (String host, String username, String password)
	GAMSEngineConfiguration Constructor.

	GAMSEngineConfiguration (String host, String username, String password, String jwt, String namespace)
	GAMSEngineConfiguration Constructor.

String	host ()
	Gets base url.

void	setHost (String host)
	Sets base host url.

String	authHeader ()

String	jwt ()
	Gets JWT token to use for Bearer authentication.

void	setJwt (String jwt)
	Sets JWT token to use for Bearer authentication.

String	username ()
	Gets username for HTTP basic authentication.

void	setUsername (String name)
	Sets username for HTTP basic authentication.

String	password ()
	Gets password for HTTP basic authentication.

void	setPassword (String password)
	Sets password for HTTP basic authentication.

String	namespace ()
	Gets namespace in which the job is to be executed.

void	setNamespace (String namespace)
	Sets namespace in which the job is to be executed.

Detailed Description

Configuration that allows the execution of jobs on a specific GAMS Engine instance.

Constructor & Destructor Documentation

◆ GAMSEngineConfiguration() [1/2]

com.gams.api.GAMSEngineConfiguration.GAMSEngineConfiguration	(	String	host,
		String	username,
		String	password
	)

GAMSEngineConfiguration Constructor.

Parameters

host	Base url
username	Username for HTTP basic authentication
password	Password for HTTP basic authentication

◆ GAMSEngineConfiguration() [2/2]

com.gams.api.GAMSEngineConfiguration.GAMSEngineConfiguration	(	String	host,
		String	username,
		String	password,
		String	jwt,
		String	namespace
	)

GAMSEngineConfiguration Constructor.

Parameters

host	Base url
username	Username for HTTP basic authentication
password	Password for HTTP basic authentication
jwt	JWT token to use for Bearer authentication. Will only be used if username is empty.
namespace	Namespace in which the job is to be executed

Member Function Documentation

◆ authHeader()

String com.gams.api.GAMSEngineConfiguration.authHeader ( )

Returns: authentication header

◆ host()

String com.gams.api.GAMSEngineConfiguration.host ( )

Gets base url.

Returns: host base url string.

◆ jwt()

String com.gams.api.GAMSEngineConfiguration.jwt ( )

Gets JWT token to use for Bearer authentication.

Returns: JWT token string

◆ namespace()

String com.gams.api.GAMSEngineConfiguration.namespace ( )

Gets namespace in which the job is to be executed.

Returns: namespace string

◆ password()

String com.gams.api.GAMSEngineConfiguration.password ( )

Gets password for HTTP basic authentication.

Returns: password string

◆ setHost()

void com.gams.api.GAMSEngineConfiguration.setHost ( String host )

Sets base host url.

◆ setJwt()

void com.gams.api.GAMSEngineConfiguration.setJwt ( String jwt )

Sets JWT token to use for Bearer authentication.

JWT will only be used if username is empty.

◆ setNamespace()

void com.gams.api.GAMSEngineConfiguration.setNamespace ( String namespace )

Sets namespace in which the job is to be executed.

◆ setPassword()

void com.gams.api.GAMSEngineConfiguration.setPassword ( String password )

Sets password for HTTP basic authentication.

◆ setUsername()

void com.gams.api.GAMSEngineConfiguration.setUsername ( String name )

Sets username for HTTP basic authentication.

◆ username()

String com.gams.api.GAMSEngineConfiguration.username ( )

Gets username for HTTP basic authentication.

Returns: username string

Public Member Functions