com.vmware.vcloud.rest.openapi.api.VRealizeOrchestratorApi Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of vcd-api-bindings-java Show documentation
vCloud Director REST API bindings
The newest version!
package com.vmware.vcloud.rest.openapi.api;

/*-
 * #%L
 * vcd-api-bindings-java :: vCloud Director REST API bindings
 * %%
 * Copyright (C) 2013 - 2019 VMware
 * %%
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGE.
 * #L%
 */

import com.vmware.vcloud.rest.openapi.model.VROServiceInfo;

import java.io.InputStream;
import java.io.OutputStream;
import java.util.List;
import java.util.Map;
import javax.ws.rs.*;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.MediaType;
import org.apache.cxf.jaxrs.ext.multipart.*;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiResponses;
import io.swagger.annotations.ApiResponse;
import io.swagger.jaxrs.PATCH;
import javax.validation.constraints.*;
import javax.validation.Valid;

@Path("/")
@Api(value = "/", description = "")
public interface VRealizeOrchestratorApi  {

    @GET
    @Path("/vro/servers/{id}")
    @Produces({ "application/json" })
    @ApiOperation(value = "Retrieves service specific metadata for a vRealize Orchestrator", tags={ "vRealizeOrchestrator",  })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = VROServiceInfo.class) })
    public VROServiceInfo getRegisteredVRO(@PathParam("id") String id);

    @PATCH
    @Path("/vro/servers/{id}")
    @Consumes({ "application/merge-patch+json", "application/json-patch+json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Updates service specific metadata for a vRealize Orchestrator", tags={ "vRealizeOrchestrator",  })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = VROServiceInfo.class) })
    public VROServiceInfo patchService(@Valid VROServiceInfo body, @PathParam("id") String id);

    @DELETE
    @Path("/vro/servers/{id}")
    @ApiOperation(value = "Unregisters a vRealize Orchestrator endpoint from vCloud Director", tags={ "vRealizeOrchestrator",  })
    @ApiResponses(value = { 
        @ApiResponse(code = 204, message = "No Content") })
    public void unregister(@PathParam("id") String id);

    @PUT
    @Path("/vro/servers/{id}")
    @Consumes({ "application/json" })
    @Produces({ "application/json" })
    @ApiOperation(value = "Updates service specific metadata for a vRealize Orchestrator", tags={ "vRealizeOrchestrator" })
    @ApiResponses(value = { 
        @ApiResponse(code = 200, message = "OK", response = VROServiceInfo.class) })
    public VROServiceInfo updateService(@Valid VROServiceInfo body, @PathParam("id") String id);
}