Skip to content

BrokersApi.md

Latest commit

 

History

History
407 lines (269 loc) · 11.8 KB

BrokersApi.md

File metadata and controls

407 lines (269 loc) · 11.8 KB

cyperf.BrokersApi

All URIs are relative to http://localhost

Method HTTP request Description
create_brokers POST /api/v2/brokers
delete_broker DELETE /api/v2/brokers/{brokerId}
get_broker_by_id GET /api/v2/brokers/{brokerId}
get_brokers GET /api/v2/brokers
patch_broker PATCH /api/v2/brokers/{brokerId}

create_brokers

List[Broker] create_brokers(brokers=brokers)

Register an external broker.

Example

  • OAuth Authentication (OAuth2):
  • OAuth Authentication (OAuth2):
import cyperf
from cyperf.models.broker import Broker
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.BrokersApi(api_client)
    brokers = [cyperf.Broker()] # List[Broker] |  (optional)

    try:
        api_response = api_instance.create_brokers(brokers=brokers)
        print("The response of BrokersApi->create_brokers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BrokersApi->create_brokers: %s\n" % e)

Parameters

Name Type Description Notes
brokers List[Broker] [optional]

Return type

List[Broker]

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
201 The broker that was registered -
400 Bad request -
500 Unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

delete_broker

delete_broker(broker_id)

Remove a particular broker.

Example

  • OAuth Authentication (OAuth2):
  • OAuth Authentication (OAuth2):
import cyperf
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.BrokersApi(api_client)
    broker_id = 'broker_id_example' # str | The ID of the broker.

    try:
        api_instance.delete_broker(broker_id)
    except Exception as e:
        print("Exception when calling BrokersApi->delete_broker: %s\n" % e)

Parameters

Name Type Description Notes
broker_id str The ID of the broker.

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 The broker was successfully removed. -
400 Bad request -
404 A broker with the specified ID was not found. -
500 Unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_broker_by_id

Broker get_broker_by_id(broker_id)

Example

  • OAuth Authentication (OAuth2):
  • OAuth Authentication (OAuth2):
import cyperf
from cyperf.models.broker import Broker
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.BrokersApi(api_client)
    broker_id = 'broker_id_example' # str | The ID of the broker.

    try:
        api_response = api_instance.get_broker_by_id(broker_id)
        print("The response of BrokersApi->get_broker_by_id:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BrokersApi->get_broker_by_id: %s\n" % e)

Parameters

Name Type Description Notes
broker_id str The ID of the broker.

Return type

Broker

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 OK -
404 A resource with the specified ID was not found. -
500 Unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

get_brokers

GetBrokers200Response get_brokers(take=take, skip=skip)

Get all the currently available brokers.

Example

  • OAuth Authentication (OAuth2):
  • OAuth Authentication (OAuth2):
import cyperf
from cyperf.models.get_brokers200_response import GetBrokers200Response
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.BrokersApi(api_client)
    take = 56 # int | The number of search results to return (optional)
    skip = 56 # int | The number of search results to skip (optional)

    try:
        api_response = api_instance.get_brokers(take=take, skip=skip)
        print("The response of BrokersApi->get_brokers:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling BrokersApi->get_brokers: %s\n" % e)

Parameters

Name Type Description Notes
take int The number of search results to return [optional]
skip int The number of search results to skip [optional]

Return type

GetBrokers200Response

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 The list of external brokers that the application should connect to -
400 Bad request -
500 Unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]

patch_broker

patch_broker(broker_id, broker=broker)

Update a particular broker.

Example

  • OAuth Authentication (OAuth2):
  • OAuth Authentication (OAuth2):
import cyperf
from cyperf.models.broker import Broker
from cyperf.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost
# See configuration.py for a list of all supported configuration parameters.
configuration = cyperf.Configuration(
    host = "http://localhost"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

configuration.refresh_token = os.environ["OFFLINE_TOKEN_FROM_CYPERF_UI"]

# Enter a context with an instance of the API client
with cyperf.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = cyperf.BrokersApi(api_client)
    broker_id = 'broker_id_example' # str | The ID of the broker.
    broker = cyperf.Broker() # Broker |  (optional)

    try:
        api_instance.patch_broker(broker_id, broker=broker)
    except Exception as e:
        print("Exception when calling BrokersApi->patch_broker: %s\n" % e)

Parameters

Name Type Description Notes
broker_id str The ID of the broker.
broker Broker [optional]

Return type

void (empty response body)

Authorization

OAuth2, OAuth2

HTTP request headers

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

HTTP response details

Status code Description Response headers
204 The broker was successfully updated. -
400 Bad request -
404 A broker with the specified ID was not found. -
500 Unexpected error -

[Back to top] [Back to API list] [Back to Model list] [Back to README]