|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient<IssueClient> com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.IssueClient
public class IssueClient
Client for the issue resource.
Nested Class Summary |
---|
Nested classes/interfaces inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient |
---|
RestApiClient.Method |
Field Summary |
---|
Fields inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient |
---|
REST_VERSION |
Constructor Summary | |
---|---|
IssueClient(JIRAEnvironmentData environmentData)
Constructs a new IssueClient for a JIRA instance. |
Method Summary | |
---|---|
Response |
assign(String issueKey,
User assignee)
GETs the issue with the given key. |
IssueCreateResponse |
create(IssueUpdateRequest issue)
|
RemoteIssueLinkCreateOrUpdateResponse |
createOrUpdateRemoteIssueLink(String issueKey,
RemoteIssueLinkCreateOrUpdateRequest remoteIssueLink)
Create a remote link. |
com.sun.jersey.api.client.ClientResponse |
createOrUpdateRemoteIssueLinkAndGetClientResponse(String issueKey,
RemoteIssueLinkCreateOrUpdateRequest remoteIssueLink)
Create a remote link, and return a ClientResponse. |
Response |
createOrUpdateRemoteIssueLinkAndGetResponse(String issueKey,
RemoteIssueLinkCreateOrUpdateRequest remoteIssueLink)
Create a remote link, and return a Response. |
protected com.sun.jersey.api.client.WebResource |
createResource()
Creates the resource that corresponds to the root of the REST API. |
Response |
delete(String issueKey,
String deleteSubtasks)
GETs the issue with the given key. |
Response |
deleteRemoteIssueLink(String issueKey,
String remoteIssueLinkId)
Delete a remote link, and return a Response. |
Response |
deleteRemoteIssueLinkByGlobalId(String issueKey,
String globalId)
Delete a remote link by global id, and return a Response. |
void |
edit(String issueKey,
IssueUpdateRequest updateRequest)
|
Issue |
get(String issueKey,
Issue.Expand... expand)
GETs the issue with the given key. |
IssueCreateMeta |
getCreateMeta(List<StringList> projectIds,
List<StringList> projectKeys,
List<StringList> issueTypeIds,
List<String> issueTypeNames,
IssueCreateMeta.Expand... expand)
Returns the meta data for creating issues. |
Response |
getCreateMetaResponse(List<StringList> projectIds,
List<StringList> projectKeys,
List<StringList> issueTypeIds,
List<String> issueTypeNames,
IssueCreateMeta.Expand... expand)
Gets the meta data for creating issues, returning a Response. |
Issue |
getFromURL(String issueURL,
Issue.Expand... expand)
GETs the issue from the given URL. |
Issue |
getPartially(String issueKey,
EnumSet<Issue.Expand> expand,
StringList... fields)
|
Issue |
getPartially(String issueKey,
StringList... fields)
GETs the issue with the given key, returning only the request fields. |
RemoteIssueLink |
getRemoteIssueLink(String issueKey,
String remoteIssueLinkId)
Returns a remote link. |
RemoteIssueLink |
getRemoteIssueLinkByGlobalId(String issueKey,
String globalId)
Returns the remote link for an issue with the given globalId. |
Response |
getRemoteIssueLinkResponse(String issueKey,
String remoteIssueLinkId)
Gets a remote link, returning a Response. |
List<RemoteIssueLink> |
getRemoteIssueLinks(String issueKey)
Returns the remote links for an issue. |
Response |
getRemoteIssueLinksResponse(String issueKey)
Gets the remote links for an issue, returning a Response. |
Response |
getRemoteIssueLinksResponse(String issueKey,
Map<String,String> queryParams)
|
Response |
getResponse(IssueUpdateRequest issue)
Creates an issue as per the request, and returns the Response. |
Response |
getResponse(String issueKey)
GETs the issue with the given key, returning a Response. |
com.sun.jersey.api.client.WebResource |
issueResource(String issueKey,
Issue.Expand... expand)
|
protected com.sun.jersey.api.client.WebResource |
issueWithKey(String issueKey,
List<StringList> fields,
EnumSet<Issue.Expand> expand)
Returns a WebResource for the issue with the given key. |
void |
operationalUpdate(String issueKey,
OperationalUpdateRequest updateRequest)
|
Response |
operationalUpdateResponse(String issueKey,
OperationalUpdateRequest update)
|
void |
update(String issueKey,
IssueUpdateRequest issue)
|
Response |
update(String issueKey,
Map update)
|
Response |
updateRemoteIssueLink(String issueKey,
String linkId,
RemoteIssueLinkCreateOrUpdateRequest remoteIssueLink)
Update a remote link, and return a Response. |
Response |
updateResponse(String issueKey,
IssueUpdateRequest update)
|
Methods inherited from class com.atlassian.jira.webtests.ztests.bundledplugins2.rest.client.RestApiClient |
---|
anonymous, errorResponse, expanded, loginAs, loginAs, percentEncode, resourceRoot, setOf, toResponse, toResponse |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public IssueClient(JIRAEnvironmentData environmentData)
environmentData
- The JIRA environment dataMethod Detail |
---|
public Issue get(String issueKey, Issue.Expand... expand) throws com.sun.jersey.api.client.UniformInterfaceException
issueKey
- a String containing an issue keyexpand
- the attributes to expand
com.sun.jersey.api.client.UniformInterfaceException
- if there's a problem getting the issuepublic com.sun.jersey.api.client.WebResource issueResource(String issueKey, Issue.Expand... expand)
public Issue getPartially(String issueKey, StringList... fields) throws com.sun.jersey.api.client.UniformInterfaceException
issueKey
- a String containing an issue keyfields
- the list of fields to return for the issue
com.sun.jersey.api.client.UniformInterfaceException
- if there's a problem getting the issuepublic Issue getPartially(String issueKey, EnumSet<Issue.Expand> expand, StringList... fields) throws com.sun.jersey.api.client.UniformInterfaceException
com.sun.jersey.api.client.UniformInterfaceException
public Issue getFromURL(String issueURL, Issue.Expand... expand) throws com.sun.jersey.api.client.UniformInterfaceException
issueURL
- a String containing the valid URL for an issueexpand
- the attributes to expand
com.sun.jersey.api.client.UniformInterfaceException
- if there's a problem getting the issuepublic IssueCreateResponse create(IssueUpdateRequest issue)
public void edit(String issueKey, IssueUpdateRequest updateRequest)
public Response getResponse(IssueUpdateRequest issue)
issue
- an IssueCreateRequest
public Response operationalUpdateResponse(String issueKey, OperationalUpdateRequest update)
public void operationalUpdate(String issueKey, OperationalUpdateRequest updateRequest)
public void update(String issueKey, IssueUpdateRequest issue)
public Response updateResponse(String issueKey, IssueUpdateRequest update)
public Response update(String issueKey, Map update)
public Response delete(String issueKey, String deleteSubtasks) throws com.sun.jersey.api.client.UniformInterfaceException
issueKey
- a String containing an issue key or iddeleteSubtasks
- the attributes to expand
com.sun.jersey.api.client.UniformInterfaceException
- if there's a problem deleting the issuepublic Response assign(String issueKey, User assignee) throws com.sun.jersey.api.client.UniformInterfaceException
issueKey
- a String containing an issue key or idassignee
- user object
com.sun.jersey.api.client.UniformInterfaceException
- if there's a problem deleting the issuepublic Response getResponse(String issueKey)
issueKey
- a String containing an issue key
protected com.sun.jersey.api.client.WebResource issueWithKey(String issueKey, @Nullable List<StringList> fields, EnumSet<Issue.Expand> expand)
issueKey
- a String containing an issue keyfields
- the list of fields to return for the issueexpand
- what to expand
public IssueCreateMeta getCreateMeta(@Nullable List<StringList> projectIds, @Nullable List<StringList> projectKeys, @Nullable List<StringList> issueTypeIds, @Nullable List<String> issueTypeNames, IssueCreateMeta.Expand... expand)
projectIds
- the list of projects to filter onprojectKeys
- the list of projects to filter onissueTypeIds
- the list of issue types to filter onexpand
- what to expand
public Response getCreateMetaResponse(@Nullable List<StringList> projectIds, @Nullable List<StringList> projectKeys, @Nullable List<StringList> issueTypeIds, @Nullable List<String> issueTypeNames, IssueCreateMeta.Expand... expand)
projectIds
- the list of projects to filter onprojectKeys
- the list of projects to filter onissueTypeIds
- the list of issue types to filter onexpand
- what to expand
public RemoteIssueLinkCreateOrUpdateResponse createOrUpdateRemoteIssueLink(String issueKey, RemoteIssueLinkCreateOrUpdateRequest remoteIssueLink)
issueKey
- remoteIssueLink
-
public Response createOrUpdateRemoteIssueLinkAndGetResponse(String issueKey, RemoteIssueLinkCreateOrUpdateRequest remoteIssueLink)
issueKey
- remoteIssueLink
-
public com.sun.jersey.api.client.ClientResponse createOrUpdateRemoteIssueLinkAndGetClientResponse(String issueKey, RemoteIssueLinkCreateOrUpdateRequest remoteIssueLink)
issueKey
- remoteIssueLink
-
public Response updateRemoteIssueLink(String issueKey, String linkId, RemoteIssueLinkCreateOrUpdateRequest remoteIssueLink)
issueKey
- remoteIssueLink
-
public Response deleteRemoteIssueLink(String issueKey, String remoteIssueLinkId)
issueKey
- remoteIssueLinkId
-
public Response deleteRemoteIssueLinkByGlobalId(String issueKey, String globalId)
issueKey
- globalId
-
public RemoteIssueLink getRemoteIssueLink(String issueKey, String remoteIssueLinkId)
issueKey
- remoteIssueLinkId
-
public List<RemoteIssueLink> getRemoteIssueLinks(String issueKey)
issueKey
-
public RemoteIssueLink getRemoteIssueLinkByGlobalId(String issueKey, String globalId)
issueKey
- globalId
-
public Response getRemoteIssueLinkResponse(String issueKey, String remoteIssueLinkId)
issueKey
- remoteIssueLinkId
-
public Response getRemoteIssueLinksResponse(String issueKey)
issueKey
-
public Response getRemoteIssueLinksResponse(String issueKey, @Nullable Map<String,String> queryParams)
protected com.sun.jersey.api.client.WebResource createResource()
RestApiClient
createResource
in class RestApiClient<IssueClient>
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |