Package com.iland.core.web.rest.api

Interface NsxTApplicationPortProfileResource

All Superinterfaces:

com.iland.vcloud.nsxt.vdc.VdcApplicationPortProfileApi

@Path("/nsx-t/vdcs/portProfiles")
@Consumes("application/json")
@Produces("application/vnd.ilandcloud.api.v1.0+json")
public interface NsxTApplicationPortProfileResource
extends com.iland.vcloud.nsxt.vdc.VdcApplicationPortProfileApi

Resource Interface for Vdc application port profiles.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method	Description
com.iland.core.web.rest.response.task.TaskResponse	createApplicationPortProfile(com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid, com.iland.core.web.rest.request.nsxt.ApplicationPortProfileRequest request)	Create an application port profiles (Service) for this VDC
com.iland.core.web.rest.response.task.TaskResponse	deleteApplicationPortProfile(com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid, com.iland.vcloud.nsx.common.model.ApplicationPortProfileUuid uuid)	Delete an application port profiles (Service) for this VDC
com.iland.core.web.rest.response.nsx.ApplicationResponse	getApplicationPortProfile(com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid, com.iland.vcloud.nsx.common.model.ApplicationPortProfileUuid uuid)	Gets the application port profile for the given vcloud uuid
com.iland.core.web.rest.response.nsx.ApplicationListResponse	getApplicationPortProfiles(com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid, com.iland.core.web.rest.shared.nsxt.ApplicationPortProfileScope scope, Integer page, Integer pageSize, String nameFilter, String protocolFilter, String portFilter)	Gets the application port profiles (Services) for this VDC
String	getTaskOwnerEntityKey()	Application Port profiles can be owned by a vDC only (currently).
com.iland.core.web.rest.response.task.TaskResponse	updateApplicationPortProfiles(com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid, com.iland.core.web.rest.request.nsxt.ApplicationPortProfileRequest request)	Update an application port profiles (Service) for this VDC

Method Details

getApplicationPortProfiles

@GET
@Path("/{vdcUuid}/applications")
com.iland.core.web.rest.response.nsx.ApplicationListResponse getApplicationPortProfiles(@PathParam("vdcUuid")
 com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid,
 @QueryParam("scope")
 com.iland.core.web.rest.shared.nsxt.ApplicationPortProfileScope scope,
 @QueryParam("page")
 Integer page,
 @QueryParam("pageSize")
 Integer pageSize,
 @QueryParam("nameFilter")
 String nameFilter,
 @QueryParam("protocolFilter")
 String protocolFilter,
 @QueryParam("portFilter")
 String portFilter)

Gets the application port profiles (Services) for this VDC

Specified by:

getApplicationPortProfiles in interface com.iland.vcloud.nsxt.vdc.VdcApplicationPortProfileApi

Parameters:

vdcUuid - the input vdc uuid

scope - scope of an Application Port Profile. Defaults to SYSTEM if none specified

page - the starting page (starts at 1)

pageSize - the page size of this request (max limit 100)

nameFilter - the optional fuzzy search name filter for this request

protocolFilter - the optional protocol filter for this request

portFilter - the optional port number filter for this request

Returns:

the list of port profiles for this Vdc

getApplicationPortProfile

@GET
@Path("/{vdcUuid}/{uuid}")
com.iland.core.web.rest.response.nsx.ApplicationResponse getApplicationPortProfile(@PathParam("vdcUuid")
 com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid,
 @PathParam("uuid")
 com.iland.vcloud.nsx.common.model.ApplicationPortProfileUuid uuid)

Gets the application port profile for the given vcloud uuid

Specified by:

getApplicationPortProfile in interface com.iland.vcloud.nsxt.vdc.VdcApplicationPortProfileApi

Parameters:

uuid - the input vcloud port profile uuid

Returns:

the list of port profiles for this Vdc

createApplicationPortProfile

@POST
@Path("/{vdcUuid}/create-port-profile")
com.iland.core.web.rest.response.task.TaskResponse createApplicationPortProfile(@PathParam("vdcUuid")
 com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid,
 com.iland.core.web.rest.request.nsxt.ApplicationPortProfileRequest request)

Create an application port profiles (Service) for this VDC

Specified by:

createApplicationPortProfile in interface com.iland.vcloud.nsxt.vdc.VdcApplicationPortProfileApi

Parameters:

vdcUuid - the input vdc platform uuid

request - the create request

Returns:

the task response to track the status of create

updateApplicationPortProfiles

@PUT
@Path("/{vdcUuid}/modify-port-profile")
com.iland.core.web.rest.response.task.TaskResponse updateApplicationPortProfiles(@PathParam("vdcUuid")
 com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid,
 com.iland.core.web.rest.request.nsxt.ApplicationPortProfileRequest request)

Update an application port profiles (Service) for this VDC

Specified by:

updateApplicationPortProfiles in interface com.iland.vcloud.nsxt.vdc.VdcApplicationPortProfileApi

Parameters:

vdcUuid - the input vdc platform uuid

Returns:

the task response to track the status of update

deleteApplicationPortProfile

@DELETE
@Path("/{vdcUuid}/{uuid}")
com.iland.core.web.rest.response.task.TaskResponse deleteApplicationPortProfile(@PathParam("vdcUuid")
 com.iland.vcloud.nsx.common.model.BaseVdcUuid vdcUuid,
 @PathParam("uuid")
 com.iland.vcloud.nsx.common.model.ApplicationPortProfileUuid uuid)

Delete an application port profiles (Service) for this VDC

Specified by:

deleteApplicationPortProfile in interface com.iland.vcloud.nsxt.vdc.VdcApplicationPortProfileApi

Parameters:

uuid - the input application port profile vdc uuid

Returns:

the task response to track the status of update

getTaskOwnerEntityKey

@GET
@Path("grouping-objects/taskOwnerEntityKey")
String getTaskOwnerEntityKey()

Application Port profiles can be owned by a vDC only (currently). Use TaskResponse#other_attributes with this key on a port profile create or update Task to retrieve the owner entity UUID.

Specified by:

getTaskOwnerEntityKey in interface com.iland.vcloud.nsxt.vdc.VdcApplicationPortProfileApi

Returns:

the TaskResponse other_attributes key