Skip to content

Latest commit

 

History

History
465 lines (326 loc) · 17.8 KB

PipelinesApi.md

File metadata and controls

465 lines (326 loc) · 17.8 KB

sensorbucket.PipelinesApi

All URIs are relative to https://sensorbucket.nl/api

Method HTTP request Description
create_pipeline POST /pipelines Create pipeline
disable_pipeline DELETE /pipelines/{id} Disable pipeline
get_pipeline GET /pipelines/{id} Get pipeline
list_pipelines GET /pipelines List pipelines
update_pipeline PATCH /pipelines/{id} Update pipeline

create_pipeline

CreatePipeline200Response create_pipeline(create_pipeline_request=create_pipeline_request)

Create pipeline

Create a new pipeline. A pipeline determines which workers, in which order the incoming data will be processed by. A pipeline step is used as routing key in the Message Queue. This might be changed in future releases. Note: currently there are no validations in place on whether a worker for the provided step actually exists.

Example

  • Bearer Authentication (APIKey):
  • Api Key Authentication (CookieSession):
import sensorbucket
from sensorbucket.models.create_pipeline200_response import CreatePipeline200Response
from sensorbucket.models.create_pipeline_request import CreatePipelineRequest
from sensorbucket.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://sensorbucket.nl/api
# See configuration.py for a list of all supported configuration parameters.
configuration = sensorbucket.Configuration(
    host = "https://sensorbucket.nl/api"
)

# 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.

# Configure Bearer authorization: APIKey
configuration = sensorbucket.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: CookieSession
configuration.api_key['CookieSession'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieSession'] = 'Bearer'

# Enter a context with an instance of the API client
with sensorbucket.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sensorbucket.PipelinesApi(api_client)
    create_pipeline_request = sensorbucket.CreatePipelineRequest() # CreatePipelineRequest |  (optional)

    try:
        # Create pipeline
        api_response = api_instance.create_pipeline(create_pipeline_request=create_pipeline_request)
        print("The response of PipelinesApi->create_pipeline:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PipelinesApi->create_pipeline: %s\n" % e)

Parameters

Name Type Description Notes
create_pipeline_request CreatePipelineRequest [optional]

Return type

CreatePipeline200Response

Authorization

APIKey, CookieSession

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Created pipeline -
401 The request failed because the provided credentials are invalid or missing -
403 The request failed because the provided credentials do not have the required permissions to perform this action -

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

disable_pipeline

DisablePipeline200Response disable_pipeline(id)

Disable pipeline

Disables a pipeline by setting its status to inactive. Inactive pipelines will - by default - not appear in the ListPipelines and GetPipeline endpoints, unless the status=inactive query parameter is given on that endpoint.

Example

  • Bearer Authentication (APIKey):
  • Api Key Authentication (CookieSession):
import sensorbucket
from sensorbucket.models.disable_pipeline200_response import DisablePipeline200Response
from sensorbucket.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://sensorbucket.nl/api
# See configuration.py for a list of all supported configuration parameters.
configuration = sensorbucket.Configuration(
    host = "https://sensorbucket.nl/api"
)

# 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.

# Configure Bearer authorization: APIKey
configuration = sensorbucket.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: CookieSession
configuration.api_key['CookieSession'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieSession'] = 'Bearer'

# Enter a context with an instance of the API client
with sensorbucket.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sensorbucket.PipelinesApi(api_client)
    id = 'id_example' # str | The UUID of the pipeline

    try:
        # Disable pipeline
        api_response = api_instance.disable_pipeline(id)
        print("The response of PipelinesApi->disable_pipeline:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PipelinesApi->disable_pipeline: %s\n" % e)

Parameters

Name Type Description Notes
id str The UUID of the pipeline

Return type

DisablePipeline200Response

Authorization

APIKey, CookieSession

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 pipeline disabled -
401 The request failed because the provided credentials are invalid or missing -
403 The request failed because the provided credentials do not have the required permissions to perform this action -
404 The request failed because the requested resource could not be found or because the resource is disabled -
405 The request failed because the request is invalid. -

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

get_pipeline

GetPipeline200Response get_pipeline(id, status=status)

Get pipeline

Get the pipeline with the given identifier. This endpoint by default returns a 404 Not Found for inactive pipelines. To get an inactive pipeline, provide the status=inactive query parameter.

Example

  • Bearer Authentication (APIKey):
  • Api Key Authentication (CookieSession):
import sensorbucket
from sensorbucket.models.get_pipeline200_response import GetPipeline200Response
from sensorbucket.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://sensorbucket.nl/api
# See configuration.py for a list of all supported configuration parameters.
configuration = sensorbucket.Configuration(
    host = "https://sensorbucket.nl/api"
)

# 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.

# Configure Bearer authorization: APIKey
configuration = sensorbucket.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: CookieSession
configuration.api_key['CookieSession'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieSession'] = 'Bearer'

# Enter a context with an instance of the API client
with sensorbucket.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sensorbucket.PipelinesApi(api_client)
    id = 'id_example' # str | The UUID of the pipeline
    status = ['[active, inactive]'] # List[str] | The status of the pipeline. Use `inactive` to view inactive pipelines instead of getting a 404 error  (optional)

    try:
        # Get pipeline
        api_response = api_instance.get_pipeline(id, status=status)
        print("The response of PipelinesApi->get_pipeline:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PipelinesApi->get_pipeline: %s\n" % e)

Parameters

Name Type Description Notes
id str The UUID of the pipeline
status List[str] The status of the pipeline. Use `inactive` to view inactive pipelines instead of getting a 404 error [optional]

Return type

GetPipeline200Response

Authorization

APIKey, CookieSession

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Fetched pipeline -
401 The request failed because the provided credentials are invalid or missing -
403 The request failed because the provided credentials do not have the required permissions to perform this action -
404 The request failed because the requested resource could not be found or because the resource is disabled -

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

list_pipelines

ListPipelines200Response list_pipelines(inactive=inactive, step=step, cursor=cursor, limit=limit)

List pipelines

List pipelines. By default only state=active pipelines are returned. By providing the query parameter inactive only the inactive pipelines will be returned. Pipelines can be filtered by providing one or more steps. This query parameter can be repeated to include more steps. When multiple steps are given, pipelines containing one of the given steps will be returned.

Example

  • Bearer Authentication (APIKey):
  • Api Key Authentication (CookieSession):
import sensorbucket
from sensorbucket.models.list_pipelines200_response import ListPipelines200Response
from sensorbucket.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://sensorbucket.nl/api
# See configuration.py for a list of all supported configuration parameters.
configuration = sensorbucket.Configuration(
    host = "https://sensorbucket.nl/api"
)

# 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.

# Configure Bearer authorization: APIKey
configuration = sensorbucket.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: CookieSession
configuration.api_key['CookieSession'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieSession'] = 'Bearer'

# Enter a context with an instance of the API client
with sensorbucket.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sensorbucket.PipelinesApi(api_client)
    inactive = True # bool | Only show inactive pipelines (optional)
    step = ['[thethingsnetwork, multiflexmeter]'] # List[str] | Only show pipelines that include at least one of these steps (optional)
    cursor = 'cursor_example' # str | The cursor for the current page (optional)
    limit = 56 # int | The maximum amount of items per page. Not applicable if `cursor` parameter is given. System limits are in place.  (optional)

    try:
        # List pipelines
        api_response = api_instance.list_pipelines(inactive=inactive, step=step, cursor=cursor, limit=limit)
        print("The response of PipelinesApi->list_pipelines:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PipelinesApi->list_pipelines: %s\n" % e)

Parameters

Name Type Description Notes
inactive bool Only show inactive pipelines [optional]
step List[str] Only show pipelines that include at least one of these steps [optional]
cursor str The cursor for the current page [optional]
limit int The maximum amount of items per page. Not applicable if `cursor` parameter is given. System limits are in place. [optional]

Return type

ListPipelines200Response

Authorization

APIKey, CookieSession

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Fetched pipelines -
401 The request failed because the provided credentials are invalid or missing -
403 The request failed because the provided credentials do not have the required permissions to perform this action -

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

update_pipeline

UpdatePipeline200Response update_pipeline(id, update_pipeline_request=update_pipeline_request)

Update pipeline

Update some properties of the pipeline with the given identifier. Setting an invalid state or making an invalid state transition will result in an error.

Example

  • Bearer Authentication (APIKey):
  • Api Key Authentication (CookieSession):
import sensorbucket
from sensorbucket.models.update_pipeline200_response import UpdatePipeline200Response
from sensorbucket.models.update_pipeline_request import UpdatePipelineRequest
from sensorbucket.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://sensorbucket.nl/api
# See configuration.py for a list of all supported configuration parameters.
configuration = sensorbucket.Configuration(
    host = "https://sensorbucket.nl/api"
)

# 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.

# Configure Bearer authorization: APIKey
configuration = sensorbucket.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)

# Configure API key authorization: CookieSession
configuration.api_key['CookieSession'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['CookieSession'] = 'Bearer'

# Enter a context with an instance of the API client
with sensorbucket.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = sensorbucket.PipelinesApi(api_client)
    id = 'id_example' # str | The UUID of the pipeline
    update_pipeline_request = sensorbucket.UpdatePipelineRequest() # UpdatePipelineRequest |  (optional)

    try:
        # Update pipeline
        api_response = api_instance.update_pipeline(id, update_pipeline_request=update_pipeline_request)
        print("The response of PipelinesApi->update_pipeline:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling PipelinesApi->update_pipeline: %s\n" % e)

Parameters

Name Type Description Notes
id str The UUID of the pipeline
update_pipeline_request UpdatePipelineRequest [optional]

Return type

UpdatePipeline200Response

Authorization

APIKey, CookieSession

HTTP request headers

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

HTTP response details

Status code Description Response headers
200 Updated pipeline -
401 The request failed because the provided credentials are invalid or missing -
403 The request failed because the provided credentials do not have the required permissions to perform this action -
404 The request failed because the requested resource could not be found or because the resource is disabled -
405 The request failed because the request is invalid. -

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