java.lang.Object | |
↳ | com.atlassian.stash.content.ChangesetsBetweenRequest |
Defines a request to retrieve changesets "between" sets of included
and excluded
changesets, potentially filtering by paths
.
"feature-B" FB1 -- FB2 -- FB3 / / / / "master" ---- A ---- B ---- C \ \ "feature-A" FA1 -- FA2 -- FA3Given the graph above, here are some examples of the changesets "between" various points:
from ref
and the
current to ref
yields the just the added
changesetsrescope
event
.
Also useful when dealing with pull requests is the ability to determine the changesets between two repositories.
When a secondary repository
is specified its commits will be made available in
the primary repository
, which allows retrieving the changesets that have been added on a
branch in a fork, for example, when opening a pull request back to its origin.
Warning: Retrieving changesets between repositories may be expensive. Additionally, when referring
to changesets in the secondary repository
, includes
and
excludes
must be specified by hash. Branch and tag names are always resolved
using the primary repository
, which may lead to unexpected results.
Note: Once built
, a request is
immutable. None of the returned collections may be modified directly.
Nested Classes | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
ChangesetsBetweenRequest.Builder |
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Retrieves changesets, which may be identified by branch or tag name or by hash, which should be excluded from
the results.
| |||||||||||
Retrieves changesets, which may be identified by branch or tag name or by hash, which should be included in the
results.
| |||||||||||
Retrieves the names of
index attributes to load, when loading
pages of changesets. | |||||||||||
Retrieves paths, which may identify directories or files within the repository, which are used to limit returned
changesets.
| |||||||||||
Retrieves the primary repository.
| |||||||||||
When retrieving changesets between repositories, retrieves the secondary repository.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
|
Retrieves changesets, which may be identified by branch or tag name or by hash, which should be excluded from the results.
Note: Branch and tag names are always resolved against theprimary repository
.Retrieves changesets, which may be identified by branch or tag name or by hash, which should be included in the
results. When a changeset is both included and excluded
, it is excluded.
primary repository
.Retrieves the names of index
attributes to load, when loading
pages of changesets.
Retrieves paths, which may identify directories or files within the repository, which are used to limit returned changesets. When multiple paths are provided, changesets which modify any of the specified paths may be returned.
When retrieving changesets between repositories, retrieves the secondary repository. Changesets in this
repository may only be identified by hash. Any branch or tag names used will always be resolved
using the primary repository
.