Package io.jenkins.plugins.railflow

Interface TestRailParameters

All Superinterfaces:

Serializable

All Known Implementing Classes:

TestRailParametersImpl

public interface TestRailParameters
extends Serializable

Holds the parameters for connecting to TestRail.

Author:

Liu Yang

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	TestRailParameters.Builder

Method Summary

Modifier and Type	Method	Description
static TestRailParameters.Builder	builder(String testRailUrl, String testRailUsername, String testRailPassword)	New builder.
String	getPassword()	Gets the password of the TestRail user.
Optional<ProxySettings>	getProxySettings()	Gets the proxy settings.
int	getTimeout()	Gets the connection timeout to the TestRail service.
String	getUrl()	Gets the TestRail url.
String	getUsername()	Gets the TestRail username.

Method Details

builder

static TestRailParameters.Builder builder(String testRailUrl,
 String testRailUsername,
 String testRailPassword)

New builder.

Parameters:

testRailUrl - the TestRail url.

testRailUsername - the TestRail username.

testRailPassword - the password of the TestRail user.

Returns:

builder.

getUrl

@NonNull
String getUrl()

Gets the TestRail url.

Returns:

the TestRail URL

getUsername

@NonNull
String getUsername()

Gets the TestRail username.

Returns:

the TestRail username

getPassword

@NonNull
String getPassword()

Gets the password of the TestRail user.

Returns:

the password of the TestRail user

getTimeout

int getTimeout()

Gets the connection timeout to the TestRail service.

Returns:

the connection timeout in seconds

getProxySettings

Optional<ProxySettings> getProxySettings()

Gets the proxy settings.

Returns:

the proxy settings