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 EnvironmentLabel
create(EnvironmentLabel environmentLabel)
Creates a new environment label.EnvironmentLabelView
createLabel(EnvironmentLabelForm labelForm)
void
delete(java.lang.String environmentLabelId)
Deletes an environment label.EnvironmentLabel
getById(java.lang.String id)
Gets an environment label by id.EnvironmentLabelView
getLabelById(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.String
serviceName()
EnvironmentLabel
update(EnvironmentLabel environmentLabel)
Updates an existing environment label.EnvironmentLabelView
updateLabel(java.lang.String environmentLabelId, EnvironmentLabelForm labelForm)
-
-
-
Method Detail
-
serviceName
default java.lang.String serviceName()
- Specified by:
serviceName
in 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
- anEnvironmentLabel
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
- anEnvironmentLabel
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
- anEnvironmentTypeFilters
object describing the search criteria- Returns:
- list of matching
EnvironmentLabel
s
-
-