public
abstract
class
AbstractRepositoryRequest
extends Object| java.lang.Object | |
| ↳ | com.atlassian.bitbucket.repository.AbstractRepositoryRequest |
 Known Direct Subclasses
|
Class Overview
Base class for Repository-related request classes.
Summary
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| AbstractRepositoryRequest.AbstractBuilder<B extends AbstractBuilder<B>> | Base class for creating builders for repository-related requests. |
||||||||||
| Protected Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
This constructor is deprecated.
for removal in 7.0 without replacement
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
The description for the repository.
| |||||||||||
The name for the repository.
| |||||||||||
Retrieves a flag indicating whether the repository should be
forkable. | |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Protected Constructors
@Deprecated protected AbstractRepositoryRequest (String name, boolean forkable, boolean publiclyAccessible)
This constructor is deprecated.
for removal in 7.0 without replacement
Public Methods
@Nullable public String getDescription ()
The description for the repository. How this is used depends on the request type:
RepositoryCreateRequest: Sets the description for the new repositoryRepositoryForkRequest: Sets the description for the new forkRepositoryUpdateRequest: Updates the repository's description.
Returns
- the description for the repository
@Nonnull public String getName ()
The name for the repository. How this is used depends on the request type:
RepositoryCreateRequest: Sets the name (and slug) for the new repositoryRepositoryForkRequest: Sets the name (and slug) for the new forkRepositoryUpdateRequest: Updates the repository's name, which may also change its slug. Changing a repository's slug will update all of its URLs, including its clone URL
slug regardless of the
request type.Returns
- the name for the repository
public boolean isForkable ()
Retrieves a flag indicating whether the repository should be forkable. How this
is used depends on the request type:
RepositoryCreateRequest: Sets whether the new repository will be forkableRepositoryForkRequest: Sets whether the new fork itself be forkableRepositoryUpdateRequest: Updates whether an existing repository is forkable
Returns
trueif the repository should be forkable; otherwise,falseto disable forking
public boolean isPublic ()
Returns
trueif the project will be made publicly accessible,falseotherwise.