org.llorllale.youtrack.api

Interface Issues

public interface Issues

Issues API.

Since:

0.4.0

Author:

George Aristy (george.aristy@gmail.com)

Method Summary

Modifier and Type	Method and Description
Issue	create(String summary, String description) Creates an issue with the given summary and description.
Issue	create(String summary, String description, Map<Field,FieldValue> fields) Creates an issue with the given summary, description, and fields.
Optional<Issue>	get(String id) The Issue with the given id, if it exists.
Project	project() This Issues' Project.
Stream<Issue>	stream() A Stream with all issues created for this Project.

Method Detail

project

Project project()

This Issues' Project.

Returns:

this Issues' Project

Since:

0.4.0

stream

Stream<Issue> stream()
              throws IOException,
                     UnauthorizedException

A Stream with all issues created for this Project.

Returns:

a Stream with all issues for this project

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Login is not authorized to access this resource

Since:

0.4.0

get

Optional<Issue> get(String id)
             throws IOException,
                    UnauthorizedException

The Issue with the given id, if it exists.

Parameters:

id - the issue's id

Returns:

The Issue with the given id, if it exists.

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Login is unauthorized to perform this operation

Since:

0.4.0

create

Issue create(String summary,
             String description)
      throws IOException,
             UnauthorizedException

Creates an issue with the given summary and description.

Parameters:

summary - the issue's summary

description - the issue's description

Returns:

the newly-created Issue

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Login is unauthorized to perform this operation

Since:

1.0.0

create

Issue create(String summary,
             String description,
             Map<Field,FieldValue> fields)
      throws IOException,
             UnauthorizedException

Creates an issue with the given summary, description, and fields.

Parameters:

summary - the issue's summary

description - the issue's description

fields - the issue's fields

Returns:

the newly-created Issue

Throws:

IOException - if the server is unavailable

UnauthorizedException - if the user's Login is unauthorized to perform this operation

Since:

1.0.0