com.iland.core.web.rest.api

Interface OrgVdiResource

@Path(value="/orgs/{orgUuid}/vdi")
 @Consumes(value="application/json")
 @Produces(value="application/vnd.ilandcloud.api.v1.0+json")
public interface OrgVdiResource

Virtual Desktop Infrastructure Resource.

Author:

Cory Snyder

Method Summary

Modifier and Type	Method and Description
VdiAutomationGroupResponse	createAutomationGroup(String orgUuid, VdiAutomationGroupUpdateRequest updateRequest) Create a new VDI automation group.
VdiTeamResponse	createTeam(String orgUuid, VdiTeamUpdateRequest teamCreateRequest) Create a VDI team.
VdiUserResponse	createUser(String orgUuid, VdiUserUpdateRequest userCreateRequest) Create a new VDI user.
void	deleteAutomationGroup(String orgUuid, String automationGroupUuid) Delete a VDI automation group.
void	deleteTeam(String orgUuid, String teamUuid) Delete a VDI team.
void	deleteUser(String orgUuid, String userUuid) Delete a VDI user.
void	deployAutomationGroup(String orgUuid, String automationGroupUuid, VdiAutomationDeploymentRequest deploymentOptions) Deploy a VDI automation group.
void	destroyAllDeployments(String orgUuid, String automationGroupUuid) Destroys all deployments that are associated with a VDI automation group.
void	destroyDeployment(String orgUuid, String automationGroupUuid, String deploymentUuid) Destroys an individual VDI deployment.
VdiAutomationGroupResponse	getAutomationGroup(String orgUuid, String automationGroupUuid) Get the VDI automation group configuration by UUID.
VdiAutomationDeploymentResponse	getDeployment(String orgUuid, String automationGroupUuid, String deploymentUuid) Get a VDI deployment.
VdiAutomationGroupDeploymentSummaryResponse	getDeploymentSummary(String orgUuid, String automationGroupUuid) Get the VDI deployment summary for a specified automation group.
VdiTeamResponse	getTeam(String orgUuid, String teamUuid) Get a VDI team.
VdiUserResponse	getUser(String orgUuid, String userUuid) Get a VDI user by UUID.
VdiAutomationGroupListResponse	listAutomationGroups(String orgUuid) List the existing VDI automation groups that are setup for the specified organization.
VdiAutomationDeploymentListResponse	listDeployments(String orgUuid, String automationGroupUuid) List all active VDI automation group deployments.
VdiOrgDeploymentSummaryResponse	listDeploymentSummaries(String orgUuid) Get the organization VDI deployment summary.
VdiTeamListResponse	listTeams(String orgUuid) Lists the teams that have been configured for VDI in the organization.
VdiUserListResponse	listUsers(String orgUuid) Lists the users that have been configured for VDI in the organization.
VdiAutomationGroupResponse	updateAutomationGroup(String orgUuid, String automationGroupUuid, VdiAutomationGroupUpdateRequest updateRequest) Update a VDI automation group.
VdiTeamResponse	updateTeam(String orgUuid, String teamUuid, VdiTeamUpdateRequest teamUpdateRequest) Update a VDI team.
VdiUserResponse	updateUser(String orgUuid, String userUuid, VdiUserUpdateRequest userUpdateRequest) Update a VDI user.

Method Detail

listAutomationGroups

@GET
 @Path(value="/automation-groups")
VdiAutomationGroupListResponse listAutomationGroups(@PathParam(value="orgUuid")
                                                                                            String orgUuid)

List the existing VDI automation groups that are setup for the specified organization.

Parameters:

orgUuid - the UUID of the organization

Returns:

VdiAutomationGroupListResponse

getAutomationGroup

@GET
 @Path(value="/automation-groups/{automationGroupUuid}")
VdiAutomationGroupResponse getAutomationGroup(@PathParam(value="orgUuid")
                                                                                                            String orgUuid,
                                                                                                            @PathParam(value="automationGroupUuid")
                                                                                                            String automationGroupUuid)

Get the VDI automation group configuration by UUID.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the automation group

Returns:

VdiAutomationGroupResponse

deleteAutomationGroup

@DELETE
 @Path(value="/automation-groups/{automationGroupUuid}")
void deleteAutomationGroup(@PathParam(value="orgUuid")
                                                                                            String orgUuid,
                                                                                            @PathParam(value="automationGroupUuid")
                                                                                            String automationGroupUuid)

Delete a VDI automation group.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the automation group

updateAutomationGroup

@PUT
 @Path(value="/automation-groups/{automationGroupUuid}")
 @Consumes(value="application/json")
VdiAutomationGroupResponse updateAutomationGroup(@PathParam(value="orgUuid")
                                                                                                                                                    String orgUuid,
                                                                                                                                                    @PathParam(value="automationGroupUuid")
                                                                                                                                                    String automationGroupUuid,
                                                                                                                                                    VdiAutomationGroupUpdateRequest updateRequest)

Update a VDI automation group.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the automation group

updateRequest - the update request body

Returns:

VdiAutomationGroupResponse

createAutomationGroup

@POST
 @Path(value="/automation-groups")
 @Consumes(value="application/json")
VdiAutomationGroupResponse createAutomationGroup(@PathParam(value="orgUuid")
                                                                                                                               String orgUuid,
                                                                                                                               VdiAutomationGroupUpdateRequest updateRequest)

Create a new VDI automation group.

Parameters:

orgUuid - the UUID of the organization

Returns:

VdiAutomationGroupResponse

deployAutomationGroup

@POST
 @Path(value="/automation-groups/{automationGroupUuid}/actions/deploy")
 @Consumes(value="application/json")
void deployAutomationGroup(@PathParam(value="orgUuid")
                                                                                                                                              String orgUuid,
                                                                                                                                              @PathParam(value="automationGroupUuid")
                                                                                                                                              String automationGroupUuid,
                                                                                                                                              VdiAutomationDeploymentRequest deploymentOptions)

Deploy a VDI automation group.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the automation group

deploymentOptions - the deployment options

listDeploymentSummaries

@GET
 @Path(value="/deployment-summaries")
VdiOrgDeploymentSummaryResponse listDeploymentSummaries(@PathParam(value="orgUuid")
                                                                                                   String orgUuid)

Get the organization VDI deployment summary.

Parameters:

orgUuid - the UUID of the organization

Returns:

VdiOrgDeploymentSummaryResponse

getDeploymentSummary

@GET
 @Path(value="/deployment-summaries/{automationGroupUuid}")
VdiAutomationGroupDeploymentSummaryResponse getDeploymentSummary(@PathParam(value="orgUuid")
                                                                                                                                  String orgUuid,
                                                                                                                                  @PathParam(value="automationGroupUuid")
                                                                                                                                  String automationGroupUuid)

Get the VDI deployment summary for a specified automation group.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the automation group

Returns:

VdiAutomationGroupDeploymentSummaryResponse

listDeployments

@GET
 @Path(value="/automation-groups/{automationGroupUuid}/deployments")
VdiAutomationDeploymentListResponse listDeployments(@PathParam(value="orgUuid")
                                                                                                                              String orgUuid,
                                                                                                                              @PathParam(value="automationGroupUuid")
                                                                                                                              String automationGroupUuid)

List all active VDI automation group deployments.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the VDI automation group

Returns:

VdiAutomationDeploymentListResponse

getDeployment

@GET
 @Path(value="/automation-groups/{automationGroupUuid}/deployments/{deploymentUuid}")
VdiAutomationDeploymentResponse getDeployment(@PathParam(value="orgUuid")
                                                                                                                                         String orgUuid,
                                                                                                                                         @PathParam(value="automationGroupUuid")
                                                                                                                                         String automationGroupUuid,
                                                                                                                                         @PathParam(value="deploymentUuid")
                                                                                                                                         String deploymentUuid)

Get a VDI deployment.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the VDI automation group

deploymentUuid - the UUID of the deployment

Returns:

VdiAutomationDeploymentResponse

destroyAllDeployments

@POST
 @Path(value="/automation-groups/{automationGroupUuid}/deployments/actions/destroy")
void destroyAllDeployments(@PathParam(value="orgUuid")
                                                                                                                      String orgUuid,
                                                                                                                      @PathParam(value="automationGroupUuid")
                                                                                                                      String automationGroupUuid)

Destroys all deployments that are associated with a VDI automation group.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the automation group

destroyDeployment

@POST
 @Path(value="/automation-groups/{automationGroupUuid}/deployments/{deploymentUuid}/actions/destroy")
void destroyDeployment(@PathParam(value="orgUuid")
                                                                                                                                   String orgUuid,
                                                                                                                                   @PathParam(value="automationGroupUuid")
                                                                                                                                   String automationGroupUuid,
                                                                                                                                   @PathParam(value="deploymentUuid")
                                                                                                                                   String deploymentUuid)

Destroys an individual VDI deployment. If the deployment is pending, it is cancelled.

Parameters:

orgUuid - the UUID of the organization

automationGroupUuid - the UUID of the automation group

deploymentUuid - the UUID of the deployment

listUsers

@GET
 @Path(value="/users")
VdiUserListResponse listUsers(@PathParam(value="orgUuid")
                                                          String orgUuid)

Lists the users that have been configured for VDI in the organization.

Parameters:

orgUuid - the UUID of the organization

Returns:

VdiUserListResponse

getUser

@GET
 @Path(value="/users/{userUuid}")
VdiUserResponse getUser(@PathParam(value="orgUuid")
                                                               String orgUuid,
                                                               @PathParam(value="userUuid")
                                                               String userUuid)

Get a VDI user by UUID.

Parameters:

orgUuid - the UUID of the organization

userUuid - the UUID of the VDI user

Returns:

VdiUserResponse

createUser

@POST
 @Path(value="/users")
 @Consumes(value="application/json")
VdiUserResponse createUser(@PathParam(value="orgUuid")
                                                                                             String orgUuid,
                                                                                             VdiUserUpdateRequest userCreateRequest)

Create a new VDI user.

Parameters:

orgUuid - the UUID of the organization

userCreateRequest - the new user details

Returns:

VdiUserResponse

updateUser

@PUT
 @Path(value="/users/{userUuid}")
 @Consumes(value="application/json")
VdiUserResponse updateUser(@PathParam(value="orgUuid")
                                                                                                       String orgUuid,
                                                                                                       @PathParam(value="userUuid")
                                                                                                       String userUuid,
                                                                                                       VdiUserUpdateRequest userUpdateRequest)

Update a VDI user.

Parameters:

orgUuid - the UUID of the organization

userUuid - the VDI user UUID

userUpdateRequest - the updated user details

Returns:

VdiUserResponse

deleteUser

@DELETE
 @Path(value="/users/{userUuid}")
void deleteUser(@PathParam(value="orgUuid")
                                                          String orgUuid,
                                                          @PathParam(value="userUuid")
                                                          String userUuid)

Delete a VDI user.

Parameters:

orgUuid - the UUID of the organization

userUuid - the VDI user UUID

listTeams

@GET
 @Path(value="/teams")
VdiTeamListResponse listTeams(@PathParam(value="orgUuid")
                                                          String orgUuid)

Lists the teams that have been configured for VDI in the organization.

Parameters:

orgUuid - the UUID of the organization

Returns:

VdiTeamListResponse

getTeam

@GET
 @Path(value="/teams/{teamUuid}")
VdiTeamResponse getTeam(@PathParam(value="orgUuid")
                                                               String orgUuid,
                                                               @PathParam(value="teamUuid")
                                                               String teamUuid)

Get a VDI team.

Parameters:

orgUuid - the UUID of the organization

teamUuid - the UUID of the VDI team

Returns:

VdiTeamResponse

createTeam

@POST
 @Path(value="/teams")
 @Consumes(value="application/json")
VdiTeamResponse createTeam(@PathParam(value="orgUuid")
                                                                                             String orgUuid,
                                                                                             VdiTeamUpdateRequest teamCreateRequest)

Create a VDI team.

Parameters:

orgUuid - the UUID of the organization

teamCreateRequest - new team details

Returns:

VdiTeamResponse

updateTeam

@PUT
 @Path(value="/teams/{teamUuid}")
 @Consumes(value="application/json")
VdiTeamResponse updateTeam(@PathParam(value="orgUuid")
                                                                                                       String orgUuid,
                                                                                                       @PathParam(value="teamUuid")
                                                                                                       String teamUuid,
                                                                                                       VdiTeamUpdateRequest teamUpdateRequest)

Update a VDI team.

Parameters:

orgUuid - the UUID of the organization

teamUuid - the VDI team UUID

teamUpdateRequest - updated team details

Returns:

VdiTeamResponse

deleteTeam

@DELETE
 @Path(value="/teams/{teamUuid}")
void deleteTeam(@PathParam(value="orgUuid")
                                                          String orgUuid,
                                                          @PathParam(value="teamUuid")
                                                          String teamUuid)

Delete a VDI team.

Parameters:

orgUuid - the UUID of the organization

teamUuid - the VDI team UUID