Package io.jenkins.plugins.railflow

Interface JiraParameters

All Superinterfaces:

Serializable

All Known Implementing Classes:

JiraParametersImpl

public interface JiraParameters
extends Serializable

Holds the parameters for connecting to Atlassian.

Author:

Liu Yang

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	JiraParameters.Builder

Method Summary

Modifier and Type	Method	Description
static JiraParameters.Builder	builder(String jiraUrl, String email, String token, String projectKey)	New builder.
Optional<String>	getDoneStatusName()	Gets the DONE status name.
String	getEmail()	Gets the Atlassian account email.
Optional<String>	getIssueTypeName()	Gets the issue type name.
String	getJiraUrl()	Gets the Atlassian jira url.
Optional<String>	getLookupFieldName()	Gets the lookup field name.
String	getProjectKey()	Gets the project key.
int	getTimeout()	Gets the connection timeout to the Atlassian REST API service.
Optional<String>	getTodoStatusName()	Gets the TO DO status name.
String	getToken()	Gets the token of the Atlassian account email.

Method Details

builder

static JiraParameters.Builder builder(String jiraUrl,
 String email,
 String token,
 String projectKey)

New builder.

Parameters:

jiraUrl - the Atlassian Jira URL.

email - the Atlassian user email address.

token - the token of the Atlassian user.

projectKey - the project key.

Returns:

builder.

getJiraUrl

@NonNull
String getJiraUrl()

Gets the Atlassian jira url.

Returns:

the Atlassian jira url.

getEmail

@NonNull
String getEmail()

Gets the Atlassian account email.

Returns:

the Atlassian account email.

getToken

@NonNull
String getToken()

Gets the token of the Atlassian account email.

Returns:

the token of the Atlassian account email.

getProjectKey

@NonNull
String getProjectKey()

Gets the project key.

Returns:

the project key.

getTimeout

int getTimeout()

Gets the connection timeout to the Atlassian REST API service.

Returns:

the connection timeout in seconds

getTodoStatusName

Optional<String> getTodoStatusName()

Gets the TO DO status name.

Returns:

the TO DO status name.

getDoneStatusName

Optional<String> getDoneStatusName()

Gets the DONE status name.

Returns:

the DONE status name.

getIssueTypeName

Optional<String> getIssueTypeName()

Gets the issue type name.

Returns:

the issue type name.

getLookupFieldName

Optional<String> getLookupFieldName()

Gets the lookup field name.

Returns:

the lookup field name.