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

Class ProjectPropertyApi

java.lang.Object

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

public class ProjectPropertyApi
extends Object

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
io.reactivex.Completable	deleteProjectProperty(String projectIdOrKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Delete project property Deletes the property from a project.
io.reactivex.Single<EntityProperty>	getProjectProperty(String projectIdOrKey, String propertyKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project property Returns the value of a project property.
io.reactivex.Single<PropertyKeys>	getProjectPropertyKeys(String projectIdOrKey, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Get project property keys Returns all project property keys for the project.
io.reactivex.Single<Object>	setProjectProperty(String projectIdOrKey, String propertyKey, Object body, Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer) Set project property Sets the value of the project property.

Methods inherited from class java.lang.Object

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

Constructor Detail

ProjectPropertyApi

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

Method Detail

deleteProjectProperty

public io.reactivex.Completable deleteProjectProperty(String projectIdOrKey,
                                                      String propertyKey,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Delete project property

Deletes the property from a project.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project containing the property.

Parameters:

projectIdOrKey -

The project ID or project key (case sensitive).

(required)

propertyKey -

The project property key. Use Get project property keys to get a list of all project property keys.

(required)

restRequestEnhancer -

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

Returns:

Completable

getProjectProperty

public io.reactivex.Single<EntityProperty> getProjectProperty(String projectIdOrKey,
                                                              String propertyKey,
                                                              Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project property

Returns the value of a project property.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project containing the property.

Parameters:

projectIdOrKey -

The project ID or project key (case sensitive).

(required)

propertyKey -

The project property key. Use Get project property keys to get a list of all project property keys.

(required)

restRequestEnhancer -

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

Returns:

Single<EntityProperty>

getProjectPropertyKeys

public io.reactivex.Single<PropertyKeys> getProjectPropertyKeys(String projectIdOrKey,
                                                                Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Get project property keys

Returns all project property keys for the project.

This operation can be accessed anonymously.

Permissions required: Browse Projects project permission for the project.

Parameters:

projectIdOrKey -

The project ID or project key (case sensitive).

(required)

restRequestEnhancer -

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

Returns:

Single<PropertyKeys>

setProjectProperty

public io.reactivex.Single<Object> setProjectProperty(String projectIdOrKey,
                                                      String propertyKey,
                                                      Object body,
                                                      Optional<org.everit.http.restclient.RestRequestEnhancer> restRequestEnhancer)

Set project property

Sets the value of the project property. You can use project properties to store custom data against the project.

The value of the request body must be a valid, non-empty JSON blob. The maximum length is 32768 characters.

This operation can be accessed anonymously.

Permissions required: Administer Jira global permission or Administer Projects project permission for the project in which the property is created.

Parameters:

projectIdOrKey -

The project ID or project key (case sensitive).

(required)

propertyKey -

The key of the project property. The maximum length is 255 characters.

(required)

body - (required)

restRequestEnhancer -

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

Returns:

Single<Object>