com.factset.sdk.PAEngine.api.ColumnStatisticsApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of paengine Show documentation

FactSet SDK for Java - paengine

There is a newer version: 3.1.1

package com.factset.sdk.PAEngine.api;

import com.factset.sdk.PAEngine.ApiException;
import com.factset.sdk.PAEngine.ApiClient;
import com.factset.sdk.PAEngine.ApiResponse;
import com.factset.sdk.PAEngine.Configuration;
import com.factset.sdk.PAEngine.Pair;

import jakarta.ws.rs.core.GenericType;
import java.util.HashMap;
import java.util.Map;
import java.util.Objects;

import com.factset.sdk.PAEngine.models.ColumnStatisticRoot;

@jakarta.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen")

public class ColumnStatisticsApi {
  private ApiClient apiClient;

  public ColumnStatisticsApi() {
    this(Configuration.getDefaultApiClient());
  }

  public ColumnStatisticsApi(ApiClient apiClient) {
    this.apiClient = apiClient;
  }
  
  private static final Map getPAColumnStatisticsResponseTypeMap = new HashMap();
  static {
    getPAColumnStatisticsResponseTypeMap.put(200, new GenericType(){});
  }

  


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

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

  /**
   * Get PA column statistics
   * This endpoint lists all the column statistics that can be applied to a PA column.
   * @return ColumnStatisticRoot
   * @throws ApiException if fails to make API call
   * @http.response.details
     
        Status Code  Description  Response Headers 
        200  Expected response, returns a list of PA column statistics   * 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 ColumnStatisticRoot getPAColumnStatistics() throws ApiException {
    return getPAColumnStatisticsWithHttpInfo().getData();
  }

  /**
   * Get PA column statistics
   * This endpoint lists all the column statistics that can be applied to a PA column.
   * @return ApiResponse<ColumnStatisticRoot>
   * @throws ApiException if fails to make API call
   * @http.response.details
     
        Status Code  Description  Response Headers 
        200  Expected response, returns a list of PA column statistics   * 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 getPAColumnStatisticsWithHttpInfo() throws ApiException {
    Object localVarPostBody = null;
    
    // create path and map variables
    String localVarPath = "/analytics/engines/pa/v3/columnstatistics";

    // 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[] { "FactSetApiKey", "FactSetOAuth2", "FactSetOAuth2Client" };


    ApiResponse<
        
        ColumnStatisticRoot
      
    > apiResponse = apiClient.invokeAPI("ColumnStatisticsApi.getPAColumnStatistics", localVarPath, "GET", localVarQueryParams, localVarPostBody,
                               localVarHeaderParams, localVarCookieParams, localVarFormParams, localVarAccept, localVarContentType,
                               localVarAuthNames, getPAColumnStatisticsResponseTypeMap, false);

    return apiResponse;

  }
}

Status Code	Description	Response Headers
200	Expected response, returns a list of PA column statistics	* 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.