Package com.atlassian.bitbucket.repository

Class RepositoryUpdateRequest

java.lang.Object

com.atlassian.bitbucket.repository.AbstractRepositoryRequest

com.atlassian.bitbucket.repository.RepositoryUpdateRequest

public class RepositoryUpdateRequest
extends AbstractRepositoryRequest

Defines the properties that can be modified when updating a Repository. To reduce backwards compatibility issues as new properties are added over time, instances of this class may only be created using its RepositoryUpdateRequest.Builder.

The following properties are required:

• getId(): The ID of the repository to update. This value will not be changed.
• AbstractRepositoryRequest.getName(): The new name for the repository, which may match the old name if only the forkability of the repository should be updated

The following properties, if not specified, will have defaults applied:

• AbstractRepositoryRequest.isForkable(): Defaults to true, meaning the repository will be marked as forkable if not explicitly specified
• AbstractRepositoryRequest.isPublic(): Defaults to false, meaning the repository will not be public if not explicitly specified

The fork's slug, which is used in URLs (both for the browser and when cloning), will be generated from the provided AbstractRepositoryRequest.getName(). If the new name, or new slug, have already been used by a different repository in the same project, the repository cannot be updated. Additionally, note that changing a repository's name, as it may change the slug, may change every URL for the repository, both URLs used by the browser and the clone URL. As a result, changing a repository's name may be very disruptive and should be carefully considered.

See Also:

• RepositoryService.update(RepositoryUpdateRequest)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RepositoryUpdateRequest.Builder	Constructs requests for updating repositories.

Nested classes/interfaces inherited from class com.atlassian.bitbucket.repository.AbstractRepositoryRequest

AbstractRepositoryRequest.AbstractBuilder<B extends AbstractRepositoryRequest.AbstractBuilder<B>>

Method Summary

Modifier and Type	Method	Description
Boolean	getArchived()	Retrieves the archive state to be set when the repository is updated.
String	getDefaultBranch()	Retrieves the new default branch that should be set when the repository is updated.
int	getId()	Retrieves the ID of the repository to update.
Project	getProject()	Retrieves the project the repository should be moved to.

Methods inherited from class com.atlassian.bitbucket.repository.AbstractRepositoryRequest

getDescription, getName, isForkable, isPublic

Methods inherited from class java.lang.Object

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

Method Details

getArchived

@Nullable
public Boolean getArchived()

Retrieves the archive state to be set when the repository is updated. If no value is provided, the archive state will not be updated.

Returns:

the archive state, which may be null to retain the existing archive state

Since:

8.0

getDefaultBranch

@Nullable
public String getDefaultBranch()

Retrieves the new default branch that should be set when the repository is updated. If no value is provided the default branch will not be updated.

Returns:

the default branch name, which may be null to retain the existing default branch

Since:

7.5

getId

public int getId()

Retrieves the ID of the repository to update.

Returns:

the repository's ID

getProject

@Nullable
public Project getProject()

Retrieves the project the repository should be moved to.

Returns:

the project to move the repository to. If null, leave the repository in the existing project