org.everit.atlassian.restclient.jiracloud.v3.api

Class ProjectValidateApi

java.lang.Object

org.everit.atlassian.restclient.jiracloud.v3.api.ProjectValidateApi

public class ProjectValidateApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ProjectValidateApi(org.everit.http.restclient.RestClient restClient)

Method Summary

Modifier and Type	Method and Description
io.reactivex.Single<String>	getValidProjectKey(Optional<String> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get valid project key Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.
io.reactivex.Single<String>	getValidProjectName(Optional<String> name, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get valid project name Checks that a project name isn't in use.
io.reactivex.Single<ErrorCollection>	validateProjectKey(Optional<String> key, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Validate project key Validates a project key by confirming the key is a valid string and not in use.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectValidateApi

public ProjectValidateApi(org.everit.http.restclient.RestClient restClient)

Method Detail

getValidProjectKey

public io.reactivex.Single<String> getValidProjectKey(Optional<String> key,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get valid project key

Validates a project key and, if the key is invalid or in use, generates a valid random string for the project key.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

key -

The project key.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<String>

getValidProjectName

public io.reactivex.Single<String> getValidProjectName(Optional<String> name,
                                                       Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get valid project name

Checks that a project name isn't in use. If the name isn't in use, the passed string is returned. If the name is in use, this operation attempts to generate a valid project name based on the one supplied, usually by adding a sequence number. If a valid project name cannot be generated, a 404 response is returned.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

name -

The project name.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<String>

validateProjectKey

public io.reactivex.Single<ErrorCollection> validateProjectKey(Optional<String> key,
                                                               Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Validate project key

Validates a project key by confirming the key is a valid string and not in use.

This operation can be accessed anonymously.

Permissions required: None.

Parameters:

key -

The project key.

(optional)

restRequestEnhancer -

Adds the possibility to modify the rest request before sending out. This can be useful to add authorizations tokens for example.

Returns:

Single<ErrorCollection>