# OracleLabsParallelGraphAnalyticsPgxRestApi.MapProxiesApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**containsKey**](MapProxiesApi.md#containsKey) | **GET** /core/v1/mapProxies/x-proxy-id/keys/x-map-key | Get the information about a key in the map
[**createMapProxy**](MapProxiesApi.md#createMapProxy) | **POST** /core/v1/mapProxies | Create a map proxy
[**getEntrySet**](MapProxiesApi.md#getEntrySet) | **GET** /core/v1/mapProxies/x-proxy-id/entries | Get list of entries
[**getKeySet**](MapProxiesApi.md#getKeySet) | **GET** /core/v1/mapProxies/x-proxy-id/keys | Get the keys of the map
[**getValueForKey**](MapProxiesApi.md#getValueForKey) | **GET** /core/v1/mapProxies/x-proxy-id/keys/x-map-key/value | Get the value associated with the key

<a name="containsKey"></a>
# **containsKey**
> KeyWrapper containsKey(SID, xProxyId, xMapKey)

Get the information about a key in the map

Can be used to check whether the map behind this map proxy contains a specific key.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MapProxiesApi();
let SID = "SID_example"; // String | session id
let xProxyId = "xProxyId_example"; // String | Specifies the proxy. You can get this ID by requesting a map proxy from the core endpoint.
let xMapKey = "xMapKey_example"; // String | Json seralized object representing the key

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session id | 
 **xProxyId** | **String**| Specifies the proxy. You can get this ID by requesting a map proxy from the core endpoint. | 
 **xMapKey** | **String**| Json seralized object representing the key | 

### Return type

[**KeyWrapper**](KeyWrapper.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="createMapProxy"></a>
# **createMapProxy**
> MapProxyResponse createMapProxy(body, SID)

Create a map proxy

The map proxy allows you to access the elements of a map

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MapProxiesApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreateMapProxyRequest(); // CreateMapProxyRequest | The request body contains details for creating the map proxy.
let SID = "SID_example"; // String | session id

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

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateMapProxyRequest**](CreateMapProxyRequest.md)| The request body contains details for creating the map proxy. | 
 **SID** | **String**| session id | 

### Return type

[**MapProxyResponse**](MapProxyResponse.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getEntrySet"></a>
# **getEntrySet**
> ValueWrapper getEntrySet(SID, xProxyId, start, size)

Get list of entries

This allows you to access the entry set of this map in a paginated way. It will give you an array of objects containing both a &#x27;key&#x27; and a &#x27;value&#x27; field.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MapProxiesApi();
let SID = "SID_example"; // String | session id
let xProxyId = "xProxyId_example"; // String | Specifies the proxy. You can get this ID by requesting a map proxy from the core endpoint.
let start = 56; // Number | Parameter that specifies an offset for the list of items
let size = 56; // Number | Parameter that specifies the size of the list.

apiInstance.getEntrySet(SID, xProxyId, start, size, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session id | 
 **xProxyId** | **String**| Specifies the proxy. You can get this ID by requesting a map proxy from the core endpoint. | 
 **start** | **Number**| Parameter that specifies an offset for the list of items | 
 **size** | **Number**| Parameter that specifies the size of the list. | 

### Return type

[**ValueWrapper**](ValueWrapper.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getKeySet"></a>
# **getKeySet**
> [KeyWrapper] getKeySet(SID, xProxyId, start, size)

Get the keys of the map

This allows you to access the key set of this map in a paginated way. This only returns the keys of the map.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MapProxiesApi();
let SID = "SID_example"; // String | session id
let xProxyId = "xProxyId_example"; // String | Specifies the proxy. You can get this ID by requesting a map proxy from the core endpoint.
let start = 56; // Number | Parameter that specifies an offset for the list of items
let size = 56; // Number | Parameter that specifies the size of the list.

apiInstance.getKeySet(SID, xProxyId, start, size, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session id | 
 **xProxyId** | **String**| Specifies the proxy. You can get this ID by requesting a map proxy from the core endpoint. | 
 **start** | **Number**| Parameter that specifies an offset for the list of items | 
 **size** | **Number**| Parameter that specifies the size of the list. | 

### Return type

[**[KeyWrapper]**](KeyWrapper.md)

### Authorization

No authorization required

### HTTP request headers

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

<a name="getValueForKey"></a>
# **getValueForKey**
> ValueWrapper getValueForKey(SID, xProxyId, xMapKey, opts)

Get the value associated with the key

The type of the key is specified when you create the map and will be part of the response from the core endpoint when you request the map proxy.

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

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MapProxiesApi();
let SID = "SID_example"; // String | session id
let xProxyId = "xProxyId_example"; // String | Specifies the proxy. You can get this ID by requesting a map proxy from the core endpoint.
let xMapKey = "xMapKey_example"; // String | Json seralized object representing the key
let opts = { 
  'strkey': "strkey_example" // String | 
};
apiInstance.getValueForKey(SID, xProxyId, xMapKey, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session id | 
 **xProxyId** | **String**| Specifies the proxy. You can get this ID by requesting a map proxy from the core endpoint. | 
 **xMapKey** | **String**| Json seralized object representing the key | 
 **strkey** | **String**|  | [optional] 

### Return type

[**ValueWrapper**](ValueWrapper.md)

### Authorization

No authorization required

### HTTP request headers

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