com.google.gerrit.extensions.api.projects

Interface ProjectApi

All Known Implementing Classes:

ProjectApi.NotImplemented, ProjectApiImpl

public interface ProjectApi

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ProjectApi.ListRefsRequest<T extends RefInfo>
static class	ProjectApi.NotImplemented A default implementation which allows source compatibility when adding new methods to the interface.

Method Summary

Modifier and Type	Method and Description
ProjectAccessInfo	access()
ProjectAccessInfo	access(ProjectAccessInput p)
BranchApi	branch(String ref) Look up a branch by refname.
ProjectApi.ListRefsRequest<BranchInfo>	branches()
ChildProjectApi	child(String name)
List<ProjectInfo>	children()
List<ProjectInfo>	children(boolean recursive)
ConfigInfo	config()
ConfigInfo	config(ConfigInput in)
ProjectApi	create()
ProjectApi	create(ProjectInput in)
void	deleteBranches(DeleteBranchesInput in)
void	deleteTags(DeleteTagsInput in)
String	description()
void	description(DescriptionInput in)
ProjectInfo	get()
TagApi	tag(String ref) Look up a tag by refname.
ProjectApi.ListRefsRequest<TagInfo>	tags()

Method Detail

create

ProjectApi create()
           throws RestApiException

Throws:

RestApiException

create

ProjectApi create(ProjectInput in)
           throws RestApiException

Throws:

RestApiException

get

ProjectInfo get()
         throws RestApiException

Throws:

RestApiException

description

String description()
            throws RestApiException

Throws:

RestApiException

description

void description(DescriptionInput in)
          throws RestApiException

Throws:

RestApiException

access

ProjectAccessInfo access()
                  throws RestApiException

Throws:

RestApiException

access

ProjectAccessInfo access(ProjectAccessInput p)
                  throws RestApiException

Throws:

RestApiException

config

ConfigInfo config()
           throws RestApiException

Throws:

RestApiException

config

ConfigInfo config(ConfigInput in)
           throws RestApiException

Throws:

RestApiException

branches

ProjectApi.ListRefsRequest<BranchInfo> branches()

tags

ProjectApi.ListRefsRequest<TagInfo> tags()

deleteBranches

void deleteBranches(DeleteBranchesInput in)
             throws RestApiException

Throws:

RestApiException

deleteTags

void deleteTags(DeleteTagsInput in)
         throws RestApiException

Throws:

RestApiException

children

List<ProjectInfo> children()
                    throws RestApiException

Throws:

RestApiException

children

List<ProjectInfo> children(boolean recursive)
                    throws RestApiException

Throws:

RestApiException

child

ChildProjectApi child(String name)
               throws RestApiException

Throws:

RestApiException

branch

BranchApi branch(String ref)
          throws RestApiException

Look up a branch by refname.

Note: This method eagerly reads the branch. Methods that mutate the branch do not necessarily re-read the branch. Therefore, calling a getter method on an instance after calling a mutation method on that same instance is not guaranteed to reflect the mutation. It is not recommended to store references to BranchApi instances.

Parameters:

ref - branch name, with or without "refs/heads/" prefix.

Returns:

API for accessing the branch.

Throws:

RestApiException - if a problem occurred reading the project.

tag

TagApi tag(String ref)
    throws RestApiException

Look up a tag by refname.

Parameters:

ref - tag name, with or without "refs/tags/" prefix.

Returns:

API for accessing the tag.

Throws:

RestApiException - if a problem occurred reading the project.