ListLabels (Gerrit Review Plugin API Documentation)

java.lang.Object
- com.google.gerrit.server.restapi.project.ListLabels

All Implemented Interfaces:: RestReadView<ProjectResource>, RestView<ProjectResource>

public class ListLabels
extends Object
implements RestReadView<ProjectResource>

Constructor Summary

Constructors
Constructor Description

ListLabels(com.google.inject.Provider<CurrentUser> user, PermissionBackend permissionBackend)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Response<List<LabelDefinitionInfo>>`	`apply(ProjectResource rsrc)`	Process the view operation by reading from the resource.
`ListLabels`	`withInherited(boolean inherited)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ListLabels
```
@Inject
public ListLabels(com.google.inject.Provider<CurrentUser> user,
                  PermissionBackend permissionBackend)
```
- Method Detail
  - withInherited
```
public ListLabels withInherited(boolean inherited)
```
  - apply
```
public Response<List<LabelDefinitionInfo>> apply(ProjectResource rsrc)
                                          throws AuthException,
                                                 PermissionBackendException
```
    Description copied from interface: RestReadView
    
    Process the view operation by reading from the resource.
    The value of the returned response is automatically converted to JSON unless it is a BinaryResult.
    The returned response defines the status code that is returned to the client. For RestReadViews this is usually 200 OK, but other 2XX or 3XX status codes are also possible (e.g. Response.Redirect can be returned for 302 Found).
    Throwing a subclass of RestApiException results in a 4XX response to the client. For any other exception the client will get a 500 Internal Server Error response.
    
    Specified by:
    
    apply in interface RestReadView<ProjectResource>
    
    Parameters:
    
    rsrc - resource to read
    
    Returns:
    
    response to return to the client
    
    Throws:
    
    AuthException - the caller is not permitted to access this view.
    
    PermissionBackendException