Skip to content
Roboto
Esc
↑↓navigate↵open⌘Jpreview
On this page

roboto.http.roboto_client

Module Contents

ApiRelativePath

roboto.http.roboto_client.ApiRelativePath#View Source

DEFAULT_HTTP_TIMEOUT

roboto.http.roboto_client.DEFAULT_HTTP_TIMEOUT = 30.0#View Source

RobotoClient

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

A client for making HTTP requests against Roboto service

Parameters

endpoint str
http_client_kwargs Optional[dict[str, Any]]

RobotoClient.defaulted()

classmethod defaulted(client=None)#View Source

Parameters

client Optional[RobotoClient]

Return type

RobotoClient.delete()

delete(path, caller_org_id=None, data=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None, timeout=NotSet)#View Source

Parameters

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]

Properties

RobotoClient.endpoint

endpoint str #
Return type: str

RobotoClient.for_profile()

classmethod for_profile(profile)#View Source

Parameters

profile str

Return type

RobotoClient.from_config()

classmethod from_config(config)#View Source

Return type

RobotoClient.from_env()

classmethod from_env()#View Source

Return type

Properties

RobotoClient.frontend_endpoint

frontend_endpoint str #
Return type: str

RobotoClient.get()

get(path, caller_org_id=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None, timeout=NotSet)#View Source

Parameters

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]

Properties

RobotoClient.http_client

RobotoClient.patch()

patch(path, caller_org_id=None, data=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None, timeout=NotSet)#View Source

Parameters

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]

RobotoClient.post()

post(path, caller_org_id=None, data=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None, timeout=NotSet)#View Source

Parameters

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]

RobotoClient.put()

put(path, caller_org_id=None, data=None, headers=None, idempotent=True, owner_org_id=None, query=None, retry_wait_fn=None, timeout=NotSet)#View Source

Parameters

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]

logger

roboto.http.roboto_client.logger#View Source

Was this page helpful?