• Home
• com.factset.analyticsapi
• engines-sdk
• 5.2.1
• source code
• ConfigurationsApi.java

×

Project download

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.

factset.analyticsapi.engines.api.ConfigurationsApi Maven / Gradle / Ivy

package factset.analyticsapi.engines.api;

import factset.analyticsapi.engines.ApiException;
import factset.analyticsapi.engines.ApiClient;
import factset.analyticsapi.engines.ApiResponse;
import factset.analyticsapi.engines.Configuration;
import factset.analyticsapi.engines.Pair;

import javax.ws.rs.core.GenericType;

import java.util.HashMap;
import java.util.Map;

import java.io.File;

import factset.analyticsapi.engines.models.ClientErrorResponse;
import factset.analyticsapi.engines.models.VaultConfigurationRoot;
import factset.analyticsapi.engines.models.VaultConfigurationSummaryRoot;

@javax.annotation.Generated(value = "CustomJavaClientCodegen")
public class ConfigurationsApi {
  private ApiClient apiClient;
  public ConfigurationsApi() {
    this(Configuration.getDefaultApiClient());
  }

  public ConfigurationsApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }

  /**
   * Get the API cilent
   *
   * @return API client
   */
  public ApiClient getApiClient() {
    return apiClient;
  }

  /**
   * Set the API cilent
   *
   * @param apiClient an instance of API client
   */
  public void setApiClient(ApiClient apiClient) {
    this.apiClient = apiClient;
  }

  /**
   * Get Vault configuration by id
   * This endpoint returns details for a Vault configuration as well as a list of accounts it is used in.
   * @param id Vault configuration id to get the details of (required)
    @return VaultConfigurationRoot
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Expected response, returns details for a Vault configuration. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 400 
 Invalid vault configuration code. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 404 
 Vault configuration id not found. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 401 
 Missing or invalid authentication. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 403 
 User is forbidden with current credentials 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 406 
 Unsupported Accept header. Header needs to be set to application/json. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 429 
 Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. 
  
       
 500 
 Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 503 
 Request timed out. Retry the request in sometime. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
     
   */
 public VaultConfigurationRoot getVaultConfigurationById(String id) throws ApiException {
    return getVaultConfigurationByIdWithHttpInfo(id).getData();
  }

  /**
   * Get Vault configuration by id
   * This endpoint returns details for a Vault configuration as well as a list of accounts it is used in.
   * @param id Vault configuration id to get the details of (required)
    * @return ApiResponse<VaultConfigurationRoot>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Expected response, returns details for a Vault configuration. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 400 
 Invalid vault configuration code. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 404 
 Vault configuration id not found. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 401 
 Missing or invalid authentication. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 403 
 User is forbidden with current credentials 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 406 
 Unsupported Accept header. Header needs to be set to application/json. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 429 
 Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. 
  
       
 500 
 Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 503 
 Request timed out. Retry the request in sometime. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
     
   */
  public ApiResponse getVaultConfigurationByIdWithHttpInfo(String id) throws ApiException {
    Object localVarPostBody = null;
    
    // verify the required parameter 'id' is set
    if (id == null) {
      throw new ApiException(400, "Missing the required parameter 'id' when calling getVaultConfigurationById");
    }
    
    // create path and map variables
    String localVarPath = "/analytics/engines/vault/v3/configurations/{id}"
      .replaceAll("\\{" + "id" + "\\}", apiClient.escapeString(id.toString()));

    // query params
    java.util.List localVarQueryParams = new java.util.ArrayList();
    java.util.Map localVarHeaderParams = new java.util.HashMap();
    java.util.Map localVarCookieParams = new java.util.HashMap();
    java.util.Map localVarFormParams = new java.util.HashMap();


    
    
    
    final String[] localVarAccepts = {
      "application/json"
    };
    final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);

    final String[] localVarContentTypes = {
      
    };
    final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

    String[] localVarAuthNames = new String[] { "Basic", "Bearer" };

    GenericType localVarReturnType = new GenericType() {};

      Map returnTypeMap = new HashMap();
        returnTypeMap.put(200, new GenericType(){});
        returnTypeMap.put(400, new GenericType(){});
        returnTypeMap.put(404, new GenericType(){});
	
      return apiClient.invokeAPIWithReturnMap("ConfigurationsApi.getVaultConfigurationById", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, returnTypeMap, false);
  }
  /**
   * Get Vault configurations
   * This endpoint returns all the Vault configurations saved in the provided account.
   * @param account Required account query parameter to filter configurations for a specific account (required)
    @return VaultConfigurationSummaryRoot
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Expected response, returns a dictionary of Vault configurations. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 400 
 Invalid account. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 404 
 Account not found. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 401 
 Missing or invalid authentication. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 403 
 User is forbidden with current credentials 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 406 
 Unsupported Accept header. Header needs to be set to application/json. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 429 
 Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. 
  
       
 500 
 Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 503 
 Request timed out. Retry the request in sometime. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
     
   */
 public VaultConfigurationSummaryRoot getVaultConfigurations(String account) throws ApiException {
    return getVaultConfigurationsWithHttpInfo(account).getData();
  }

  /**
   * Get Vault configurations
   * This endpoint returns all the Vault configurations saved in the provided account.
   * @param account Required account query parameter to filter configurations for a specific account (required)
    * @return ApiResponse<VaultConfigurationSummaryRoot>
   * @throws ApiException if fails to make API call
   * @http.response.details
     

       
 Status Code 
 Description 
 Response Headers 
       
 200 
 Expected response, returns a dictionary of Vault configurations. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 400 
 Invalid account. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 404 
 Account not found. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 401 
 Missing or invalid authentication. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 403 
 User is forbidden with current credentials 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 406 
 Unsupported Accept header. Header needs to be set to application/json. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * X-FactSet-Api-RateLimit-Limit - Number of allowed requests for the time window. 
  * X-FactSet-Api-RateLimit-Remaining - Number of requests left for the time window. 
  * X-FactSet-Api-RateLimit-Reset - Number of seconds remaining till rate limit resets. 
  
       
 429 
 Rate limit reached. Wait till the time specified in Retry-After header value to make further requests. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  * Retry-After - Time to wait in seconds before making a new request as the rate limit has reached. 
  
       
 500 
 Server error. Log the X-DataDirect-Request-Key header to assist in troubleshooting. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
       
 503 
 Request timed out. Retry the request in sometime. 
  * X-DataDirect-Request-Key - FactSet's request key header. 
  * X-FactSet-Api-Request-Key - Key to uniquely identify an Analytics API request. Only available after successful authentication. 
  
     
   */
  public ApiResponse getVaultConfigurationsWithHttpInfo(String account) throws ApiException {
    Object localVarPostBody = null;
    
    // verify the required parameter 'account' is set
    if (account == null) {
      throw new ApiException(400, "Missing the required parameter 'account' when calling getVaultConfigurations");
    }
    
    // create path and map variables
    String localVarPath = "/analytics/engines/vault/v3/configurations";

    // query params
    java.util.List localVarQueryParams = new java.util.ArrayList();
    java.util.Map localVarHeaderParams = new java.util.HashMap();
    java.util.Map localVarCookieParams = new java.util.HashMap();
    java.util.Map localVarFormParams = new java.util.HashMap();

    localVarQueryParams.addAll(apiClient.parameterToPairs("", "account", account));

    
    
    
    final String[] localVarAccepts = {
      "application/json"
    };
    final String localVarAccept = apiClient.selectHeaderAccept(localVarAccepts);

    final String[] localVarContentTypes = {
      
    };
    final String localVarContentType = apiClient.selectHeaderContentType(localVarContentTypes);

    String[] localVarAuthNames = new String[] { "Basic", "Bearer" };

    GenericType localVarReturnType = new GenericType() {};

      Map returnTypeMap = new HashMap();
        returnTypeMap.put(200, new GenericType(){});
        returnTypeMap.put(400, new GenericType(){});
        returnTypeMap.put(404, new GenericType(){});
	
      return apiClient.invokeAPIWithReturnMap("ConfigurationsApi.getVaultConfigurations", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, returnTypeMap, false);
  }
}