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
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description EnvironmentLabelcreate(EnvironmentLabel environmentLabel)Creates a new environment label.EnvironmentLabelViewcreateLabel(EnvironmentLabelForm labelForm)voiddelete(java.lang.String environmentLabelId)Deletes an environment label.EnvironmentLabelgetById(java.lang.String id)Gets an environment label by id.EnvironmentLabelViewgetLabelById(java.lang.String environmentLabelId)java.util.List<EnvironmentLabel>search(EnvironmentLabelFilters filters)Searches environment labels by filters.java.util.List<EnvironmentLabelView>searchLabels(EnvironmentLabelFilters filters)default java.lang.StringserviceName()EnvironmentLabelupdate(EnvironmentLabel environmentLabel)Updates an existing environment label.EnvironmentLabelViewupdateLabel(java.lang.String environmentLabelId, EnvironmentLabelForm labelForm)
-
-
-
Method Detail
-
serviceName
default java.lang.String serviceName()
- Specified by:
serviceNamein interfaceApiService
-
createLabel
@POST EnvironmentLabelView createLabel(EnvironmentLabelForm labelForm)
-
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)
-
searchLabels
@POST @Path("/search") java.util.List<EnvironmentLabelView> searchLabels(EnvironmentLabelFilters filters)
-
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- anEnvironmentLabelobject describing the new environment label- Returns:
- created
EnvironmentLabelobject
-
getById
EnvironmentLabel getById(java.lang.String id)
Gets an environment label by id.- Parameters:
id- the environment label identifier- Returns:
- found
EnvironmentLabelobject
-
update
EnvironmentLabel update(EnvironmentLabel environmentLabel)
Updates an existing environment label.- Parameters:
environmentLabel- anEnvironmentLabelobject describing the new properties of the environment label- Returns:
- updated
EnvironmentLabelobject
-
search
java.util.List<EnvironmentLabel> search(EnvironmentLabelFilters filters)
Searches environment labels by filters.- Parameters:
filters- anEnvironmentTypeFiltersobject describing the search criteria- Returns:
- list of matching
EnvironmentLabels
-
-