# OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**getGraphInfo**](InspectionApi.md#getGraphInfo) | **GET** /control/v1/graphs/x-graph-name | Get details about a graph
[**getGraphInfos**](InspectionApi.md#getGraphInfos) | **GET** /control/v1/graphs | Get a list of graphs
[**getMemoryInfo**](InspectionApi.md#getMemoryInfo) | **GET** /control/v1/memoryInfo | Get the memory info
[**getPgxConfig**](InspectionApi.md#getPgxConfig) | **GET** /control/v1/pgxConfig | Get PGX configuration
[**getServerState**](InspectionApi.md#getServerState) | **GET** /control/v1/serverState | Get the current server state
[**getSessionBoundGraphInfo**](InspectionApi.md#getSessionBoundGraphInfo) | **GET** /control/v1/sessions/x-session-id/graphs/x-graph-name | Get details of a session-bound, private graph
[**getSessionInfo**](InspectionApi.md#getSessionInfo) | **GET** /control/v1/sessions/x-session-id | Get the session info
[**getSessionInfos**](InspectionApi.md#getSessionInfos) | **GET** /control/v1/sessions | List active sessions
[**getThreadPoolInfo**](InspectionApi.md#getThreadPoolInfo) | **POST** /control/v1/threadPool/lookup | Get the thread pool info

<a name="getGraphInfo"></a>
# **getGraphInfo**
> GraphInfo getGraphInfo(xGraphName)

Get details about a graph

Get details about a graph. Deprecated since 2.7.0. Call /control/v1/serverState instead.

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
let xGraphName = "xGraphName_example"; // String | The global name of the graph

apiInstance.getGraphInfo(xGraphName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xGraphName** | **String**| The global name of the graph | 

### Return type

[**GraphInfo**](GraphInfo.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getGraphInfos"></a>
# **getGraphInfos**
> [GraphInfo] getGraphInfos()

Get a list of graphs

Get a list of currently active graphs. Deprecated since 2.7.0. Call /control/v1/serverState instead.

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
apiInstance.getGraphInfos((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**[GraphInfo]**](GraphInfo.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getMemoryInfo"></a>
# **getMemoryInfo**
> MemoryInfo getMemoryInfo()

Get the memory info

this endpoint is deprecated since PGX 2.7.0. Call /control/v1/serverState instead

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
apiInstance.getMemoryInfo((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**MemoryInfo**](MemoryInfo.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getPgxConfig"></a>
# **getPgxConfig**
> PgxConfig getPgxConfig()

Get PGX configuration

Gets the current PGX server configuration

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
apiInstance.getPgxConfig((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**PgxConfig**](PgxConfig.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getServerState"></a>
# **getServerState**
> JsonNode getServerState(opts)

Get the current server state

Gets the state of this PGX server instance.

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
let opts = { 
  'prefer': "prefer_example" // String | 
};
apiInstance.getServerState(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **prefer** | **String**|  | [optional] 

### Return type

[**JsonNode**](JsonNode.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getSessionBoundGraphInfo"></a>
# **getSessionBoundGraphInfo**
> GraphInfo getSessionBoundGraphInfo(xGraphName, opts)

Get details of a session-bound, private graph

this endpoint is deprecated. Call /control/v1/serverState instead

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
let xGraphName = "xGraphName_example"; // String | the name of the graph
let opts = { 
  'xSessionId': "xSessionId_example" // String | 
};
apiInstance.getSessionBoundGraphInfo(xGraphName, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xGraphName** | **String**| the name of the graph | 
 **xSessionId** | **String**|  | [optional] 

### Return type

[**GraphInfo**](GraphInfo.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getSessionInfo"></a>
# **getSessionInfo**
> SessionInfo getSessionInfo(opts)

Get the session info

this endpoint is deprecated. Call /control/v1/serverState instead

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
let opts = { 
  'xSessionId': "xSessionId_example" // String | 
};
apiInstance.getSessionInfo(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **xSessionId** | **String**|  | [optional] 

### Return type

[**SessionInfo**](SessionInfo.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getSessionInfos"></a>
# **getSessionInfos**
> [SessionInfo] getSessionInfos()

List active sessions

this endpoint is deprecated. Call /control/v1/serverState instead

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
apiInstance.getSessionInfos((error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters
This endpoint does not need any parameter.

### Return type

[**[SessionInfo]**](SessionInfo.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getThreadPoolInfo"></a>
# **getThreadPoolInfo**
> PoolInfo getThreadPoolInfo(body)

Get the thread pool info

this endpoint is deprecated. Call /control/v1/serverState instead

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.InspectionApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.PoolRequest(); // PoolRequest | Holds the parameters needed for a pool request.

apiInstance.getThreadPoolInfo(body, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**PoolRequest**](PoolRequest.md)| Holds the parameters needed for a pool request. | 

### Return type

[**PoolInfo**](PoolInfo.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json