viam.app.viam_client
Module Contents
Classes
gRPC client for all communication and interaction with app. |
Attributes
- viam.app.viam_client.LOGGER
- class viam.app.viam_client.ViamClient[source]
gRPC client for all communication and interaction with app.
There is currently 1 way to instantiate a ViamClient object:
ViamClient.create_from_dial_options(...)
- property data_client: viam.app.data_client.DataClient
Insantiate and return a DataClient used to make data and data_sync method calls.
- property app_client: viam.app.app_client.AppClient
Insantiate and return an AppClient used to make app method calls.
- property ml_training_client: viam.app.ml_training_client.MLTrainingClient
Instantiate and return a MLTrainingClient used to make ml_training method calls.
- property billing_client: viam.app.billing_client.BillingClient
Instantiate and return a BillingClient used to make billing method calls.
- async classmethod create_from_dial_options(dial_options: viam.rpc.dial.DialOptions, app_url: Optional[str] = None) typing_extensions.Self [source]
Create ViamClient that establishes a connection to the Viam app.
- Parameters:
dial_options (viam.rpc.dial.DialOptions) – Required information for authorization and connection to app. creds and auth_entity fields are required.
app_url – (Optional[str]): URL of app. Uses app.viam.com if not specified.
- Raises:
ValueError – If the input parameters are missing a required field or simply invalid.
- Returns:
The ViamClient.
- Return type:
Self