public class PullRequestSearchRequest extends Object
| Modifier and Type | Class and Description |
|---|---|
static class |
PullRequestSearchRequest.Builder |
| Modifier and Type | Field and Description |
|---|---|
static int |
MAXIMUM_BRANCHES_TO_SEARCH |
| Modifier and Type | Method and Description |
|---|---|
Date |
getClosedSince()
When set, limits the pull requests to search for pull requests in the closed state (i.e.
|
String |
getFilterText()
When set, limits the pull requests to search for to those whose
title or
description contains the provided text. |
Collection<String> |
getFromRefIds()
When set, limits the pull requests to search for by the branches the changes are coming from.
|
Integer |
getFromRepositoryId()
When set, limits the pull requests to search for by the repository the changes are coming from.
|
PullRequestOrder |
getOrder()
Deprecated.
in 8.17 to be removed in 9.0. Use
getOrders() which returns a
list of orders instead |
List<PullRequestOrder> |
getOrders()
A list of
order's to return the search results in. |
Collection<PullRequestParticipantRequest> |
getParticipants()
When set, limits the pull requests to search for by the
participants
associated with it. |
PullRequestState |
getState()
Restricts the search to a specified
pull request state. |
Collection<String> |
getToRefIds()
When set, limits the pull requests to search for by the branches the changes are going to.
|
Integer |
getToRepositoryId()
When set, limits the pull requests to search for by the repository the changes are going to.
|
Date |
getUpdatedSince()
When set, limits the pull requests to search for pull requests where the updated timestamp is
more recent than the returned date.
|
Boolean |
isDraft()
When set, limits the search to pull requests that match the specified
draft status. |
boolean |
isWithDescription() |
boolean |
isWithProperties() |
public static final int MAXIMUM_BRANCHES_TO_SEARCH
@Nullable public Date getClosedSince()
PullRequestState.MERGED or PullRequestState.DECLINED) where the closed timestamp is
more recent than the returned date.@Nullable public String getFilterText()
title or
description contains the provided text.null for no filtering@Nonnull public Collection<String> getFromRefIds()
@Nullable public Integer getFromRepositoryId()
@Deprecated @Nullable public PullRequestOrder getOrder()
getOrders() which returns a
list of orders instead@Nonnull public List<PullRequestOrder> getOrders()
order's to return the search results in. If no PullRequestOrder is
supplied, then results will be ordered by NEWEST.@Nonnull public Collection<PullRequestParticipantRequest> getParticipants()
participants
associated with it.@Nullable public PullRequestState getState()
pull request state.@Nonnull public Collection<String> getToRefIds()
@Nullable public Integer getToRepositoryId()
@Nullable public Date getUpdatedSince()
@Nullable public Boolean isDraft()
draft status.
WARNING: This method is experimental and is subject to change between minor versions of Bitbucket. It is not for consumption and no consideration will be given to nor guarantees made for its compatibility between releases. Basically, don't use it unless you're a Bitbucket developer.
true if only draft pull requests will be returned. false, if only
non-draft pull requests will be returned. If null, then this filter will be ignored.public boolean isWithDescription()
true to fetch the description of the pull request(s) returned by the searchpublic boolean isWithProperties()
true to fetch the pull requests' properties.Copyright © 2023 Atlassian. All rights reserved.