Interface RegionApi

  • All Superinterfaces:
    AutoCloseable, Closeable

    @Path("/regions")
    @Consumes("application/json")
    public interface RegionApi
    extends Closeable
    Provides access to Regions via the REST API.
    • Method Detail

      • list

        @Named("region:list")
        @GET
        PagedIterable<Region> list()
        Get the list of all regions.
        Returns:
        The (paginated) list of all regions.
      • list

        @Named("region:list")
        @GET
        IterableWithMarker<Region> list​(ListOptions options)
        Get a single page of the region list.
        Parameters:
        options - The options to configure the page to get and the size of the page.
        Returns:
        The page with the requested regions.