Interface GuestOSApi


  • public interface GuestOSApi
    Provides synchronous access to cloudstack via their REST API.

    See Also:
    • Method Detail

      • listOSTypes

        @Named("listOsTypes")
        @GET
        @Consumes("application/json")
        Set<OSType> listOSTypes​(ListOSTypesOptions... options)
        Lists all supported OS types for this cloud.
        Parameters:
        options - if present, how to constrain the list
        Returns:
        os types matching query, or empty set, if no types are found
      • getOSType

        @Named("listOsTypes")
        @GET
        @Consumes("application/json")
        OSType getOSType​(@QueryParam("id")
                         String id)
        get a specific os type by id
        Parameters:
        id - os type to get
        Returns:
        os type or null if not found
      • listOSCategories

        @Named("listOsCategories")
        @GET
        Map<String,​String> listOSCategories()
        Lists all supported OS categories for this cloud.
        Returns:
        os categories matching query, or empty set, if no categories are found
      • getOSCategory

        @Named("listOsCategories")
        @GET
        Map.Entry<String,​String> getOSCategory​(@QueryParam("id")
                                                     String id)
        get a specific os category by id
        Parameters:
        id - os category to get
        Returns:
        os category or null if not found