com.atlassian.bitbucket.pull

Class PullRequestActivitySearchRequest

java.lang.Object

com.atlassian.bitbucket.pull.AbstractPullRequestRequest

com.atlassian.bitbucket.pull.PullRequestActivitySearchRequest

public class PullRequestActivitySearchRequest
extends AbstractPullRequestRequest

Request for searching for pull requests' activities.

See Also:

PullRequestSearchRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PullRequestActivitySearchRequest.Builder

Nested classes/interfaces inherited from class com.atlassian.bitbucket.pull.AbstractPullRequestRequest

AbstractPullRequestRequest.AbstractBuilder<T extends AbstractPullRequestRequest.AbstractBuilder<T>>

Method Summary

Modifier and Type	Method and Description
Set<CommentAction>	getCommentActions() Limits the comment activities to the ones performing the specified comment actions.
Set<Long>	getCommentIds() Limits the comment activities to the ones affecting the specified comments.
PullRequestActivityPropertyMode	getPropertyMode()
Set<PullRequestActivityType>	getTypes() Specifies the type(s) of activities to search for.
boolean	isWithProperties() Deprecated. since 7.14 for removal in 8.0. Use getPropertyMode() and PullRequestActivityPropertyMode.includesPullRequests() instead.

Methods inherited from class com.atlassian.bitbucket.pull.AbstractPullRequestRequest

getPullRequestId, getRepositoryId

Methods inherited from class java.lang.Object

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

Method Detail

getCommentActions

@Nonnull
public Set<CommentAction> getCommentActions()

Limits the comment activities to the ones performing the specified comment actions.

Note: this is only valid if the searched types include comment activities.

Returns:

comment actions the comment activities must perform (can be empty)

getCommentIds

@Nonnull
public Set<Long> getCommentIds()

Limits the comment activities to the ones affecting the specified comments.

Note: this is only valid if the searched types include comment activities.

Returns:

the IDs of the comments the comment activities affect (can be empty)

getPropertyMode

@Nonnull
public PullRequestActivityPropertyMode getPropertyMode()

Returns:

mode of property enriching pull requests and pull request activity. By default set to PullRequestActivityPropertyMode.ACTIVITY_ONLY.

Since:

7.14

getTypes

@Nonnull
public Set<PullRequestActivityType> getTypes()

Specifies the type(s) of activities to search for.

Returns:

the types of activities to retrieve (can be empty)

See Also:

PullRequestActivityType

isWithProperties

@Deprecated
public boolean isWithProperties()

Deprecated. since 7.14 for removal in 8.0. Use getPropertyMode() and PullRequestActivityPropertyMode.includesPullRequests() instead.

Returns:

true to fetch the pull requests' properties