Package com.google.gerrit.extensions.api.projects

Interface Projects

All Known Implementing Classes:

Projects.NotImplemented

public interface Projects

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	Projects.ListRequest
static class	Projects.NotImplemented	A default implementation which allows source compatibility when adding new methods to the interface.
static class	Projects.QueryRequest	API for setting parameters and getting result.

Method Summary

Modifier and Type	Method	Description
ProjectApi	create(ProjectInput in)	Create a project.
ProjectApi	create(String name)	Create a project using the default configuration.
Projects.ListRequest	list()
ProjectApi	name(String name)	Look up a project by name.
Projects.QueryRequest	query()	Query projects.
Projects.QueryRequest	query(String query)	Query projects.

Method Details

name

ProjectApi name(String name)
         throws RestApiException

Look up a project by name.

Note: This method eagerly reads the project. Methods that mutate the project do not necessarily re-read the project. 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 ProjectApi instances.

Parameters:

name - project name.

Returns:

API for accessing the project.

Throws:

RestApiException - if an error occurred.

create

@CanIgnoreReturnValue
ProjectApi create(String name)
           throws RestApiException

Create a project using the default configuration.

Parameters:

name - project name.

Returns:

API for accessing the newly-created project.

Throws:

RestApiException - if an error occurred.

create

@CanIgnoreReturnValue
ProjectApi create(ProjectInput in)
           throws RestApiException

Create a project.

Parameters:

in - project creation input; name must be set.

Returns:

API for accessing the newly-created project.

Throws:

RestApiException - if an error occurred.

list

Projects.ListRequest list()

query

Projects.QueryRequest query()

Query projects.

Example code: query().withQuery("name:project").get()

Returns:

API for setting parameters and getting result.

query

Projects.QueryRequest query(String query)

Query projects.

Shortcut API for query().withQuery(String).

See Also:

• query()