@PublicApi public final class

UpdateIssueRequest

extends Object
java.lang.Object
   ↳ com.atlassian.jira.issue.UpdateIssueRequest

@PublicApi

This class is designed for plugins to consume (call its methods).

Clients of @PublicApi can expect that programs compiled against a given version will remain binary compatible with later versions of the @PublicApi as per each product's API policy as long as the client does not implement/extend @PublicApi interfaces or classes (refer to each product's API policy for the exact guarantee---usually binary compatibility is guaranteed at least across minor versions).

Note: since @PublicApi interfaces and classes are not designed to be implemented or extended by clients, we may perform certain types of binary-incompatible changes to these classes and interfaces, but these will not affect well-behaved clients that do not extend/implement these types (in general, only classes and interfaces annotated with @PublicSpi are safe to extend/implement).

Class Overview

Groups parameters for {updateIssue(com.atlassian.jira.user.ApplicationUser, MutableIssue, UpdateIssueRequest)} specifying details for the issue update

Summary

Nested Classes
class UpdateIssueRequest.UpdateIssueRequestBuilder  
Public Methods
static UpdateIssueRequest.UpdateIssueRequestBuilder builder()
Provides a builder to create the UpdateIssueRequest object.
boolean equals(Object obj)
This method is implemented for usage in Unit Tests.
EventDispatchOption getEventDispatchOption()
Defines an event dispatching strategy for the update
@Nullable HistoryMetadata getHistoryMetadata()
Additional metadata to be persisted in history with the update operation, null if none
int hashCode()
This method is implemented for usage in Unit Tests.
boolean isSendMail()
If true mail notifications will be sent, otherwise mail notifications will be suppressed.
[Expand]
Inherited Methods
From class java.lang.Object

Public Methods

public static UpdateIssueRequest.UpdateIssueRequestBuilder builder ()

Provides a builder to create the UpdateIssueRequest object.

public boolean equals (Object obj)

This method is implemented for usage in Unit Tests.

public EventDispatchOption getEventDispatchOption ()

Defines an event dispatching strategy for the update

@Nullable public HistoryMetadata getHistoryMetadata ()

Additional metadata to be persisted in history with the update operation, null if none

See Also

public int hashCode ()

This method is implemented for usage in Unit Tests.

public boolean isSendMail ()

If true mail notifications will be sent, otherwise mail notifications will be suppressed.