`viam.gen.app.v1.app_pb2`

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Module Contents

Classes

`RegistryItemStatus`
`Visibility`
`Robot`	Abstract base class for protocol messages.
`RobotPart`	Abstract base class for protocol messages.
`RobotPartHistoryEntry`	Abstract base class for protocol messages.
`ListOrganizationsRequest`	Abstract base class for protocol messages.
`Organization`	Abstract base class for protocol messages.
`OrganizationMember`	Abstract base class for protocol messages.
`ListOrganizationsResponse`	Abstract base class for protocol messages.
`OrganizationInvite`	Abstract base class for protocol messages.
`CreateOrganizationRequest`	Abstract base class for protocol messages.
`CreateOrganizationResponse`	Abstract base class for protocol messages.
`GetOrganizationRequest`	Abstract base class for protocol messages.
`GetOrganizationResponse`	Abstract base class for protocol messages.
`GetOrganizationNamespaceAvailabilityRequest`	Abstract base class for protocol messages.
`GetOrganizationNamespaceAvailabilityResponse`	Abstract base class for protocol messages.
`UpdateOrganizationRequest`	Abstract base class for protocol messages.
`UpdateOrganizationResponse`	Abstract base class for protocol messages.
`DeleteOrganizationRequest`	Abstract base class for protocol messages.
`DeleteOrganizationResponse`	Abstract base class for protocol messages.
`ListOrganizationMembersRequest`	Abstract base class for protocol messages.
`ListOrganizationMembersResponse`	Abstract base class for protocol messages.
`CreateOrganizationInviteRequest`	Abstract base class for protocol messages.
`CreateOrganizationInviteResponse`	Abstract base class for protocol messages.
`UpdateOrganizationInviteAuthorizationsRequest`	Abstract base class for protocol messages.
`UpdateOrganizationInviteAuthorizationsResponse`	Abstract base class for protocol messages.
`DeleteOrganizationInviteRequest`	Abstract base class for protocol messages.
`DeleteOrganizationInviteResponse`	Abstract base class for protocol messages.
`ResendOrganizationInviteRequest`	Abstract base class for protocol messages.
`ResendOrganizationInviteResponse`	Abstract base class for protocol messages.
`DeleteOrganizationMemberRequest`	Abstract base class for protocol messages.
`DeleteOrganizationMemberResponse`	Abstract base class for protocol messages.
`OrganizationIdentity`	Location
`LocationOrganization`	Abstract base class for protocol messages.
`LocationAuth`	Abstract base class for protocol messages.
`StorageConfig`	Abstract base class for protocol messages.
`Location`	Abstract base class for protocol messages.
`SharedSecret`	SharedSecret is a secret used for LocationAuth and RobotParts.
`CreateLocationRequest`	Abstract base class for protocol messages.
`CreateLocationResponse`	Abstract base class for protocol messages.
`GetLocationRequest`	Abstract base class for protocol messages.
`GetLocationResponse`	Abstract base class for protocol messages.
`UpdateLocationRequest`	Abstract base class for protocol messages.
`UpdateLocationResponse`	Abstract base class for protocol messages.
`DeleteLocationRequest`	Abstract base class for protocol messages.
`DeleteLocationResponse`	Abstract base class for protocol messages.
`GetOrganizationsWithAccessToLocationRequest`	Abstract base class for protocol messages.
`GetOrganizationsWithAccessToLocationResponse`	Abstract base class for protocol messages.
`ListLocationsRequest`	Abstract base class for protocol messages.
`ShareLocationRequest`	Abstract base class for protocol messages.
`ShareLocationResponse`	Abstract base class for protocol messages.
`UnshareLocationRequest`	Abstract base class for protocol messages.
`UnshareLocationResponse`	Abstract base class for protocol messages.
`ListLocationsResponse`	Abstract base class for protocol messages.
`CreateLocationSecretRequest`	Abstract base class for protocol messages.
`CreateLocationSecretResponse`	Abstract base class for protocol messages.
`DeleteLocationSecretRequest`	Abstract base class for protocol messages.
`DeleteLocationSecretResponse`	Abstract base class for protocol messages.
`LocationAuthRequest`	Abstract base class for protocol messages.
`LocationAuthResponse`	Abstract base class for protocol messages.
`GetRobotRequest`	Abstract base class for protocol messages.
`GetRoverRentalRobotsRequest`	Abstract base class for protocol messages.
`RoverRentalRobot`	Abstract base class for protocol messages.
`GetRoverRentalRobotsResponse`	Abstract base class for protocol messages.
`GetRobotResponse`	Abstract base class for protocol messages.
`GetRobotPartsRequest`	Abstract base class for protocol messages.
`GetRobotPartsResponse`	Abstract base class for protocol messages.
`GetRobotPartRequest`	Abstract base class for protocol messages.
`GetRobotPartResponse`	Abstract base class for protocol messages.
`GetRobotPartLogsRequest`	Abstract base class for protocol messages.
`GetRobotPartLogsResponse`	Abstract base class for protocol messages.
`TailRobotPartLogsRequest`	Abstract base class for protocol messages.
`TailRobotPartLogsResponse`	Abstract base class for protocol messages.
`GetRobotPartHistoryRequest`	Abstract base class for protocol messages.
`GetRobotPartHistoryResponse`	Abstract base class for protocol messages.
`UpdateRobotPartRequest`	Abstract base class for protocol messages.
`UpdateRobotPartResponse`	Abstract base class for protocol messages.
`NewRobotPartRequest`	Abstract base class for protocol messages.
`NewRobotPartResponse`	Abstract base class for protocol messages.
`DeleteRobotPartRequest`	Abstract base class for protocol messages.
`GetRobotAPIKeysRequest`	Abstract base class for protocol messages.
`APIKey`	Abstract base class for protocol messages.
`GetRobotAPIKeysResponse`	Abstract base class for protocol messages.
`DeleteRobotPartResponse`	Abstract base class for protocol messages.
`Fragment`	Abstract base class for protocol messages.
`ListFragmentsRequest`	Abstract base class for protocol messages.
`ListFragmentsResponse`	Abstract base class for protocol messages.
`GetFragmentRequest`	Abstract base class for protocol messages.
`GetFragmentResponse`	Abstract base class for protocol messages.
`CreateFragmentRequest`	Abstract base class for protocol messages.
`CreateFragmentResponse`	Abstract base class for protocol messages.
`UpdateFragmentRequest`	Abstract base class for protocol messages.
`UpdateFragmentResponse`	Abstract base class for protocol messages.
`DeleteFragmentRequest`	Abstract base class for protocol messages.
`DeleteFragmentResponse`	Abstract base class for protocol messages.
`ListRobotsRequest`	Abstract base class for protocol messages.
`ListRobotsResponse`	Abstract base class for protocol messages.
`NewRobotRequest`	Abstract base class for protocol messages.
`NewRobotResponse`	Abstract base class for protocol messages.
`UpdateRobotRequest`	Abstract base class for protocol messages.
`UpdateRobotResponse`	Abstract base class for protocol messages.
`DeleteRobotRequest`	Abstract base class for protocol messages.
`DeleteRobotResponse`	Abstract base class for protocol messages.
`MarkPartAsMainRequest`	Abstract base class for protocol messages.
`MarkPartAsMainResponse`	Abstract base class for protocol messages.
`MarkPartForRestartRequest`	Abstract base class for protocol messages.
`MarkPartForRestartResponse`	Abstract base class for protocol messages.
`CreateRobotPartSecretRequest`	Abstract base class for protocol messages.
`CreateRobotPartSecretResponse`	Abstract base class for protocol messages.
`DeleteRobotPartSecretRequest`	Abstract base class for protocol messages.
`DeleteRobotPartSecretResponse`	Abstract base class for protocol messages.
`Authorization`	Abstract base class for protocol messages.
`AddRoleRequest`	Abstract base class for protocol messages.
`AddRoleResponse`	Abstract base class for protocol messages.
`RemoveRoleRequest`	Abstract base class for protocol messages.
`RemoveRoleResponse`	Abstract base class for protocol messages.
`ChangeRoleRequest`	Abstract base class for protocol messages.
`ChangeRoleResponse`	Abstract base class for protocol messages.
`ListAuthorizationsRequest`	Abstract base class for protocol messages.
`ListAuthorizationsResponse`	Abstract base class for protocol messages.
`CheckPermissionsRequest`	Abstract base class for protocol messages.
`AuthorizedPermissions`	Abstract base class for protocol messages.
`CheckPermissionsResponse`	Abstract base class for protocol messages.
`ModuleVersion`	Abstract base class for protocol messages.
`ModuleMetadata`	Abstract base class for protocol messages.
`MLModelMetadata`	Abstract base class for protocol messages.
`MLTrainingMetadata`	Abstract base class for protocol messages.
`RegistryItem`	Abstract base class for protocol messages.
`GetRegistryItemRequest`	Abstract base class for protocol messages.
`GetRegistryItemResponse`	Abstract base class for protocol messages.
`CreateRegistryItemRequest`	Abstract base class for protocol messages.
`CreateRegistryItemResponse`	Abstract base class for protocol messages.
`UpdateRegistryItemRequest`	Abstract base class for protocol messages.
`UpdateRegistryItemResponse`	Abstract base class for protocol messages.
`ListRegistryItemsRequest`	Abstract base class for protocol messages.
`ListRegistryItemsResponse`	Abstract base class for protocol messages.
`DeleteRegistryItemRequest`	Abstract base class for protocol messages.
`DeleteRegistryItemResponse`	Abstract base class for protocol messages.
`CreateModuleRequest`	Modules
`CreateModuleResponse`	Abstract base class for protocol messages.
`UpdateModuleRequest`	Abstract base class for protocol messages.
`UpdateModuleResponse`	Abstract base class for protocol messages.
`Model`	Abstract base class for protocol messages.
`ModuleFileInfo`	Abstract base class for protocol messages.
`UploadModuleFileRequest`	Abstract base class for protocol messages.
`UploadModuleFileResponse`	Abstract base class for protocol messages.
`GetModuleRequest`	Abstract base class for protocol messages.
`GetModuleResponse`	Abstract base class for protocol messages.
`Module`	Abstract base class for protocol messages.
`VersionHistory`	Abstract base class for protocol messages.
`Uploads`	Abstract base class for protocol messages.
`ListModulesRequest`	Abstract base class for protocol messages.
`ListModulesResponse`	Abstract base class for protocol messages.
`GetUserIDByEmailRequest`	Abstract base class for protocol messages.
`GetUserIDByEmailResponse`	Abstract base class for protocol messages.
`ListOrganizationsByUserRequest`	Abstract base class for protocol messages.
`OrgDetails`	Abstract base class for protocol messages.
`ListOrganizationsByUserResponse`	Abstract base class for protocol messages.
`CreateKeyRequest`	Abstract base class for protocol messages.
`CreateKeyResponse`	Abstract base class for protocol messages.
`DeleteKeyRequest`	Abstract base class for protocol messages.
`DeleteKeyResponse`	Abstract base class for protocol messages.
`AuthorizationDetails`	Abstract base class for protocol messages.
`APIKeyWithAuthorizations`	Abstract base class for protocol messages.
`ListKeysRequest`	Abstract base class for protocol messages.
`ListKeysResponse`	Abstract base class for protocol messages.
`RotateKeyRequest`	Abstract base class for protocol messages.
`RotateKeyResponse`	Abstract base class for protocol messages.
`CreateKeyFromExistingKeyAuthorizationsRequest`	Abstract base class for protocol messages.
`CreateKeyFromExistingKeyAuthorizationsResponse`	Abstract base class for protocol messages.

Attributes

`DESCRIPTOR`
`REGISTRY_ITEM_STATUS_UNSPECIFIED`
`REGISTRY_ITEM_STATUS_PUBLISHED`
`REGISTRY_ITEM_STATUS_IN_DEVELOPMENT`
`global___RegistryItemStatus`
`VISIBILITY_UNSPECIFIED`
`VISIBILITY_PRIVATE`	Private modules are visible only within your org
`VISIBILITY_PUBLIC`	Public modules are visible to everyone
`global___Visibility`
`global___Robot`
`global___RobotPart`
`global___RobotPartHistoryEntry`
`global___ListOrganizationsRequest`
`global___Organization`
`global___OrganizationMember`
`global___ListOrganizationsResponse`
`global___OrganizationInvite`
`global___CreateOrganizationRequest`
`global___CreateOrganizationResponse`
`global___GetOrganizationRequest`
`global___GetOrganizationResponse`
`global___GetOrganizationNamespaceAvailabilityRequest`
`global___GetOrganizationNamespaceAvailabilityResponse`
`global___UpdateOrganizationRequest`
`global___UpdateOrganizationResponse`
`global___DeleteOrganizationRequest`
`global___DeleteOrganizationResponse`
`global___ListOrganizationMembersRequest`
`global___ListOrganizationMembersResponse`
`global___CreateOrganizationInviteRequest`
`global___CreateOrganizationInviteResponse`
`global___UpdateOrganizationInviteAuthorizationsRequest`
`global___UpdateOrganizationInviteAuthorizationsResponse`
`global___DeleteOrganizationInviteRequest`
`global___DeleteOrganizationInviteResponse`
`global___ResendOrganizationInviteRequest`
`global___ResendOrganizationInviteResponse`
`global___DeleteOrganizationMemberRequest`
`global___DeleteOrganizationMemberResponse`
`global___OrganizationIdentity`
`global___LocationOrganization`
`global___LocationAuth`
`global___StorageConfig`
`global___Location`
`global___SharedSecret`
`global___CreateLocationRequest`
`global___CreateLocationResponse`
`global___GetLocationRequest`
`global___GetLocationResponse`
`global___UpdateLocationRequest`
`global___UpdateLocationResponse`
`global___DeleteLocationRequest`
`global___DeleteLocationResponse`
`global___GetOrganizationsWithAccessToLocationRequest`
`global___GetOrganizationsWithAccessToLocationResponse`
`global___ListLocationsRequest`
`global___ShareLocationRequest`
`global___ShareLocationResponse`
`global___UnshareLocationRequest`
`global___UnshareLocationResponse`
`global___ListLocationsResponse`
`global___CreateLocationSecretRequest`
`global___CreateLocationSecretResponse`
`global___DeleteLocationSecretRequest`
`global___DeleteLocationSecretResponse`
`global___LocationAuthRequest`
`global___LocationAuthResponse`
`global___GetRobotRequest`
`global___GetRoverRentalRobotsRequest`
`global___RoverRentalRobot`
`global___GetRoverRentalRobotsResponse`
`global___GetRobotResponse`
`global___GetRobotPartsRequest`
`global___GetRobotPartsResponse`
`global___GetRobotPartRequest`
`global___GetRobotPartResponse`
`global___GetRobotPartLogsRequest`
`global___GetRobotPartLogsResponse`
`global___TailRobotPartLogsRequest`
`global___TailRobotPartLogsResponse`
`global___GetRobotPartHistoryRequest`
`global___GetRobotPartHistoryResponse`
`global___UpdateRobotPartRequest`
`global___UpdateRobotPartResponse`
`global___NewRobotPartRequest`
`global___NewRobotPartResponse`
`global___DeleteRobotPartRequest`
`global___GetRobotAPIKeysRequest`
`global___APIKey`
`global___GetRobotAPIKeysResponse`
`global___DeleteRobotPartResponse`
`global___Fragment`
`global___ListFragmentsRequest`
`global___ListFragmentsResponse`
`global___GetFragmentRequest`
`global___GetFragmentResponse`
`global___CreateFragmentRequest`
`global___CreateFragmentResponse`
`global___UpdateFragmentRequest`
`global___UpdateFragmentResponse`
`global___DeleteFragmentRequest`
`global___DeleteFragmentResponse`
`global___ListRobotsRequest`
`global___ListRobotsResponse`
`global___NewRobotRequest`
`global___NewRobotResponse`
`global___UpdateRobotRequest`
`global___UpdateRobotResponse`
`global___DeleteRobotRequest`
`global___DeleteRobotResponse`
`global___MarkPartAsMainRequest`
`global___MarkPartAsMainResponse`
`global___MarkPartForRestartRequest`
`global___MarkPartForRestartResponse`
`global___CreateRobotPartSecretRequest`
`global___CreateRobotPartSecretResponse`
`global___DeleteRobotPartSecretRequest`
`global___DeleteRobotPartSecretResponse`
`global___Authorization`
`global___AddRoleRequest`
`global___AddRoleResponse`
`global___RemoveRoleRequest`
`global___RemoveRoleResponse`
`global___ChangeRoleRequest`
`global___ChangeRoleResponse`
`global___ListAuthorizationsRequest`
`global___ListAuthorizationsResponse`
`global___CheckPermissionsRequest`
`global___AuthorizedPermissions`
`global___CheckPermissionsResponse`
`global___ModuleVersion`
`global___ModuleMetadata`
`global___MLModelMetadata`
`global___MLTrainingMetadata`
`global___RegistryItem`
`global___GetRegistryItemRequest`
`global___GetRegistryItemResponse`
`global___CreateRegistryItemRequest`
`global___CreateRegistryItemResponse`
`global___UpdateRegistryItemRequest`
`global___UpdateRegistryItemResponse`
`global___ListRegistryItemsRequest`
`global___ListRegistryItemsResponse`
`global___DeleteRegistryItemRequest`
`global___DeleteRegistryItemResponse`
`global___CreateModuleRequest`
`global___CreateModuleResponse`
`global___UpdateModuleRequest`
`global___UpdateModuleResponse`
`global___Model`
`global___ModuleFileInfo`
`global___UploadModuleFileRequest`
`global___UploadModuleFileResponse`
`global___GetModuleRequest`
`global___GetModuleResponse`
`global___Module`
`global___VersionHistory`
`global___Uploads`
`global___ListModulesRequest`
`global___ListModulesResponse`
`global___GetUserIDByEmailRequest`
`global___GetUserIDByEmailResponse`
`global___ListOrganizationsByUserRequest`
`global___OrgDetails`
`global___ListOrganizationsByUserResponse`
`global___CreateKeyRequest`
`global___CreateKeyResponse`
`global___DeleteKeyRequest`
`global___DeleteKeyResponse`
`global___AuthorizationDetails`
`global___APIKeyWithAuthorizations`
`global___ListKeysRequest`
`global___ListKeysResponse`
`global___RotateKeyRequest`
`global___RotateKeyResponse`
`global___CreateKeyFromExistingKeyAuthorizationsRequest`
`global___CreateKeyFromExistingKeyAuthorizationsResponse`

viam.gen.app.v1.app_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.app.v1.app_pb2.RegistryItemStatus: Bases: _RegistryItemStatus

viam.gen.app.v1.app_pb2.REGISTRY_ITEM_STATUS_UNSPECIFIED: RegistryItemStatus

viam.gen.app.v1.app_pb2.REGISTRY_ITEM_STATUS_PUBLISHED: RegistryItemStatus

viam.gen.app.v1.app_pb2.REGISTRY_ITEM_STATUS_IN_DEVELOPMENT: RegistryItemStatus

viam.gen.app.v1.app_pb2.global___RegistryItemStatus

class viam.gen.app.v1.app_pb2.Visibility: Bases: _Visibility

viam.gen.app.v1.app_pb2.VISIBILITY_UNSPECIFIED: Visibility

viam.gen.app.v1.app_pb2.VISIBILITY_PRIVATE: Visibility: Private modules are visible only within your org

viam.gen.app.v1.app_pb2.VISIBILITY_PUBLIC: Visibility: Public modules are visible to everyone

viam.gen.app.v1.app_pb2.global___Visibility

class viam.gen.app.v1.app_pb2.Robot(*, id: str = ..., name: str = ..., location: str = ..., last_access: google.protobuf.timestamp_pb2.Timestamp | None = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property last_access: google.protobuf.timestamp_pb2.Timestamp

property created_on: google.protobuf.timestamp_pb2.Timestamp

id: str

name: str

location: str

HasField(field_name: Literal[created_on, b'created_on', last_access, b'last_access']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___Robot

class viam.gen.app.v1.app_pb2.RobotPart(*, id: str = ..., name: str = ..., dns_name: str = ..., secret: str = ..., robot: str = ..., location_id: str = ..., robot_config: google.protobuf.struct_pb2.Struct | None = ..., last_access: google.protobuf.timestamp_pb2.Timestamp | None = ..., user_supplied_info: google.protobuf.struct_pb2.Struct | None = ..., main_part: bool = ..., fqdn: str = ..., local_fqdn: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., secrets: collections.abc.Iterable[global___SharedSecret] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property robot_config: google.protobuf.struct_pb2.Struct

property last_access: google.protobuf.timestamp_pb2.Timestamp

property user_supplied_info: google.protobuf.struct_pb2.Struct

property created_on: google.protobuf.timestamp_pb2.Timestamp

property secrets: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SharedSecret]: List of secrets allowed for authentication.

id: str

name: str

dns_name: str: dns_name part name used for fqdn and local fqdn. Anytime the Name is updated this should be sanitized and updated as well.

secret: str

robot: str

location_id: str: Store the location_id to allow for unique indexes across parts and locations. This filed MUST be updated each time the robots location changes.

main_part: bool

fqdn: str

local_fqdn: str

HasField(field_name: Literal[created_on, b'created_on', last_access, b'last_access', robot_config, b'robot_config', user_supplied_info, b'user_supplied_info']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___RobotPart

class viam.gen.app.v1.app_pb2.RobotPartHistoryEntry(*, part: str = ..., robot: str = ..., when: google.protobuf.timestamp_pb2.Timestamp | None = ..., old: global___RobotPart | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property when: google.protobuf.timestamp_pb2.Timestamp

property old: global___RobotPart

part: str

robot: str

HasField(field_name: Literal[old, b'old', when, b'when']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___RobotPartHistoryEntry

class viam.gen.app.v1.app_pb2.ListOrganizationsRequest

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___ListOrganizationsRequest

class viam.gen.app.v1.app_pb2.Organization(*, id: str = ..., name: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., public_namespace: str = ..., default_region: str = ..., cid: str | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property created_on: google.protobuf.timestamp_pb2.Timestamp

id: str

name: str

public_namespace: str

default_region: str: GCS region of the organization. Locations created under this org will have their GCS region set to this by default and packages associated with this org will be stored in this region.

cid: str

HasField(field_name: Literal[_cid, b'_cid', cid, b'cid', created_on, b'created_on']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_cid, b'_cid']) → Literal[cid] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___Organization

class viam.gen.app.v1.app_pb2.OrganizationMember(*, user_id: str = ..., emails: collections.abc.Iterable[str] | None = ..., date_added: google.protobuf.timestamp_pb2.Timestamp | None = ..., last_login: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property emails: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property date_added: google.protobuf.timestamp_pb2.Timestamp

property last_login: google.protobuf.timestamp_pb2.Timestamp

user_id: str

HasField(field_name: Literal[_last_login, b'_last_login', date_added, b'date_added', last_login, b'last_login']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_last_login, b'_last_login']) → Literal[last_login] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___OrganizationMember

class viam.gen.app.v1.app_pb2.ListOrganizationsResponse(*, organizations: collections.abc.Iterable[global___Organization] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property organizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Organization]

viam.gen.app.v1.app_pb2.global___ListOrganizationsResponse

class viam.gen.app.v1.app_pb2.OrganizationInvite(*, organization_id: str = ..., email: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., authorizations: collections.abc.Iterable[global___Authorization] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property created_on: google.protobuf.timestamp_pb2.Timestamp

property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]

organization_id: str

email: str

HasField(field_name: Literal[created_on, b'created_on']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___OrganizationInvite

class viam.gen.app.v1.app_pb2.CreateOrganizationRequest(*, name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

viam.gen.app.v1.app_pb2.global___CreateOrganizationRequest

class viam.gen.app.v1.app_pb2.CreateOrganizationResponse(*, organization: global___Organization | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property organization: global___Organization

HasField(field_name: Literal[organization, b'organization']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___CreateOrganizationResponse

class viam.gen.app.v1.app_pb2.GetOrganizationRequest(*, organization_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

viam.gen.app.v1.app_pb2.global___GetOrganizationRequest

class viam.gen.app.v1.app_pb2.GetOrganizationResponse(*, organization: global___Organization | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property organization: global___Organization

HasField(field_name: Literal[organization, b'organization']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___GetOrganizationResponse

class viam.gen.app.v1.app_pb2.GetOrganizationNamespaceAvailabilityRequest(*, public_namespace: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

public_namespace: str

viam.gen.app.v1.app_pb2.global___GetOrganizationNamespaceAvailabilityRequest

class viam.gen.app.v1.app_pb2.GetOrganizationNamespaceAvailabilityResponse(*, available: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

available: bool

viam.gen.app.v1.app_pb2.global___GetOrganizationNamespaceAvailabilityResponse

class viam.gen.app.v1.app_pb2.UpdateOrganizationRequest(*, organization_id: str = ..., name: str | None = ..., public_namespace: str | None = ..., region: str | None = ..., cid: str | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

name: str

public_namespace: str

region: str: The new GCS region to associate the org with.

cid: str

HasField(field_name: Literal[_cid, b'_cid', _name, b'_name', _public_namespace, b'_public_namespace', _region, b'_region', cid, b'cid', name, b'name', public_namespace, b'public_namespace', region, b'region']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_cid, b'_cid']) → Literal[cid] | None

WhichOneof(oneof_group: Literal[_name, b'_name']) → Literal[name] | None

WhichOneof(oneof_group: Literal[_public_namespace, b'_public_namespace']) → Literal[public_namespace] | None

WhichOneof(oneof_group: Literal[_region, b'_region']) → Literal[region] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___UpdateOrganizationRequest

class viam.gen.app.v1.app_pb2.UpdateOrganizationResponse(*, organization: global___Organization | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property organization: global___Organization

HasField(field_name: Literal[organization, b'organization']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___UpdateOrganizationResponse

class viam.gen.app.v1.app_pb2.DeleteOrganizationRequest(*, organization_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

viam.gen.app.v1.app_pb2.global___DeleteOrganizationRequest

class viam.gen.app.v1.app_pb2.DeleteOrganizationResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteOrganizationResponse

class viam.gen.app.v1.app_pb2.ListOrganizationMembersRequest(*, organization_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

viam.gen.app.v1.app_pb2.global___ListOrganizationMembersRequest

class viam.gen.app.v1.app_pb2.ListOrganizationMembersResponse(*, organization_id: str = ..., members: collections.abc.Iterable[global___OrganizationMember] | None = ..., invites: collections.abc.Iterable[global___OrganizationInvite] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property members: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrganizationMember]

property invites: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrganizationInvite]

organization_id: str

viam.gen.app.v1.app_pb2.global___ListOrganizationMembersResponse

class viam.gen.app.v1.app_pb2.CreateOrganizationInviteRequest(*, organization_id: str = ..., email: str = ..., authorizations: collections.abc.Iterable[global___Authorization] | None = ..., send_email_invite: bool | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]

organization_id: str

email: str

send_email_invite: bool: Set to true (the default) to send an email to the recipient of an invite. The user must accept the email to be added to the associated authorizations. When set to false, the user automatically receives the associated authorization on the next login of the user with the associated email address.

HasField(field_name: Literal[_send_email_invite, b'_send_email_invite', send_email_invite, b'send_email_invite']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_send_email_invite, b'_send_email_invite']) → Literal[send_email_invite] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___CreateOrganizationInviteRequest

class viam.gen.app.v1.app_pb2.CreateOrganizationInviteResponse(*, invite: global___OrganizationInvite | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property invite: global___OrganizationInvite

HasField(field_name: Literal[invite, b'invite']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___CreateOrganizationInviteResponse

class viam.gen.app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsRequest(*, organization_id: str = ..., email: str = ..., add_authorizations: collections.abc.Iterable[global___Authorization] | None = ..., remove_authorizations: collections.abc.Iterable[global___Authorization] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property add_authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]

property remove_authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]

organization_id: str

email: str

viam.gen.app.v1.app_pb2.global___UpdateOrganizationInviteAuthorizationsRequest

class viam.gen.app.v1.app_pb2.UpdateOrganizationInviteAuthorizationsResponse(*, invite: global___OrganizationInvite | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property invite: global___OrganizationInvite

HasField(field_name: Literal[invite, b'invite']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___UpdateOrganizationInviteAuthorizationsResponse

class viam.gen.app.v1.app_pb2.DeleteOrganizationInviteRequest(*, organization_id: str = ..., email: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

email: str

viam.gen.app.v1.app_pb2.global___DeleteOrganizationInviteRequest

class viam.gen.app.v1.app_pb2.DeleteOrganizationInviteResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteOrganizationInviteResponse

class viam.gen.app.v1.app_pb2.ResendOrganizationInviteRequest(*, organization_id: str = ..., email: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

email: str

viam.gen.app.v1.app_pb2.global___ResendOrganizationInviteRequest

class viam.gen.app.v1.app_pb2.ResendOrganizationInviteResponse(*, invite: global___OrganizationInvite | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property invite: global___OrganizationInvite

HasField(field_name: Literal[invite, b'invite']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___ResendOrganizationInviteResponse

class viam.gen.app.v1.app_pb2.DeleteOrganizationMemberRequest(*, organization_id: str = ..., user_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

user_id: str

viam.gen.app.v1.app_pb2.global___DeleteOrganizationMemberRequest

class viam.gen.app.v1.app_pb2.DeleteOrganizationMemberResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteOrganizationMemberResponse

class viam.gen.app.v1.app_pb2.OrganizationIdentity(*, id: str = ..., name: str = ...)

Bases: google.protobuf.message.Message

Location

Used for rendering an organization’s information on the frontend (limited to id, name, or both).

id: str: Organization ID.

name: str: Organization name.

viam.gen.app.v1.app_pb2.global___OrganizationIdentity

class viam.gen.app.v1.app_pb2.LocationOrganization(*, organization_id: str = ..., primary: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str: Organization ID the location is shared with.

primary: bool: Whether the organization is the primary owner or not.

viam.gen.app.v1.app_pb2.global___LocationOrganization

class viam.gen.app.v1.app_pb2.LocationAuth(*, secret: str = ..., location_id: str = ..., secrets: collections.abc.Iterable[global___SharedSecret] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property secrets: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SharedSecret]: List of secrets used to authenticate to the Location.

secret: str

use secrets field.

Type:: Deprecated

location_id: str: Location ID containing this LocationAuth.

viam.gen.app.v1.app_pb2.global___LocationAuth

class viam.gen.app.v1.app_pb2.StorageConfig(*, region: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

region: str: GCS region that data is stored in.

viam.gen.app.v1.app_pb2.global___StorageConfig

class viam.gen.app.v1.app_pb2.Location(*, id: str = ..., name: str = ..., parent_location_id: str = ..., auth: global___LocationAuth | None = ..., organizations: collections.abc.Iterable[global___LocationOrganization] | None = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., robot_count: int = ..., config: global___StorageConfig | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property auth: global___LocationAuth: Location authentication secrets.

property organizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___LocationOrganization]: Organizations that the location is shared with.

property created_on: google.protobuf.timestamp_pb2.Timestamp: Location creation timestamp.

property config: global___StorageConfig: Config for how data in this location is stored.

id: str: Location ID.

name: str: Location name.

parent_location_id: str: Location ID of the parent location.

robot_count: int

HasField(field_name: Literal[auth, b'auth', config, b'config', created_on, b'created_on']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___Location

class viam.gen.app.v1.app_pb2.SharedSecret(*, id: str = ..., secret: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., state: global___SharedSecret = ...)

Bases: google.protobuf.message.Message

SharedSecret is a secret used for LocationAuth and RobotParts.

class State: Bases: _State

property created_on: google.protobuf.timestamp_pb2.Timestamp: Date/time the secret was first created.

STATE_UNSPECIFIED: SharedSecret

STATE_ENABLED: SharedSecret: Secret is enabled and can be used in authentication.

STATE_DISABLED: SharedSecret: Secret is disabled and must not be used to authenticate to rpc.

id: str

secret: str: The payload of the secret. Used during authentication to the rpc framework.

state: global___SharedSecret.State.ValueType: State of the shared secret. In most cases it should be enabled. We may support disabling a specific secret while keeping it in the database.

HasField(field_name: Literal[created_on, b'created_on']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___SharedSecret

class viam.gen.app.v1.app_pb2.CreateLocationRequest(*, organization_id: str = ..., name: str = ..., parent_location_id: str | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str: Organization ID to create the location under.

name: str: Name of the location.

parent_location_id: str: The new parent location to move the location under.

HasField(field_name: Literal[_parent_location_id, b'_parent_location_id', parent_location_id, b'parent_location_id']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_parent_location_id, b'_parent_location_id']) → Literal[parent_location_id] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___CreateLocationRequest

class viam.gen.app.v1.app_pb2.CreateLocationResponse(*, location: global___Location | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property location: global___Location: Location object is returned.

HasField(field_name: Literal[location, b'location']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___CreateLocationResponse

class viam.gen.app.v1.app_pb2.GetLocationRequest(*, location_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str: Location ID of location to get.

viam.gen.app.v1.app_pb2.global___GetLocationRequest

class viam.gen.app.v1.app_pb2.GetLocationResponse(*, location: global___Location | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property location: global___Location: Location object is returned.

HasField(field_name: Literal[location, b'location']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___GetLocationResponse

class viam.gen.app.v1.app_pb2.UpdateLocationRequest(*, location_id: str = ..., name: str | None = ..., parent_location_id: str | None = ..., region: str | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str: Location ID of location to update.

name: str: The new name to be updated on location.

parent_location_id: str: The new parent location to move the location under.

region: str: The new GCS region to associate the location with.

HasField(field_name: Literal[_name, b'_name', _parent_location_id, b'_parent_location_id', _region, b'_region', name, b'name', parent_location_id, b'parent_location_id', region, b'region']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_name, b'_name']) → Literal[name] | None

WhichOneof(oneof_group: Literal[_parent_location_id, b'_parent_location_id']) → Literal[parent_location_id] | None

WhichOneof(oneof_group: Literal[_region, b'_region']) → Literal[region] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___UpdateLocationRequest

class viam.gen.app.v1.app_pb2.UpdateLocationResponse(*, location: global___Location | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property location: global___Location: Location object is returned.

HasField(field_name: Literal[location, b'location']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___UpdateLocationResponse

class viam.gen.app.v1.app_pb2.DeleteLocationRequest(*, location_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str: Location ID of location to delete.

viam.gen.app.v1.app_pb2.global___DeleteLocationRequest

class viam.gen.app.v1.app_pb2.DeleteLocationResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteLocationResponse

class viam.gen.app.v1.app_pb2.GetOrganizationsWithAccessToLocationRequest(*, location_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str

viam.gen.app.v1.app_pb2.global___GetOrganizationsWithAccessToLocationRequest

class viam.gen.app.v1.app_pb2.GetOrganizationsWithAccessToLocationResponse(*, organization_identities: collections.abc.Iterable[global___OrganizationIdentity] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property organization_identities: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrganizationIdentity]

viam.gen.app.v1.app_pb2.global___GetOrganizationsWithAccessToLocationResponse

class viam.gen.app.v1.app_pb2.ListLocationsRequest(*, organization_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str: Organization ID under which to list all locations.

viam.gen.app.v1.app_pb2.global___ListLocationsRequest

class viam.gen.app.v1.app_pb2.ShareLocationRequest(*, location_id: str = ..., organization_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str: Location ID to be shared.

organization_id: str: Organization ID to share the location with.

viam.gen.app.v1.app_pb2.global___ShareLocationRequest

class viam.gen.app.v1.app_pb2.ShareLocationResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___ShareLocationResponse

class viam.gen.app.v1.app_pb2.UnshareLocationRequest(*, location_id: str = ..., organization_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str: Location ID to be unshared.

organization_id: str: Organization ID to unshare the location with.

viam.gen.app.v1.app_pb2.global___UnshareLocationRequest

class viam.gen.app.v1.app_pb2.UnshareLocationResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___UnshareLocationResponse

class viam.gen.app.v1.app_pb2.ListLocationsResponse(*, locations: collections.abc.Iterable[global___Location] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property locations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Location]

viam.gen.app.v1.app_pb2.global___ListLocationsResponse

class viam.gen.app.v1.app_pb2.CreateLocationSecretRequest(*, location_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str: Location ID to create the secret in.

viam.gen.app.v1.app_pb2.global___CreateLocationSecretRequest

class viam.gen.app.v1.app_pb2.CreateLocationSecretResponse(*, auth: global___LocationAuth | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property auth: global___LocationAuth: Location’s auth after updates.

HasField(field_name: Literal[auth, b'auth']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___CreateLocationSecretResponse

class viam.gen.app.v1.app_pb2.DeleteLocationSecretRequest(*, location_id: str = ..., secret_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str

secret_id: str

viam.gen.app.v1.app_pb2.global___DeleteLocationSecretRequest

class viam.gen.app.v1.app_pb2.DeleteLocationSecretResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteLocationSecretResponse

class viam.gen.app.v1.app_pb2.LocationAuthRequest(*, location_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str

viam.gen.app.v1.app_pb2.global___LocationAuthRequest

class viam.gen.app.v1.app_pb2.LocationAuthResponse(*, auth: global___LocationAuth | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property auth: global___LocationAuth

HasField(field_name: Literal[auth, b'auth']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___LocationAuthResponse

class viam.gen.app.v1.app_pb2.GetRobotRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___GetRobotRequest

class viam.gen.app.v1.app_pb2.GetRoverRentalRobotsRequest(*, org_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

org_id: str

viam.gen.app.v1.app_pb2.global___GetRoverRentalRobotsRequest

class viam.gen.app.v1.app_pb2.RoverRentalRobot(*, robot_id: str = ..., location_id: str = ..., robot_name: str = ..., robot_main_part_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

robot_id: str

location_id: str

robot_name: str

robot_main_part_id: str

viam.gen.app.v1.app_pb2.global___RoverRentalRobot

class viam.gen.app.v1.app_pb2.GetRoverRentalRobotsResponse(*, robots: collections.abc.Iterable[global___RoverRentalRobot] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property robots: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RoverRentalRobot]

viam.gen.app.v1.app_pb2.global___GetRoverRentalRobotsResponse

class viam.gen.app.v1.app_pb2.GetRobotResponse(*, robot: global___Robot | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property robot: global___Robot

HasField(field_name: Literal[robot, b'robot']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___GetRobotResponse

class viam.gen.app.v1.app_pb2.GetRobotPartsRequest(*, robot_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

robot_id: str

viam.gen.app.v1.app_pb2.global___GetRobotPartsRequest

class viam.gen.app.v1.app_pb2.GetRobotPartsResponse(*, parts: collections.abc.Iterable[global___RobotPart] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property parts: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RobotPart]

viam.gen.app.v1.app_pb2.global___GetRobotPartsResponse

class viam.gen.app.v1.app_pb2.GetRobotPartRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___GetRobotPartRequest

class viam.gen.app.v1.app_pb2.GetRobotPartResponse(*, part: global___RobotPart | None = ..., config_json: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property part: global___RobotPart

config_json: str

HasField(field_name: Literal[part, b'part']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___GetRobotPartResponse

class viam.gen.app.v1.app_pb2.GetRobotPartLogsRequest(*, id: str = ..., errors_only: bool = ..., filter: str | None = ..., page_token: str | None = ..., levels: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property levels: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: logs of all levels are returned when the levels field is empty

id: str

errors_only: bool

Remove this field

Type:: TODO(https
Type:: //viam.atlassian.net/browse/APP-3877)

filter: str

page_token: str

HasField(field_name: Literal[_filter, b'_filter', _page_token, b'_page_token', filter, b'filter', page_token, b'page_token']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_filter, b'_filter']) → Literal[filter] | None

WhichOneof(oneof_group: Literal[_page_token, b'_page_token']) → Literal[page_token] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___GetRobotPartLogsRequest

class viam.gen.app.v1.app_pb2.GetRobotPartLogsResponse(*, logs: collections.abc.Iterable[viam.gen.common.v1.common_pb2.LogEntry] | None = ..., next_page_token: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property logs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.LogEntry]

next_page_token: str

viam.gen.app.v1.app_pb2.global___GetRobotPartLogsResponse

class viam.gen.app.v1.app_pb2.TailRobotPartLogsRequest(*, id: str = ..., errors_only: bool = ..., filter: str | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

errors_only: bool

filter: str

HasField(field_name: Literal[_filter, b'_filter', filter, b'filter']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_filter, b'_filter']) → Literal[filter] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___TailRobotPartLogsRequest

class viam.gen.app.v1.app_pb2.TailRobotPartLogsResponse(*, logs: collections.abc.Iterable[viam.gen.common.v1.common_pb2.LogEntry] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property logs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.LogEntry]

viam.gen.app.v1.app_pb2.global___TailRobotPartLogsResponse

class viam.gen.app.v1.app_pb2.GetRobotPartHistoryRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___GetRobotPartHistoryRequest

class viam.gen.app.v1.app_pb2.GetRobotPartHistoryResponse(*, history: collections.abc.Iterable[global___RobotPartHistoryEntry] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property history: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RobotPartHistoryEntry]

viam.gen.app.v1.app_pb2.global___GetRobotPartHistoryResponse

class viam.gen.app.v1.app_pb2.UpdateRobotPartRequest(*, id: str = ..., name: str = ..., robot_config: google.protobuf.struct_pb2.Struct | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property robot_config: google.protobuf.struct_pb2.Struct

id: str

name: str

HasField(field_name: Literal[robot_config, b'robot_config']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___UpdateRobotPartRequest

class viam.gen.app.v1.app_pb2.UpdateRobotPartResponse(*, part: global___RobotPart | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property part: global___RobotPart

HasField(field_name: Literal[part, b'part']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___UpdateRobotPartResponse

class viam.gen.app.v1.app_pb2.NewRobotPartRequest(*, robot_id: str = ..., part_name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

robot_id: str

part_name: str

viam.gen.app.v1.app_pb2.global___NewRobotPartRequest

class viam.gen.app.v1.app_pb2.NewRobotPartResponse(*, part_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

part_id: str

viam.gen.app.v1.app_pb2.global___NewRobotPartResponse

class viam.gen.app.v1.app_pb2.DeleteRobotPartRequest(*, part_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

part_id: str

viam.gen.app.v1.app_pb2.global___DeleteRobotPartRequest

class viam.gen.app.v1.app_pb2.GetRobotAPIKeysRequest(*, robot_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

robot_id: str

viam.gen.app.v1.app_pb2.global___GetRobotAPIKeysRequest

class viam.gen.app.v1.app_pb2.APIKey(*, id: str = ..., key: str = ..., name: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property created_on: google.protobuf.timestamp_pb2.Timestamp

id: str

key: str

name: str

HasField(field_name: Literal[created_on, b'created_on']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___APIKey

class viam.gen.app.v1.app_pb2.GetRobotAPIKeysResponse(*, api_keys: collections.abc.Iterable[global___APIKeyWithAuthorizations] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property api_keys: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___APIKeyWithAuthorizations]

viam.gen.app.v1.app_pb2.global___GetRobotAPIKeysResponse

class viam.gen.app.v1.app_pb2.DeleteRobotPartResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteRobotPartResponse

class viam.gen.app.v1.app_pb2.Fragment(*, id: str = ..., name: str = ..., fragment: google.protobuf.struct_pb2.Struct | None = ..., organization_owner: str = ..., public: bool = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., organization_name: str = ..., robot_part_count: int = ..., organization_count: int = ..., only_used_by_owner: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property fragment: google.protobuf.struct_pb2.Struct

property created_on: google.protobuf.timestamp_pb2.Timestamp

id: str

name: str

organization_owner: str

public: bool

organization_name: str

robot_part_count: int: number of robot parts using this fragment

organization_count: int: number of organizations using this fragment

only_used_by_owner: bool: whether the organization(s) using this fragment is the same as the fragment org

HasField(field_name: Literal[created_on, b'created_on', fragment, b'fragment']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___Fragment

class viam.gen.app.v1.app_pb2.ListFragmentsRequest(*, organization_id: str = ..., show_public: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str

show_public: bool

viam.gen.app.v1.app_pb2.global___ListFragmentsRequest

class viam.gen.app.v1.app_pb2.ListFragmentsResponse(*, fragments: collections.abc.Iterable[global___Fragment] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property fragments: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Fragment]

viam.gen.app.v1.app_pb2.global___ListFragmentsResponse

class viam.gen.app.v1.app_pb2.GetFragmentRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___GetFragmentRequest

class viam.gen.app.v1.app_pb2.GetFragmentResponse(*, fragment: global___Fragment | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property fragment: global___Fragment

HasField(field_name: Literal[fragment, b'fragment']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___GetFragmentResponse

class viam.gen.app.v1.app_pb2.CreateFragmentRequest(*, name: str = ..., config: google.protobuf.struct_pb2.Struct | None = ..., organization_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property config: google.protobuf.struct_pb2.Struct

name: str

organization_id: str

HasField(field_name: Literal[config, b'config']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___CreateFragmentRequest

class viam.gen.app.v1.app_pb2.CreateFragmentResponse(*, fragment: global___Fragment | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property fragment: global___Fragment

HasField(field_name: Literal[fragment, b'fragment']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___CreateFragmentResponse

class viam.gen.app.v1.app_pb2.UpdateFragmentRequest(*, id: str = ..., name: str = ..., config: google.protobuf.struct_pb2.Struct | None = ..., public: bool | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property config: google.protobuf.struct_pb2.Struct

id: str

name: str

public: bool

HasField(field_name: Literal[_public, b'_public', config, b'config', public, b'public']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_public, b'_public']) → Literal[public] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___UpdateFragmentRequest

class viam.gen.app.v1.app_pb2.UpdateFragmentResponse(*, fragment: global___Fragment | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property fragment: global___Fragment

HasField(field_name: Literal[fragment, b'fragment']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___UpdateFragmentResponse

class viam.gen.app.v1.app_pb2.DeleteFragmentRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___DeleteFragmentRequest

class viam.gen.app.v1.app_pb2.DeleteFragmentResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteFragmentResponse

class viam.gen.app.v1.app_pb2.ListRobotsRequest(*, location_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

location_id: str

viam.gen.app.v1.app_pb2.global___ListRobotsRequest

class viam.gen.app.v1.app_pb2.ListRobotsResponse(*, robots: collections.abc.Iterable[global___Robot] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property robots: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Robot]

viam.gen.app.v1.app_pb2.global___ListRobotsResponse

class viam.gen.app.v1.app_pb2.NewRobotRequest(*, name: str = ..., location: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

name: str

location: str

viam.gen.app.v1.app_pb2.global___NewRobotRequest

class viam.gen.app.v1.app_pb2.NewRobotResponse(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___NewRobotResponse

class viam.gen.app.v1.app_pb2.UpdateRobotRequest(*, id: str = ..., name: str = ..., location: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

name: str

location: str

viam.gen.app.v1.app_pb2.global___UpdateRobotRequest

class viam.gen.app.v1.app_pb2.UpdateRobotResponse(*, robot: global___Robot | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property robot: global___Robot

HasField(field_name: Literal[robot, b'robot']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___UpdateRobotResponse

class viam.gen.app.v1.app_pb2.DeleteRobotRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___DeleteRobotRequest

class viam.gen.app.v1.app_pb2.DeleteRobotResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteRobotResponse

class viam.gen.app.v1.app_pb2.MarkPartAsMainRequest(*, part_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

part_id: str

viam.gen.app.v1.app_pb2.global___MarkPartAsMainRequest

class viam.gen.app.v1.app_pb2.MarkPartAsMainResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___MarkPartAsMainResponse

class viam.gen.app.v1.app_pb2.MarkPartForRestartRequest(*, part_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

part_id: str

viam.gen.app.v1.app_pb2.global___MarkPartForRestartRequest

class viam.gen.app.v1.app_pb2.MarkPartForRestartResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___MarkPartForRestartResponse

class viam.gen.app.v1.app_pb2.CreateRobotPartSecretRequest(*, part_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

part_id: str: Robot Part ID to create the secret in.

viam.gen.app.v1.app_pb2.global___CreateRobotPartSecretRequest

class viam.gen.app.v1.app_pb2.CreateRobotPartSecretResponse(*, part: global___RobotPart | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property part: global___RobotPart: Location’s auth after updates.

HasField(field_name: Literal[part, b'part']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___CreateRobotPartSecretResponse

class viam.gen.app.v1.app_pb2.DeleteRobotPartSecretRequest(*, part_id: str = ..., secret_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

part_id: str

secret_id: str

viam.gen.app.v1.app_pb2.global___DeleteRobotPartSecretRequest

class viam.gen.app.v1.app_pb2.DeleteRobotPartSecretResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteRobotPartSecretResponse

class viam.gen.app.v1.app_pb2.Authorization(*, authorization_type: str = ..., authorization_id: str = ..., resource_type: str = ..., resource_id: str = ..., identity_id: str = ..., organization_id: str = ..., identity_type: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

authorization_type: str

authorization_id: str

resource_type: str

resource_id: str

identity_id: str

organization_id: str

identity_type: str

viam.gen.app.v1.app_pb2.global___Authorization

class viam.gen.app.v1.app_pb2.AddRoleRequest(*, authorization: global___Authorization | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property authorization: global___Authorization

HasField(field_name: Literal[authorization, b'authorization']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___AddRoleRequest

class viam.gen.app.v1.app_pb2.AddRoleResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___AddRoleResponse

class viam.gen.app.v1.app_pb2.RemoveRoleRequest(*, authorization: global___Authorization | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property authorization: global___Authorization

HasField(field_name: Literal[authorization, b'authorization']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___RemoveRoleRequest

class viam.gen.app.v1.app_pb2.RemoveRoleResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___RemoveRoleResponse

class viam.gen.app.v1.app_pb2.ChangeRoleRequest(*, old_authorization: global___Authorization | None = ..., new_authorization: global___Authorization | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property old_authorization: global___Authorization

property new_authorization: global___Authorization

HasField(field_name: Literal[new_authorization, b'new_authorization', old_authorization, b'old_authorization']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___ChangeRoleRequest

class viam.gen.app.v1.app_pb2.ChangeRoleResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___ChangeRoleResponse

class viam.gen.app.v1.app_pb2.ListAuthorizationsRequest(*, organization_id: str = ..., resource_ids: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property resource_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: optional filter

organization_id: str

viam.gen.app.v1.app_pb2.global___ListAuthorizationsRequest

class viam.gen.app.v1.app_pb2.ListAuthorizationsResponse(*, authorizations: collections.abc.Iterable[global___Authorization] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]

viam.gen.app.v1.app_pb2.global___ListAuthorizationsResponse

class viam.gen.app.v1.app_pb2.CheckPermissionsRequest(*, permissions: collections.abc.Iterable[global___AuthorizedPermissions] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property permissions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___AuthorizedPermissions]

viam.gen.app.v1.app_pb2.global___CheckPermissionsRequest

class viam.gen.app.v1.app_pb2.AuthorizedPermissions(*, resource_type: str = ..., resource_id: str = ..., permissions: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property permissions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

resource_type: str

resource_id: str

viam.gen.app.v1.app_pb2.global___AuthorizedPermissions

class viam.gen.app.v1.app_pb2.CheckPermissionsResponse(*, authorized_permissions: collections.abc.Iterable[global___AuthorizedPermissions] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property authorized_permissions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___AuthorizedPermissions]

viam.gen.app.v1.app_pb2.global___CheckPermissionsResponse

class viam.gen.app.v1.app_pb2.ModuleVersion(*, version: str = ..., files: collections.abc.Iterable[global___Uploads] | None = ..., models: collections.abc.Iterable[global___Model] | None = ..., entrypoint: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property files: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Uploads]: The uploads that are available for this module version

property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]: The models that this verion of the module provides

version: str: The semver string that represents the major/minor/patch version of the module

entrypoint: str: The entrypoint for this version of the module

viam.gen.app.v1.app_pb2.global___ModuleVersion

class viam.gen.app.v1.app_pb2.ModuleMetadata(*, models: collections.abc.Iterable[global___Model] | None = ..., versions: collections.abc.Iterable[global___ModuleVersion] | None = ..., entrypoint: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]: A list of models that are available in the module

property versions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ModuleVersion]: A list of versions of the module that are available When this is returned from the backend, the versions are sorted in ascending order by the semver version

entrypoint: str: The executable to run to start the module program

viam.gen.app.v1.app_pb2.global___ModuleMetadata

class viam.gen.app.v1.app_pb2.MLModelMetadata(*, versions: collections.abc.Iterable[str] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property versions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: A list of package versions for a ML model

viam.gen.app.v1.app_pb2.global___MLModelMetadata

class viam.gen.app.v1.app_pb2.MLTrainingMetadata(*, versions: collections.abc.Iterable[str] | None = ..., model_type: viam.gen.app.mltraining.v1.ml_training_pb2.ModelType.ValueType = ..., model_framework: viam.gen.app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType = ..., draft: bool = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property versions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]: A list of package versions for ML training source distribution

model_type: viam.gen.app.mltraining.v1.ml_training_pb2.ModelType.ValueType

model_framework: viam.gen.app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType

draft: bool

viam.gen.app.v1.app_pb2.global___MLTrainingMetadata

class viam.gen.app.v1.app_pb2.RegistryItem(*, item_id: str = ..., organization_id: str = ..., public_namespace: str = ..., name: str = ..., type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType = ..., visibility: global___Visibility = ..., url: str = ..., description: str = ..., total_robot_usage: int = ..., total_external_robot_usage: int = ..., total_organization_usage: int = ..., total_external_organization_usage: int = ..., module_metadata: global___ModuleMetadata | None = ..., ml_model_metadata: global___MLModelMetadata | None = ..., ml_training_metadata: global___MLTrainingMetadata | None = ..., created_at: google.protobuf.timestamp_pb2.Timestamp | None = ..., updated_at: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property module_metadata: global___ModuleMetadata

property ml_model_metadata: global___MLModelMetadata

property ml_training_metadata: global___MLTrainingMetadata

property created_at: google.protobuf.timestamp_pb2.Timestamp: When the item was created

property updated_at: google.protobuf.timestamp_pb2.Timestamp: When the item was last updated, either through an update or upload.

item_id: str: The id of the item, containing either: namespace:item_name when a namespace exists on the org. org_id:item_name when a namespace does not exist.

organization_id: str: The id of the organization that owns the item

public_namespace: str: The public namespace of the organization that owns the module This is empty if no public namespace is set

name: str: The name of the registry item

type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType: The type of the item in the registry

visibility: global___Visibility: The visibility of the registry item

url: str: The url to reference for documentation, code, etc.

description: str: A short description of the item that explains its purpose

total_robot_usage: int: The total number of robots using this item

total_external_robot_usage: int: The total number of robots using this item outside of the owning org

total_organization_usage: int: The total number of organizations using this item

total_external_organization_usage: int: The total number of organizations using this item outside of the owning org

HasField(field_name: Literal[created_at, b'created_at', metadata, b'metadata', ml_model_metadata, b'ml_model_metadata', ml_training_metadata, b'ml_training_metadata', module_metadata, b'module_metadata', updated_at, b'updated_at']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[metadata, b'metadata']) → Literal[module_metadata, ml_model_metadata, ml_training_metadata] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___RegistryItem

class viam.gen.app.v1.app_pb2.GetRegistryItemRequest(*, item_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

item_id: str

viam.gen.app.v1.app_pb2.global___GetRegistryItemRequest

class viam.gen.app.v1.app_pb2.GetRegistryItemResponse(*, item: global___RegistryItem | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property item: global___RegistryItem

HasField(field_name: Literal[item, b'item']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___GetRegistryItemResponse

class viam.gen.app.v1.app_pb2.CreateRegistryItemRequest(*, organization_id: str = ..., name: str = ..., type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str: The organization to create the registry item under

name: str: The name of the registry item, which must be unique within your org

type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType: The type of the item in the registry

viam.gen.app.v1.app_pb2.global___CreateRegistryItemRequest

class viam.gen.app.v1.app_pb2.CreateRegistryItemResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___CreateRegistryItemResponse

class viam.gen.app.v1.app_pb2.UpdateRegistryItemRequest(*, item_id: str = ..., type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType = ..., description: str = ..., visibility: global___Visibility = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

item_id: str

type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType

description: str

visibility: global___Visibility

viam.gen.app.v1.app_pb2.global___UpdateRegistryItemRequest

class viam.gen.app.v1.app_pb2.UpdateRegistryItemResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___UpdateRegistryItemResponse

class viam.gen.app.v1.app_pb2.ListRegistryItemsRequest(*, organization_id: str | None = ..., types: collections.abc.Iterable[viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType] | None = ..., visibilities: collections.abc.Iterable[global___Visibility] | None = ..., platforms: collections.abc.Iterable[str] | None = ..., statuses: collections.abc.Iterable[global___RegistryItemStatus] | None = ..., search_term: str | None = ..., page_token: str | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property types: google.protobuf.internal.containers.RepeatedScalarFieldContainer[viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType]

property visibilities: google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___Visibility]

property platforms: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]

property statuses: google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___RegistryItemStatus]

organization_id: str: The id of the organization to return registry items for.

search_term: str

page_token: str

HasField(field_name: Literal[_organization_id, b'_organization_id', _page_token, b'_page_token', _search_term, b'_search_term', organization_id, b'organization_id', page_token, b'page_token', search_term, b'search_term']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_organization_id, b'_organization_id']) → Literal[organization_id] | None

WhichOneof(oneof_group: Literal[_page_token, b'_page_token']) → Literal[page_token] | None

WhichOneof(oneof_group: Literal[_search_term, b'_search_term']) → Literal[search_term] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___ListRegistryItemsRequest

class viam.gen.app.v1.app_pb2.ListRegistryItemsResponse(*, items: collections.abc.Iterable[global___RegistryItem] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property items: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RegistryItem]

viam.gen.app.v1.app_pb2.global___ListRegistryItemsResponse

class viam.gen.app.v1.app_pb2.DeleteRegistryItemRequest(*, item_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

item_id: str

name where prefix is the owner’s orgid or namespace)

Type:: The id of the item (formatted as prefix

viam.gen.app.v1.app_pb2.global___DeleteRegistryItemRequest

class viam.gen.app.v1.app_pb2.DeleteRegistryItemResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteRegistryItemResponse

class viam.gen.app.v1.app_pb2.CreateModuleRequest(*, organization_id: str = ..., name: str = ...)

Bases: google.protobuf.message.Message

Modules

organization_id: str: The organization to create the module under

name: str: The name of the module, which must be unique within your org

viam.gen.app.v1.app_pb2.global___CreateModuleRequest

class viam.gen.app.v1.app_pb2.CreateModuleResponse(*, module_id: str = ..., url: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:: The id of the module (formatted as prefix

url: str: The detail page of the module

viam.gen.app.v1.app_pb2.global___CreateModuleResponse

class viam.gen.app.v1.app_pb2.UpdateModuleRequest(*, module_id: str = ..., visibility: global___Visibility = ..., url: str = ..., description: str = ..., models: collections.abc.Iterable[global___Model] | None = ..., entrypoint: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]: A list of models that are available in the module

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:: The id of the module (formatted as prefix

visibility: global___Visibility: The visibility that should be set for the module

url: str: The url to reference for documentation, code, etc.

description: str: A short description of the module that explains its purpose

entrypoint: str: The executable to run to start the module program

viam.gen.app.v1.app_pb2.global___UpdateModuleRequest

class viam.gen.app.v1.app_pb2.UpdateModuleResponse(*, url: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

url: str: The detail page of the module

viam.gen.app.v1.app_pb2.global___UpdateModuleResponse

class viam.gen.app.v1.app_pb2.Model(*, api: str = ..., model: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

api: str: The colon-delimited-triplet of the api implemented by the model

model: str: The colon-delimited-triplet of the model

viam.gen.app.v1.app_pb2.global___Model

class viam.gen.app.v1.app_pb2.ModuleFileInfo(*, module_id: str = ..., version: str = ..., platform: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:: The id of the module (formatted as prefix

version: str: The semver string that represents the new major/minor/patch version of the module

platform: str: The platform that the file is built to run on

viam.gen.app.v1.app_pb2.global___ModuleFileInfo

class viam.gen.app.v1.app_pb2.UploadModuleFileRequest(*, module_file_info: global___ModuleFileInfo | None = ..., file: bytes = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property module_file_info: global___ModuleFileInfo: The information about the module file being uploaded

file: bytes: The file contents to be uploaded

HasField(field_name: Literal[file, b'file', module_file, b'module_file', module_file_info, b'module_file_info']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[module_file, b'module_file']) → Literal[module_file_info, file] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___UploadModuleFileRequest

class viam.gen.app.v1.app_pb2.UploadModuleFileResponse(*, url: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

url: str: The detail page of the module

viam.gen.app.v1.app_pb2.global___UploadModuleFileResponse

class viam.gen.app.v1.app_pb2.GetModuleRequest(*, module_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:: The id of the module (formatted as prefix

viam.gen.app.v1.app_pb2.global___GetModuleRequest

class viam.gen.app.v1.app_pb2.GetModuleResponse(*, module: global___Module | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property module: global___Module: The module object

HasField(field_name: Literal[module, b'module']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___GetModuleResponse

class viam.gen.app.v1.app_pb2.Module(*, module_id: str = ..., name: str = ..., visibility: global___Visibility = ..., versions: collections.abc.Iterable[global___VersionHistory] | None = ..., url: str = ..., description: str = ..., models: collections.abc.Iterable[global___Model] | None = ..., total_robot_usage: int = ..., total_organization_usage: int = ..., organization_id: str = ..., entrypoint: str = ..., public_namespace: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property versions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___VersionHistory]: The versions of the module that are available When this is returned from the backend, the versions are sorted in ascending order by the semver version

property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]: A list of models that are available in the module

module_id: str

name where prefix is the module owner’s orgid or namespace)

Type:: The id of the module (formatted as prefix

name: str: The name of the module

visibility: global___Visibility: The visibility of the module

url: str: The url to reference for documentation, code, etc.

description: str: A short description of the module that explains its purpose

total_robot_usage: int: The total number of robots using this module

total_organization_usage: int: The total number of organizations using this module

organization_id: str: The id of the organization that owns the module

entrypoint: str: The executable to run to start the module program

public_namespace: str: The public namespace of the organization that owns the module This is empty if no public namespace is set

viam.gen.app.v1.app_pb2.global___Module

class viam.gen.app.v1.app_pb2.VersionHistory(*, version: str = ..., files: collections.abc.Iterable[global___Uploads] | None = ..., models: collections.abc.Iterable[global___Model] | None = ..., entrypoint: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property files: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Uploads]: The uploads that are available for this module version

property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]: The models that this verion of the module provides

version: str: The semver string that represents the major/minor/patch version of the module

entrypoint: str: The entrypoint for this version of the module

viam.gen.app.v1.app_pb2.global___VersionHistory

class viam.gen.app.v1.app_pb2.Uploads(*, platform: str = ..., uploaded_at: google.protobuf.timestamp_pb2.Timestamp | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property uploaded_at: google.protobuf.timestamp_pb2.Timestamp: The time when the file was uploaded

platform: str: The OS and architecture the module is built to run on

HasField(field_name: Literal[uploaded_at, b'uploaded_at']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___Uploads

class viam.gen.app.v1.app_pb2.ListModulesRequest(*, organization_id: str | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

organization_id: str: The id of the organization to return private modules for.

HasField(field_name: Literal[_organization_id, b'_organization_id', organization_id, b'organization_id']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

WhichOneof(oneof_group: Literal[_organization_id, b'_organization_id']) → Literal[organization_id] | None

Returns the name of the field that is set inside a oneof group.

If no field is set, returns None.

Parameters:: oneof_group (str) – the name of the oneof group to check.
Returns:: The name of the group that is set, or None.
Return type:: str or None
Raises:: ValueError – no group with the given name exists

viam.gen.app.v1.app_pb2.global___ListModulesRequest

class viam.gen.app.v1.app_pb2.ListModulesResponse(*, modules: collections.abc.Iterable[global___Module] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property modules: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Module]: A listed of modules. When authenticated, this API will return modules that are private for this org. Public modules are always returned.

viam.gen.app.v1.app_pb2.global___ListModulesResponse

class viam.gen.app.v1.app_pb2.GetUserIDByEmailRequest(*, email: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

email: str

viam.gen.app.v1.app_pb2.global___GetUserIDByEmailRequest

class viam.gen.app.v1.app_pb2.GetUserIDByEmailResponse(*, user_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

user_id: str

viam.gen.app.v1.app_pb2.global___GetUserIDByEmailResponse

class viam.gen.app.v1.app_pb2.ListOrganizationsByUserRequest(*, user_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

user_id: str

viam.gen.app.v1.app_pb2.global___ListOrganizationsByUserRequest

class viam.gen.app.v1.app_pb2.OrgDetails(*, org_id: str = ..., org_name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

org_id: str

org_name: str

viam.gen.app.v1.app_pb2.global___OrgDetails

class viam.gen.app.v1.app_pb2.ListOrganizationsByUserResponse(*, orgs: collections.abc.Iterable[global___OrgDetails] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property orgs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrgDetails]

viam.gen.app.v1.app_pb2.global___ListOrganizationsByUserResponse

class viam.gen.app.v1.app_pb2.CreateKeyRequest(*, authorizations: collections.abc.Iterable[global___Authorization] | None = ..., name: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]

name: str

viam.gen.app.v1.app_pb2.global___CreateKeyRequest

class viam.gen.app.v1.app_pb2.CreateKeyResponse(*, key: str = ..., id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

key: str

id: str

viam.gen.app.v1.app_pb2.global___CreateKeyResponse

class viam.gen.app.v1.app_pb2.DeleteKeyRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___DeleteKeyRequest

class viam.gen.app.v1.app_pb2.DeleteKeyResponse

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

viam.gen.app.v1.app_pb2.global___DeleteKeyResponse

class viam.gen.app.v1.app_pb2.AuthorizationDetails(*, authorization_type: str = ..., authorization_id: str = ..., resource_type: str = ..., resource_id: str = ..., org_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

authorization_type: str

authorization_id: str

resource_type: str

resource_id: str

org_id: str

viam.gen.app.v1.app_pb2.global___AuthorizationDetails

class viam.gen.app.v1.app_pb2.APIKeyWithAuthorizations(*, api_key: global___APIKey | None = ..., authorizations: collections.abc.Iterable[global___AuthorizationDetails] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property api_key: global___APIKey

property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___AuthorizationDetails]

HasField(field_name: Literal[api_key, b'api_key']) → bool

Checks if a certain field is set for the message.

For a oneof group, checks if any field inside is set. Note that if the field_name is not defined in the message descriptor, ValueError will be raised.

Parameters:: field_name (str) – The name of the field to check for presence.
Returns:: Whether a value has been set for the named field.
Return type:: bool
Raises:: ValueError – if the field_name is not a member of this message.

viam.gen.app.v1.app_pb2.global___APIKeyWithAuthorizations

class viam.gen.app.v1.app_pb2.ListKeysRequest(*, org_id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

org_id: str

viam.gen.app.v1.app_pb2.global___ListKeysRequest

class viam.gen.app.v1.app_pb2.ListKeysResponse(*, api_keys: collections.abc.Iterable[global___APIKeyWithAuthorizations] | None = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

property api_keys: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___APIKeyWithAuthorizations]

viam.gen.app.v1.app_pb2.global___ListKeysResponse

class viam.gen.app.v1.app_pb2.RotateKeyRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___RotateKeyRequest

class viam.gen.app.v1.app_pb2.RotateKeyResponse(*, id: str = ..., key: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

key: str

viam.gen.app.v1.app_pb2.global___RotateKeyResponse

class viam.gen.app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsRequest(*, id: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

viam.gen.app.v1.app_pb2.global___CreateKeyFromExistingKeyAuthorizationsRequest

class viam.gen.app.v1.app_pb2.CreateKeyFromExistingKeyAuthorizationsResponse(*, id: str = ..., key: str = ...)

Bases: google.protobuf.message.Message

Abstract base class for protocol messages.

Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.

id: str

key: str

viam.gen.app.v1.app_pb2.global___CreateKeyFromExistingKeyAuthorizationsResponse

viam.gen.app.v1.app_pb2

Module Contents

Classes

Attributes

`viam.gen.app.v1.app_pb2`