public class ModelsApi
extends java.lang.Object
| Constructor and Description |
|---|
ModelsApi() |
ModelsApi(ApiClient apiClient) |
| Modifier and Type | Method and Description |
|---|---|
ModelMetadata |
createModel(java.lang.String orgId,
java.lang.String modelName,
TimePeriod timePeriod,
ModelType modelType)
Create a model with a given name and a time period
Create a model
|
okhttp3.Call |
createModelAsync(java.lang.String orgId,
java.lang.String modelName,
TimePeriod timePeriod,
ModelType modelType,
ApiCallback<ModelMetadata> _callback)
Create a model with a given name and a time period (asynchronously)
Create a model
|
okhttp3.Call |
createModelCall(java.lang.String orgId,
java.lang.String modelName,
TimePeriod timePeriod,
ModelType modelType,
ApiCallback _callback)
Build call for createModel
|
ApiResponse<ModelMetadata> |
createModelWithHttpInfo(java.lang.String orgId,
java.lang.String modelName,
TimePeriod timePeriod,
ModelType modelType)
Create a model with a given name and a time period
Create a model
|
ApiClient |
getApiClient() |
ModelMetadata |
getModel(java.lang.String orgId,
java.lang.String modelId)
Get a model metadata
Returns various metadata about a model
|
okhttp3.Call |
getModelAsync(java.lang.String orgId,
java.lang.String modelId,
ApiCallback<ModelMetadata> _callback)
Get a model metadata (asynchronously)
Returns various metadata about a model
|
okhttp3.Call |
getModelCall(java.lang.String orgId,
java.lang.String modelId,
ApiCallback _callback)
Build call for getModel
|
ApiResponse<ModelMetadata> |
getModelWithHttpInfo(java.lang.String orgId,
java.lang.String modelId)
Get a model metadata
Returns various metadata about a model
|
ListModelsResponse |
listModels(java.lang.String orgId)
Get a list of all of the model ids for an organization.
|
okhttp3.Call |
listModelsAsync(java.lang.String orgId,
ApiCallback<ListModelsResponse> _callback)
Get a list of all of the model ids for an organization.
|
okhttp3.Call |
listModelsCall(java.lang.String orgId,
ApiCallback _callback)
Build call for listModels
|
ApiResponse<ListModelsResponse> |
listModelsWithHttpInfo(java.lang.String orgId)
Get a list of all of the model ids for an organization.
|
ListSegmentsResponse |
listSegments(java.lang.String orgId,
java.lang.String modelId)
Get a model metadata
Returns the list of Segments for a given model
|
okhttp3.Call |
listSegmentsAsync(java.lang.String orgId,
java.lang.String modelId,
ApiCallback<ListSegmentsResponse> _callback)
Get a model metadata (asynchronously)
Returns the list of Segments for a given model
|
okhttp3.Call |
listSegmentsCall(java.lang.String orgId,
java.lang.String modelId,
ApiCallback _callback)
Build call for listSegments
|
ApiResponse<ListSegmentsResponse> |
listSegmentsWithHttpInfo(java.lang.String orgId,
java.lang.String modelId)
Get a model metadata
Returns the list of Segments for a given model
|
void |
setApiClient(ApiClient apiClient) |
public ModelsApi()
public ModelsApi(ApiClient apiClient)
public ApiClient getApiClient()
public void setApiClient(ApiClient apiClient)
public okhttp3.Call createModelCall(java.lang.String orgId,
java.lang.String modelName,
TimePeriod timePeriod,
ModelType modelType,
ApiCallback _callback)
throws ApiException
orgId - The organization ID (required)modelName - The name of a model (required)timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)modelType - The [ModelType] of the dataset (optional)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 0 | The model summary if succeeds | - |
public ModelMetadata createModel(java.lang.String orgId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType) throws ApiException
orgId - The organization ID (required)modelName - The name of a model (required)timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)modelType - The [ModelType] of the dataset (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 0 | The model summary if succeeds | - |
public ApiResponse<ModelMetadata> createModelWithHttpInfo(java.lang.String orgId, java.lang.String modelName, TimePeriod timePeriod, ModelType modelType) throws ApiException
orgId - The organization ID (required)modelName - The name of a model (required)timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)modelType - The [ModelType] of the dataset (optional)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 0 | The model summary if succeeds | - |
public okhttp3.Call createModelAsync(java.lang.String orgId,
java.lang.String modelName,
TimePeriod timePeriod,
ModelType modelType,
ApiCallback<ModelMetadata> _callback)
throws ApiException
orgId - The organization ID (required)modelName - The name of a model (required)timePeriod - The [TimePeriod] for data aggregation/alerting for a model (required)modelType - The [ModelType] of the dataset (optional)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 0 | The model summary if succeeds | - |
public okhttp3.Call getModelCall(java.lang.String orgId,
java.lang.String modelId,
ApiCallback _callback)
throws ApiException
orgId - The name of an organization (required)modelId - The ID of a model (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 0 | A [ModelMetadata] object if succeeds | - |
public ModelMetadata getModel(java.lang.String orgId, java.lang.String modelId) throws ApiException
orgId - The name of an organization (required)modelId - The ID of a model (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 0 | A [ModelMetadata] object if succeeds | - |
public ApiResponse<ModelMetadata> getModelWithHttpInfo(java.lang.String orgId, java.lang.String modelId) throws ApiException
orgId - The name of an organization (required)modelId - The ID of a model (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 0 | A [ModelMetadata] object if succeeds | - |
public okhttp3.Call getModelAsync(java.lang.String orgId,
java.lang.String modelId,
ApiCallback<ModelMetadata> _callback)
throws ApiException
orgId - The name of an organization (required)modelId - The ID of a model (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 0 | A [ModelMetadata] object if succeeds | - |
public okhttp3.Call listModelsCall(java.lang.String orgId,
ApiCallback _callback)
throws ApiException
orgId - Your company's unique organization ID (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 0 | A list of model summary items | - |
public ListModelsResponse listModels(java.lang.String orgId) throws ApiException
orgId - Your company's unique organization ID (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 0 | A list of model summary items | - |
public ApiResponse<ListModelsResponse> listModelsWithHttpInfo(java.lang.String orgId) throws ApiException
orgId - Your company's unique organization ID (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 0 | A list of model summary items | - |
public okhttp3.Call listModelsAsync(java.lang.String orgId,
ApiCallback<ListModelsResponse> _callback)
throws ApiException
orgId - Your company's unique organization ID (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 0 | A list of model summary items | - |
public okhttp3.Call listSegmentsCall(java.lang.String orgId,
java.lang.String modelId,
ApiCallback _callback)
throws ApiException
orgId - The name of an organization (required)modelId - The ID of a model (required)_callback - Callback for upload/download progressApiException - If fail to serialize the request body object| Status Code | Description | Response Headers |
| 0 | A [ListSegmentsResponse] object if succeeds | - |
public ListSegmentsResponse listSegments(java.lang.String orgId, java.lang.String modelId) throws ApiException
orgId - The name of an organization (required)modelId - The ID of a model (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 0 | A [ListSegmentsResponse] object if succeeds | - |
public ApiResponse<ListSegmentsResponse> listSegmentsWithHttpInfo(java.lang.String orgId, java.lang.String modelId) throws ApiException
orgId - The name of an organization (required)modelId - The ID of a model (required)ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body| Status Code | Description | Response Headers |
| 0 | A [ListSegmentsResponse] object if succeeds | - |
public okhttp3.Call listSegmentsAsync(java.lang.String orgId,
java.lang.String modelId,
ApiCallback<ListSegmentsResponse> _callback)
throws ApiException
orgId - The name of an organization (required)modelId - The ID of a model (required)_callback - The callback to be executed when the API call finishesApiException - If fail to process the API call, e.g. serializing the request body object| Status Code | Description | Response Headers |
| 0 | A [ListSegmentsResponse] object if succeeds | - |