Package com.xebialabs.xlrelease.api.v1

Interface EnvironmentLabelApi

All Superinterfaces:
ApiService
@Path("/api/v1/environments/labels") @Consumes("application/json") @Produces("application/json") public interface EnvironmentLabelApi extends ApiService

  • Field Summary

    Fields inherited from interface com.xebialabs.xlrelease.api.ApiService

    DEFAULT_RESULTS_PER_PAGE, DEFAULT_RESULTS_PER_PAGE_STRING, DEPTH, ORDER_BY, PAGE, PAGE_IS_OFFSET, RESULTS_PER_PAGE, ROLE_IDS_DATA

  • Method Summary

    Modifier and Type
    Method
    Description
    com.xebialabs.xlrelease.domain.environments.EnvironmentLabel
    create(com.xebialabs.xlrelease.domain.environments.EnvironmentLabel environmentLabel)
    Creates a new environment label.
    com.xebialabs.xlrelease.api.v1.views.EnvironmentLabelView
    createLabel(com.xebialabs.xlrelease.api.v1.form.EnvironmentLabelForm labelForm)
     
    void
    delete(String environmentLabelId)
    Deletes an environment label.
    com.xebialabs.xlrelease.domain.environments.EnvironmentLabel
    getById(String id)
    Gets an environment label by id.
    com.xebialabs.xlrelease.api.v1.views.EnvironmentLabelView
    getLabelById(String environmentLabelId)
     
    List<com.xebialabs.xlrelease.domain.environments.EnvironmentLabel>
    search(com.xebialabs.xlrelease.api.v1.filter.EnvironmentLabelFilters filters)
    Searches environment labels by filters.
    List<com.xebialabs.xlrelease.api.v1.views.EnvironmentLabelView>
    searchLabels(com.xebialabs.xlrelease.api.v1.filter.EnvironmentLabelFilters filters)
     
    default String
    serviceName()
     
    com.xebialabs.xlrelease.domain.environments.EnvironmentLabel
    update(com.xebialabs.xlrelease.domain.environments.EnvironmentLabel environmentLabel)
    Updates an existing environment label.
    com.xebialabs.xlrelease.api.v1.views.EnvironmentLabelView
    updateLabel(String environmentLabelId, com.xebialabs.xlrelease.api.v1.form.EnvironmentLabelForm labelForm)
     

  • Method Details

    • serviceName

      default String serviceName()
      Specified by:
      serviceName in interface ApiService

    • createLabel

      @POST com.xebialabs.xlrelease.api.v1.views.EnvironmentLabelView createLabel(com.xebialabs.xlrelease.api.v1.form.EnvironmentLabelForm labelForm)

    • getLabelById

      @GET @Path("/{environmentLabelId:.*/EnvironmentLabel[^/]*}") com.xebialabs.xlrelease.api.v1.views.EnvironmentLabelView getLabelById(@PathParam("environmentLabelId") String environmentLabelId)

    • updateLabel

      @PUT @Path("/{environmentLabelId:.*/EnvironmentLabel[^/]*}") com.xebialabs.xlrelease.api.v1.views.EnvironmentLabelView updateLabel(@PathParam("environmentLabelId") String environmentLabelId, com.xebialabs.xlrelease.api.v1.form.EnvironmentLabelForm labelForm)

    • searchLabels

      @POST @Path("/search") List<com.xebialabs.xlrelease.api.v1.views.EnvironmentLabelView> searchLabels(com.xebialabs.xlrelease.api.v1.filter.EnvironmentLabelFilters filters)

    • delete

      @DELETE @Path("/{environmentLabelId:.*/EnvironmentLabel[^/]*}") void delete(@PathParam("environmentLabelId") String environmentLabelId)
      Deletes an environment label.
      Parameters:
      environmentLabelId - the environment label identifier

    • create

      com.xebialabs.xlrelease.domain.environments.EnvironmentLabel create(com.xebialabs.xlrelease.domain.environments.EnvironmentLabel environmentLabel)
      Creates a new environment label.
      Parameters:
      environmentLabel - an EnvironmentLabel object describing the new environment label
      Returns:
      created EnvironmentLabel object

    • getById

      com.xebialabs.xlrelease.domain.environments.EnvironmentLabel getById(String id)
      Gets an environment label by id.
      Parameters:
      id - the environment label identifier
      Returns:
      found EnvironmentLabel object

    • update

      com.xebialabs.xlrelease.domain.environments.EnvironmentLabel update(com.xebialabs.xlrelease.domain.environments.EnvironmentLabel environmentLabel)
      Updates an existing environment label.
      Parameters:
      environmentLabel - an EnvironmentLabel object describing the new properties of the environment label
      Returns:
      updated EnvironmentLabel object

    • search

      List<com.xebialabs.xlrelease.domain.environments.EnvironmentLabel> search(com.xebialabs.xlrelease.api.v1.filter.EnvironmentLabelFilters filters)
      Searches environment labels by filters.
      Parameters:
      filters - an EnvironmentTypeFilters object describing the search criteria
      Returns:
      list of matching EnvironmentLabels