Interface EnvironmentLabelApi

  • All Superinterfaces:
    ApiService

    @Path("/api/v1/environments/labels")
    @Consumes("application/json")
    @Produces("application/json")
    public interface EnvironmentLabelApi
    extends ApiService
    • Method Detail

      • serviceName

        default java.lang.String serviceName()
        Specified by:
        serviceName in interface ApiService
      • getLabelById

        @GET
        @Path("/{environmentLabelId:.*/EnvironmentLabel[^/]*}")
        EnvironmentLabelView getLabelById​(@PathParam("environmentLabelId")
                                          java.lang.String environmentLabelId)
      • updateLabel

        @PUT
        @Path("/{environmentLabelId:.*/EnvironmentLabel[^/]*}")
        EnvironmentLabelView updateLabel​(@PathParam("environmentLabelId")
                                         java.lang.String environmentLabelId,
                                         EnvironmentLabelForm labelForm)
      • delete

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

        EnvironmentLabel create​(EnvironmentLabel environmentLabel)
        Creates a new environment label.
        Parameters:
        environmentLabel - an EnvironmentLabel object describing the new environment label
        Returns:
        created EnvironmentLabel object
      • getById

        EnvironmentLabel getById​(java.lang.String id)
        Gets an environment label by id.
        Parameters:
        id - the environment label identifier
        Returns:
        found EnvironmentLabel object
      • update

        EnvironmentLabel update​(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

        java.util.List<EnvironmentLabel> search​(EnvironmentLabelFilters filters)
        Searches environment labels by filters.
        Parameters:
        filters - an EnvironmentTypeFilters object describing the search criteria
        Returns:
        list of matching EnvironmentLabels