roboto.http.roboto_client#

Module Contents#

roboto.http.roboto_client.ApiRelativePath#
class roboto.http.roboto_client.RobotoClient(endpoint, auth_decorator, http_client_kwargs=None)#

A client for making HTTP requests against Roboto service

Parameters:

  • endpoint (str)

  • auth_decorator (Optional[roboto.http.request.HttpRequestDecorator])

  • http_client_kwargs (Optional[dict[str, Any]])

classmethod defaulted(client=None)#
Parameters:

client (Optional[RobotoClient])

Return type:

RobotoClient

delete(path, caller_org_id=None, data=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None)#
Parameters:

  • path (ApiRelativePath)

  • caller_org_id (Optional[str])

  • data (Any)

  • headers (Optional[dict[str, str]])

  • idempotent (bool)

  • owner_org_id (Optional[str])

  • query (Optional[dict[str, Any]])

  • retry_wait_fn (Optional[roboto.http.retry.RetryWaitFn])

Return type:

roboto.http.response.HttpResponse

property endpoint: str#
Return type:

str

classmethod from_config(config)#
Parameters:

config (roboto.config.RobotoConfig)

Return type:

RobotoClient

classmethod from_env()#
Return type:

RobotoClient

property frontend_endpoint: str#
Return type:

str

get(path, caller_org_id=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None)#
Parameters:

  • path (ApiRelativePath)

  • caller_org_id (Optional[str])

  • headers (Optional[dict[str, str]])

  • idempotent (bool)

  • owner_org_id (Optional[str])

  • query (Optional[dict[str, Any]])

  • retry_wait_fn (Optional[roboto.http.retry.RetryWaitFn])

Return type:

roboto.http.response.HttpResponse

property http_client: roboto.http.http_client.HttpClient#
Return type:

roboto.http.http_client.HttpClient

patch(path, caller_org_id=None, data=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None)#
Parameters:

  • path (ApiRelativePath)

  • caller_org_id (Optional[str])

  • data (Any)

  • headers (Optional[dict[str, str]])

  • idempotent (bool)

  • owner_org_id (Optional[str])

  • query (Optional[dict[str, Any]])

  • retry_wait_fn (Optional[roboto.http.retry.RetryWaitFn])

Return type:

roboto.http.response.HttpResponse

post(path, caller_org_id=None, data=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None)#
Parameters:

  • path (ApiRelativePath)

  • caller_org_id (Optional[str])

  • data (Any)

  • headers (Optional[dict[str, str]])

  • idempotent (bool)

  • owner_org_id (Optional[str])

  • query (Optional[dict[str, Any]])

  • retry_wait_fn (Optional[roboto.http.retry.RetryWaitFn])

Return type:

roboto.http.response.HttpResponse

put(path, caller_org_id=None, data=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None)#
Parameters:

  • path (ApiRelativePath)

  • caller_org_id (Optional[str])

  • data (Any)

  • headers (Optional[dict[str, str]])

  • idempotent (bool)

  • owner_org_id (Optional[str])

  • query (Optional[dict[str, Any]])

  • retry_wait_fn (Optional[roboto.http.retry.RetryWaitFn])

Return type:

roboto.http.response.HttpResponse

roboto.http.roboto_client.logger#
On this page