Package com.atlassian.jira.rest.client.api

Interface MetadataRestClient

public interface MetadataRestClient
Serves information about JIRA metadata like server information, issue types defined, stati, priorities and resolutions. This data constitutes a data dictionary which then JIRA issues base on.
Since:
v2.0

  • Method Summary

    Modifier and Type
    Method
    Description
    io.atlassian.util.concurrent.Promise<Iterable<Field>>
    getFields()
    Retrieves information about JIRA custom and system fields.
    io.atlassian.util.concurrent.Promise<Iterable<IssuelinksType>>
    getIssueLinkTypes()
    Retrieves from the server complete list of available issue types
    io.atlassian.util.concurrent.Promise<IssueType>
    getIssueType(URI uri)
    Retrieves from the server complete information about selected issue type
    io.atlassian.util.concurrent.Promise<Iterable<IssueType>>
    getIssueTypes()
    Retrieves from the server complete list of available issue type
    io.atlassian.util.concurrent.Promise<Iterable<Priority>>
    getPriorities()
    Retrieves from the server complete list of available priorities
    io.atlassian.util.concurrent.Promise<Priority>
    getPriority(URI uri)
    Retrieves from the server complete information about selected priority
    io.atlassian.util.concurrent.Promise<Resolution>
    getResolution(URI uri)
    Retrieves from the server complete information about selected resolution
    io.atlassian.util.concurrent.Promise<Iterable<Resolution>>
    getResolutions()
    Retrieves from the server complete information about selected resolution
    io.atlassian.util.concurrent.Promise<ServerInfo>
    getServerInfo()
    Retrieves information about this JIRA instance
    io.atlassian.util.concurrent.Promise<Status>
    getStatus(URI uri)
    Retrieves complete information about selected status
    io.atlassian.util.concurrent.Promise<Iterable<Status>>
    getStatuses()
    Retrieves lists of available statuses with complete information about them

  • Method Details

    • getIssueType

      io.atlassian.util.concurrent.Promise<IssueType> getIssueType(URI uri)
      Retrieves from the server complete information about selected issue type
      Parameters:
      uri - URI to issue type resource (one can get it e.g. from self attribute of issueType field of an issue).
      Returns:
      complete information about issue type resource
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)

    • getIssueTypes

      io.atlassian.util.concurrent.Promise<Iterable<IssueType>> getIssueTypes()
      Retrieves from the server complete list of available issue type
      Returns:
      complete information about issue type resource
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)
      Since:
      com.atlassian.jira.rest.client.api 1.0, server 5.0

    • getIssueLinkTypes

      io.atlassian.util.concurrent.Promise<Iterable<IssuelinksType>> getIssueLinkTypes()
      Retrieves from the server complete list of available issue types
      Returns:
      list of available issue types for this JIRA instance
      Throws:
      RestClientException - in case of problems (if linking is disabled on the server, connectivity, malformed messages, etc.)
      Since:
      server 4.3, com.atlassian.jira.rest.client.api 0.5

    • getStatus

      io.atlassian.util.concurrent.Promise<Status> getStatus(URI uri)
      Retrieves complete information about selected status
      Parameters:
      uri - URI to this status resource (one can get it e.g. from self attribute of status field of an issue)
      Returns:
      complete information about the selected status
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)

    • getStatuses

      io.atlassian.util.concurrent.Promise<Iterable<Status>> getStatuses()
      Retrieves lists of available statuses with complete information about them
      Returns:
      Lists of complete information about available statuses
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)

    • getPriority

      io.atlassian.util.concurrent.Promise<Priority> getPriority(URI uri)
      Retrieves from the server complete information about selected priority
      Parameters:
      uri - URI for the priority resource
      Returns:
      complete information about the selected priority
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)

    • getPriorities

      io.atlassian.util.concurrent.Promise<Iterable<Priority>> getPriorities()
      Retrieves from the server complete list of available priorities
      Returns:
      complete information about the selected priority
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)
      Since:
      com.atlassian.jira.rest.client.api 1.0, server 5.0

    • getResolution

      io.atlassian.util.concurrent.Promise<Resolution> getResolution(URI uri)
      Retrieves from the server complete information about selected resolution
      Parameters:
      uri - URI for the resolution resource
      Returns:
      complete information about the selected resolution
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)

    • getResolutions

      io.atlassian.util.concurrent.Promise<Iterable<Resolution>> getResolutions()
      Retrieves from the server complete information about selected resolution
      Returns:
      complete information about the selected resolution
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)
      Since:
      com.atlassian.jira.rest.client.api 1.0, server 5.0

    • getServerInfo

      io.atlassian.util.concurrent.Promise<ServerInfo> getServerInfo()
      Retrieves information about this JIRA instance
      Returns:
      information about this JIRA instance
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)

    • getFields

      io.atlassian.util.concurrent.Promise<Iterable<Field>> getFields()
      Retrieves information about JIRA custom and system fields.
      Returns:
      information about JIRA custom and system fields.
      Throws:
      RestClientException - in case of problems (connectivity, malformed messages, etc.)