Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
/*
* Vertex Platform API
* The Vertex distributed cloud rendering platform includes a set of APIs and SDKs, which together allow easily integrating 3D product data into your business application. See our [Developer Guides](https://developer.vertexvis.com/docs/guides/render-your-first-scene) to get started. Notes about the Postman collection and API Reference code samples, - They include all required and optional body parameters for completeness. Remove any optional parameters as desired. - They use auto-generated IDs and other values that may share the same value for ease of documentation only. In actual requests and responses, the IDs should uniquely identify their corresponding resource.
*
* The version of the OpenAPI document: 1.0
* Contact: [email protected]
*
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
* https://openapi-generator.tech
* Do not edit the class manually.
*/
package com.vertexvis.api;
import com.vertexvis.ApiCallback;
import com.vertexvis.ApiClient;
import com.vertexvis.ApiException;
import com.vertexvis.ApiResponse;
import com.vertexvis.Configuration;
import com.vertexvis.Pair;
import com.vertexvis.ProgressRequestBody;
import com.vertexvis.ProgressResponseBody;
import com.google.gson.reflect.TypeToken;
import java.io.IOException;
import com.vertexvis.model.CreateSceneRequest;
import com.vertexvis.model.Failure;
import java.io.File;
import com.vertexvis.model.QueuedJob;
import com.vertexvis.model.Scene;
import com.vertexvis.model.SceneList;
import java.util.UUID;
import com.vertexvis.model.UpdateSceneRequest;
import java.lang.reflect.Type;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
public class ScenesApi {
private ApiClient localVarApiClient;
public ScenesApi() {
this(Configuration.getDefaultApiClient());
}
public ScenesApi(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
public ApiClient getApiClient() {
return localVarApiClient;
}
public void setApiClient(ApiClient apiClient) {
this.localVarApiClient = apiClient;
}
/**
* Build call for createScene
* @param createSceneRequest (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
201
Created
* location -
400
Bad Request
-
401
Unauthorized
-
415
Unsupported Media Type
-
*/
public okhttp3.Call createSceneCall(CreateSceneRequest createSceneRequest, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = createSceneRequest;
// create path and map variables
String localVarPath = "/scenes";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/vnd.api+json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "POST", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call createSceneValidateBeforeCall(CreateSceneRequest createSceneRequest, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'createSceneRequest' is set
if (createSceneRequest == null) {
throw new ApiException("Missing the required parameter 'createSceneRequest' when calling createScene(Async)");
}
okhttp3.Call localVarCall = createSceneCall(createSceneRequest, _callback);
return localVarCall;
}
/**
*
* Create a `scene`. Once created, add scene items via the createSceneItem API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param createSceneRequest (required)
* @return Scene
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
201
Created
* location -
400
Bad Request
-
401
Unauthorized
-
415
Unsupported Media Type
-
*/
public Scene createScene(CreateSceneRequest createSceneRequest) throws ApiException {
ApiResponse localVarResp = createSceneWithHttpInfo(createSceneRequest);
return localVarResp.getData();
}
/**
*
* Create a `scene`. Once created, add scene items via the createSceneItem API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param createSceneRequest (required)
* @return ApiResponse<Scene>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
201
Created
* location -
400
Bad Request
-
401
Unauthorized
-
415
Unsupported Media Type
-
*/
public ApiResponse createSceneWithHttpInfo(CreateSceneRequest createSceneRequest) throws ApiException {
okhttp3.Call localVarCall = createSceneValidateBeforeCall(createSceneRequest, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Create a `scene`. Once created, add scene items via the createSceneItem API. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param createSceneRequest (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
201
Created
* location -
400
Bad Request
-
401
Unauthorized
-
415
Unsupported Media Type
-
*/
public okhttp3.Call createSceneAsync(CreateSceneRequest createSceneRequest, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = createSceneValidateBeforeCall(createSceneRequest, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for deleteScene
* @param id The `scene` ID. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call deleteSceneCall(UUID id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/scenes/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "DELETE", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call deleteSceneValidateBeforeCall(UUID id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling deleteScene(Async)");
}
okhttp3.Call localVarCall = deleteSceneCall(id, _callback);
return localVarCall;
}
/**
*
* Delete a `scene`.
* @param id The `scene` ID. (required)
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public void deleteScene(UUID id) throws ApiException {
deleteSceneWithHttpInfo(id);
}
/**
*
* Delete a `scene`.
* @param id The `scene` ID. (required)
* @return ApiResponse<Void>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse deleteSceneWithHttpInfo(UUID id) throws ApiException {
okhttp3.Call localVarCall = deleteSceneValidateBeforeCall(id, null);
return localVarApiClient.execute(localVarCall);
}
/**
* (asynchronously)
* Delete a `scene`.
* @param id The `scene` ID. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
204
No Content
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call deleteSceneAsync(UUID id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = deleteSceneValidateBeforeCall(id, _callback);
localVarApiClient.executeAsync(localVarCall, _callback);
return localVarCall;
}
/**
* Build call for getQueuedScene
* @param id The `scene` ID. (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
301
Moved Permanently
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getQueuedSceneCall(UUID id, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/queued-scenes/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getQueuedSceneValidateBeforeCall(UUID id, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getQueuedScene(Async)");
}
okhttp3.Call localVarCall = getQueuedSceneCall(id, _callback);
return localVarCall;
}
/**
*
* Get a `queued-scene`.
* @param id The `scene` ID. (required)
* @return QueuedJob
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
301
Moved Permanently
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public QueuedJob getQueuedScene(UUID id) throws ApiException {
ApiResponse localVarResp = getQueuedSceneWithHttpInfo(id);
return localVarResp.getData();
}
/**
*
* Get a `queued-scene`.
* @param id The `scene` ID. (required)
* @return ApiResponse<QueuedJob>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
301
Moved Permanently
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse getQueuedSceneWithHttpInfo(UUID id) throws ApiException {
okhttp3.Call localVarCall = getQueuedSceneValidateBeforeCall(id, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get a `queued-scene`.
* @param id The `scene` ID. (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
301
Moved Permanently
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getQueuedSceneAsync(UUID id, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getQueuedSceneValidateBeforeCall(id, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getScene
* @param id The `scene` ID. (required)
* @param fieldsScene Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` is only returned if explicitly requested. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getSceneCall(UUID id, String fieldsScene, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/scenes/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (fieldsScene != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("fields[scene]", fieldsScene));
}
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getSceneValidateBeforeCall(UUID id, String fieldsScene, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling getScene(Async)");
}
okhttp3.Call localVarCall = getSceneCall(id, fieldsScene, _callback);
return localVarCall;
}
/**
*
* Get a `scene` by ID.
* @param id The `scene` ID. (required)
* @param fieldsScene Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` is only returned if explicitly requested. (optional)
* @return Scene
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public Scene getScene(UUID id, String fieldsScene) throws ApiException {
ApiResponse localVarResp = getSceneWithHttpInfo(id, fieldsScene);
return localVarResp.getData();
}
/**
*
* Get a `scene` by ID.
* @param id The `scene` ID. (required)
* @param fieldsScene Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` is only returned if explicitly requested. (optional)
* @return ApiResponse<Scene>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse getSceneWithHttpInfo(UUID id, String fieldsScene) throws ApiException {
okhttp3.Call localVarCall = getSceneValidateBeforeCall(id, fieldsScene, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get a `scene` by ID.
* @param id The `scene` ID. (required)
* @param fieldsScene Comma-separated list of fields to return in response. An empty value returns no fields. `sceneItemCount` is only returned if explicitly requested. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getSceneAsync(UUID id, String fieldsScene, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getSceneValidateBeforeCall(id, fieldsScene, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for getScenes
* @param pageCursor The cursor for the next page of items. (optional)
* @param pageSize The number of items to return. (optional)
* @param filterName Comma-separated list of names to filter on. (optional)
* @param filterSuppliedId Comma-separated list of supplied IDs to filter on. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getScenesCall(String pageCursor, Integer pageSize, String filterName, String filterSuppliedId, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/scenes";
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (pageCursor != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page[cursor]", pageCursor));
}
if (pageSize != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("page[size]", pageSize));
}
if (filterName != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[name]", filterName));
}
if (filterSuppliedId != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("filter[suppliedId]", filterSuppliedId));
}
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call getScenesValidateBeforeCall(String pageCursor, Integer pageSize, String filterName, String filterSuppliedId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getScenesCall(pageCursor, pageSize, filterName, filterSuppliedId, _callback);
return localVarCall;
}
/**
*
* Get `scenes`.
* @param pageCursor The cursor for the next page of items. (optional)
* @param pageSize The number of items to return. (optional)
* @param filterName Comma-separated list of names to filter on. (optional)
* @param filterSuppliedId Comma-separated list of supplied IDs to filter on. (optional)
* @return SceneList
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
415
Unsupported Media Type
-
*/
public SceneList getScenes(String pageCursor, Integer pageSize, String filterName, String filterSuppliedId) throws ApiException {
ApiResponse localVarResp = getScenesWithHttpInfo(pageCursor, pageSize, filterName, filterSuppliedId);
return localVarResp.getData();
}
/**
*
* Get `scenes`.
* @param pageCursor The cursor for the next page of items. (optional)
* @param pageSize The number of items to return. (optional)
* @param filterName Comma-separated list of names to filter on. (optional)
* @param filterSuppliedId Comma-separated list of supplied IDs to filter on. (optional)
* @return ApiResponse<SceneList>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
415
Unsupported Media Type
-
*/
public ApiResponse getScenesWithHttpInfo(String pageCursor, Integer pageSize, String filterName, String filterSuppliedId) throws ApiException {
okhttp3.Call localVarCall = getScenesValidateBeforeCall(pageCursor, pageSize, filterName, filterSuppliedId, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get `scenes`.
* @param pageCursor The cursor for the next page of items. (optional)
* @param pageSize The number of items to return. (optional)
* @param filterName Comma-separated list of names to filter on. (optional)
* @param filterSuppliedId Comma-separated list of supplied IDs to filter on. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
415
Unsupported Media Type
-
*/
public okhttp3.Call getScenesAsync(String pageCursor, Integer pageSize, String filterName, String filterSuppliedId, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = getScenesValidateBeforeCall(pageCursor, pageSize, filterName, filterSuppliedId, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for renderScene
* @param id The `scene` ID. (required)
* @param height The height of the image to render. (optional)
* @param width The width of the image to render. (optional)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
504
GatewayTimeout
-
*/
public okhttp3.Call renderSceneCall(UUID id, Integer height, Integer width, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = null;
// create path and map variables
String localVarPath = "/scenes/{id}/image"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
if (height != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("height", height));
}
if (width != null) {
localVarQueryParams.addAll(localVarApiClient.parameterToPair("width", width));
}
final String[] localVarAccepts = {
"image/jpeg", "image/png", "application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "GET", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call renderSceneValidateBeforeCall(UUID id, Integer height, Integer width, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling renderScene(Async)");
}
okhttp3.Call localVarCall = renderSceneCall(id, height, width, _callback);
return localVarCall;
}
/**
*
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
* @param id The `scene` ID. (required)
* @param height The height of the image to render. (optional)
* @param width The width of the image to render. (optional)
* @return File
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
504
GatewayTimeout
-
*/
public File renderScene(UUID id, Integer height, Integer width) throws ApiException {
ApiResponse localVarResp = renderSceneWithHttpInfo(id, height, width);
return localVarResp.getData();
}
/**
*
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
* @param id The `scene` ID. (required)
* @param height The height of the image to render. (optional)
* @param width The width of the image to render. (optional)
* @return ApiResponse<File>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
504
GatewayTimeout
-
*/
public ApiResponse renderSceneWithHttpInfo(UUID id, Integer height, Integer width) throws ApiException {
okhttp3.Call localVarCall = renderSceneValidateBeforeCall(id, height, width, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Get a rendered image of a `scene`. If only a single pixel is returned, ensure the `scene` is in the `commit` state and contains scene items.
* @param id The `scene` ID. (required)
* @param height The height of the image to render. (optional)
* @param width The width of the image to render. (optional)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
504
GatewayTimeout
-
*/
public okhttp3.Call renderSceneAsync(UUID id, Integer height, Integer width, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = renderSceneValidateBeforeCall(id, height, width, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
/**
* Build call for updateScene
* @param id The `scene` ID. (required)
* @param updateSceneRequest (required)
* @param _callback Callback for upload/download progress
* @return Call to execute
* @throws ApiException If fail to serialize the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call updateSceneCall(UUID id, UpdateSceneRequest updateSceneRequest, final ApiCallback _callback) throws ApiException {
Object localVarPostBody = updateSceneRequest;
// create path and map variables
String localVarPath = "/scenes/{id}"
.replaceAll("\\{" + "id" + "\\}", localVarApiClient.escapeString(id.toString()));
List localVarQueryParams = new ArrayList();
List localVarCollectionQueryParams = new ArrayList();
Map localVarHeaderParams = new HashMap();
Map localVarCookieParams = new HashMap();
Map localVarFormParams = new HashMap();
final String[] localVarAccepts = {
"application/vnd.api+json"
};
final String localVarAccept = localVarApiClient.selectHeaderAccept(localVarAccepts);
if (localVarAccept != null) {
localVarHeaderParams.put("Accept", localVarAccept);
}
final String[] localVarContentTypes = {
"application/vnd.api+json"
};
final String localVarContentType = localVarApiClient.selectHeaderContentType(localVarContentTypes);
localVarHeaderParams.put("Content-Type", localVarContentType);
String[] localVarAuthNames = new String[] { "OAuth2" };
return localVarApiClient.buildCall(localVarPath, "PATCH", localVarQueryParams, localVarCollectionQueryParams, localVarPostBody, localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAuthNames, _callback);
}
@SuppressWarnings("rawtypes")
private okhttp3.Call updateSceneValidateBeforeCall(UUID id, UpdateSceneRequest updateSceneRequest, final ApiCallback _callback) throws ApiException {
// verify the required parameter 'id' is set
if (id == null) {
throw new ApiException("Missing the required parameter 'id' when calling updateScene(Async)");
}
// verify the required parameter 'updateSceneRequest' is set
if (updateSceneRequest == null) {
throw new ApiException("Missing the required parameter 'updateSceneRequest' when calling updateScene(Async)");
}
okhttp3.Call localVarCall = updateSceneCall(id, updateSceneRequest, _callback);
return localVarCall;
}
/**
*
* Update a `scene` camera and/or state. Once updated, view the scene via the renderScene API or with the Viewer SDK. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `scene` ID. (required)
* @param updateSceneRequest (required)
* @return Scene
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public Scene updateScene(UUID id, UpdateSceneRequest updateSceneRequest) throws ApiException {
ApiResponse localVarResp = updateSceneWithHttpInfo(id, updateSceneRequest);
return localVarResp.getData();
}
/**
*
* Update a `scene` camera and/or state. Once updated, view the scene via the renderScene API or with the Viewer SDK. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `scene` ID. (required)
* @param updateSceneRequest (required)
* @return ApiResponse<Scene>
* @throws ApiException If fail to call the API, e.g. server error or cannot deserialize the response body
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public ApiResponse updateSceneWithHttpInfo(UUID id, UpdateSceneRequest updateSceneRequest) throws ApiException {
okhttp3.Call localVarCall = updateSceneValidateBeforeCall(id, updateSceneRequest, null);
Type localVarReturnType = new TypeToken(){}.getType();
return localVarApiClient.execute(localVarCall, localVarReturnType);
}
/**
* (asynchronously)
* Update a `scene` camera and/or state. Once updated, view the scene via the renderScene API or with the Viewer SDK. For details, see our [Render static scenes](https://developer.vertexvis.com/docs/guides/render-static-scenes) guide.
* @param id The `scene` ID. (required)
* @param updateSceneRequest (required)
* @param _callback The callback to be executed when the API call finishes
* @return The request call
* @throws ApiException If fail to process the API call, e.g. serializing the request body object
* @http.response.details
Status Code
Description
Response Headers
200
OK
-
400
Bad Request
-
401
Unauthorized
-
404
Not Found
-
415
Unsupported Media Type
-
*/
public okhttp3.Call updateSceneAsync(UUID id, UpdateSceneRequest updateSceneRequest, final ApiCallback _callback) throws ApiException {
okhttp3.Call localVarCall = updateSceneValidateBeforeCall(id, updateSceneRequest, _callback);
Type localVarReturnType = new TypeToken(){}.getType();
localVarApiClient.executeAsync(localVarCall, localVarReturnType, _callback);
return localVarCall;
}
}
