78 lines
2.6 KiB
Markdown
78 lines
2.6 KiB
Markdown
# jfjoch_client.JfjochBrokerApi
|
|
|
|
All URIs are relative to *http://localhost:5232*
|
|
|
|
Method | HTTP request | Description
|
|
------------- | ------------- | -------------
|
|
[**config_zeromq_metadata_put**](JfjochBrokerApi.md#config_zeromq_metadata_put) | **PUT** /config/zeromq_metadata | Set ZeroMQ metadata settings
|
|
|
|
|
|
# **config_zeromq_metadata_put**
|
|
> config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)
|
|
|
|
Set ZeroMQ metadata settings
|
|
|
|
Jungfraujoch can generate metadata message stream on ZeroMQ PUB socket. This stream covers all images. Here settings of the socket can be adjusted. While the data structure contains also socket_address, this cannot be changed via HTTP and is ignore in PUT request.
|
|
|
|
### Example
|
|
|
|
|
|
```python
|
|
import jfjoch_client
|
|
from jfjoch_client.models.zeromq_metadata_settings import ZeromqMetadataSettings
|
|
from jfjoch_client.rest import ApiException
|
|
from pprint import pprint
|
|
|
|
# Defining the host is optional and defaults to http://localhost:5232
|
|
# See configuration.py for a list of all supported configuration parameters.
|
|
configuration = jfjoch_client.Configuration(
|
|
host = "http://localhost:5232"
|
|
)
|
|
|
|
|
|
# Enter a context with an instance of the API client
|
|
with jfjoch_client.ApiClient(configuration) as api_client:
|
|
# Create an instance of the API class
|
|
api_instance = jfjoch_client.JfjochBrokerApi(api_client)
|
|
zeromq_metadata_settings = jfjoch_client.ZeromqMetadataSettings() # ZeromqMetadataSettings | (optional)
|
|
|
|
try:
|
|
# Set ZeroMQ metadata settings
|
|
api_instance.config_zeromq_metadata_put(zeromq_metadata_settings=zeromq_metadata_settings)
|
|
except Exception as e:
|
|
print("Exception when calling JfjochBrokerApi->config_zeromq_metadata_put: %s\n" % e)
|
|
```
|
|
|
|
|
|
|
|
### Parameters
|
|
|
|
|
|
Name | Type | Description | Notes
|
|
------------- | ------------- | ------------- | -------------
|
|
**zeromq_metadata_settings** | [**ZeromqMetadataSettings**](ZeromqMetadataSettings.md)| | [optional]
|
|
|
|
### Return type
|
|
|
|
void (empty response body)
|
|
|
|
### Authorization
|
|
|
|
No authorization required
|
|
|
|
### HTTP request headers
|
|
|
|
- **Content-Type**: application/json
|
|
- **Accept**: text/plain, application/json
|
|
|
|
### HTTP response details
|
|
|
|
| Status code | Description | Response headers |
|
|
|-------------|-------------|------------------|
|
|
**200** | Everything OK | - |
|
|
**400** | Input parsing or validation error | - |
|
|
**500** | Error within Jungfraujoch code - see output message. | - |
|
|
|
|
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
|