com.atlassian.bitbucket.pull

Class PullRequestChangesRequest.Builder

java.lang.Object

com.atlassian.bitbucket.util.BuilderSupport

com.atlassian.bitbucket.pull.AbstractPullRequestRequest.AbstractBuilder<PullRequestChangesRequest.Builder>

com.atlassian.bitbucket.pull.PullRequestChangesRequest.Builder

Enclosing class:

PullRequestChangesRequest

public static class PullRequestChangesRequest.Builder
extends AbstractPullRequestRequest.AbstractBuilder<PullRequestChangesRequest.Builder>

Field Summary

Fields inherited from class com.atlassian.bitbucket.util.BuilderSupport

NOT_BLANK

Constructor Summary

Constructors

Constructor and Description
Builder(int repositoryId, long pullRequestId)
Builder(PullRequest pullRequest)
Builder(PullRequestChangesRequest request)

Method Summary

Modifier and Type	Method and Description
PullRequestChangesRequest	build()
PullRequestChangesRequest.Builder	changeScope(PullRequestChangeScope value) Specifies the scope of the changes to be streamed.
protected PullRequestChangesRequest.Builder	self()
PullRequestChangesRequest.Builder	sinceId(String value) Specifies the sinceId to use when retrieving the changes, if the scope is PullRequestChangeScope.RANGE.
PullRequestChangesRequest.Builder	untilId(String value) Specifies the untilId to use when retrieving the changes, if the scope is PullRequestChangeScope.RANGE.
PullRequestChangesRequest.Builder	withComments(boolean value) Specifies whether comment count attributes should be applied when streaming changes.

Methods inherited from class com.atlassian.bitbucket.util.BuilderSupport

addIf, addIf, addIf, addIf, addIf, addIf, checkNotBlank, requireNonBlank

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(@Nonnull
               PullRequestChangesRequest request)

Builder

public Builder(@Nonnull
               PullRequest pullRequest)

Builder

public Builder(int repositoryId,
               long pullRequestId)

Method Detail

build

@Nonnull
public PullRequestChangesRequest build()

changeScope

@Nonnull
public PullRequestChangesRequest.Builder changeScope(@Nonnull
                                                              PullRequestChangeScope value)

Specifies the scope of the changes to be streamed.

Parameters:

value - UNREVIEWED to stream unreviewed changes for the for the current user (if they exist); otherwise, ALL to stream all changes (the default)

Returns:

this

Since:

4.10

See Also:

PullRequestChangeScope

sinceId

@Nonnull
public PullRequestChangesRequest.Builder sinceId(@Nullable
                                                          String value)

Specifies the sinceId to use when retrieving the changes, if the scope is PullRequestChangeScope.RANGE.

If the scope is not PullRequestChangeScope.RANGE then this value is ignored.

Parameters:

value - the sinceId to use when retrieving changes

Returns:

this

Since:

5.0

untilId

@Nonnull
public PullRequestChangesRequest.Builder untilId(@Nullable
                                                          String value)

Specifies the untilId to use when retrieving the changes, if the scope is PullRequestChangeScope.RANGE.

If the scope is not PullRequestChangeScope.RANGE then this value is ignored.

Parameters:

value - the untilId to use when retrieving changes

Returns:

this

Since:

5.0

withComments

@Nonnull
public PullRequestChangesRequest.Builder withComments(boolean value)

Specifies whether comment count attributes should be applied when streaming changes.

Parameters:

value - true to request comment counts to be applied when streaming changes (the default); otherwise, false to omit the counts

Returns:

this

self

@Nonnull
protected PullRequestChangesRequest.Builder self()

Specified by:

self in class AbstractPullRequestRequest.AbstractBuilder<PullRequestChangesRequest.Builder>