viam.gen.app.v1.app_pb2
@generated by mypy-protobuf. Do not edit manually! isort:skip_file
Attributes
Private registry items are visible only within the owning org |
|
Public registry items are visible to everyone |
|
Public Unlisted registry items are usable in everyone's robot but are hidden from the registry page as if they are private |
|
Classes
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Third Party Org Services |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Location |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
SharedSecret is a secret used for LocationAuth and RobotParts. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Modules |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
Module Contents
- viam.gen.app.v1.app_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
- class viam.gen.app.v1.app_pb2.AuthenticationType
Bases:
_AuthenticationType
- viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_UNSPECIFIED: AuthenticationType
- viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_WEB_OAUTH: AuthenticationType
- viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_API_KEY: AuthenticationType
- viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_ROBOT_PART_SECRET: AuthenticationType
- viam.gen.app.v1.app_pb2.AUTHENTICATION_TYPE_LOCATION_SECRET: AuthenticationType
- viam.gen.app.v1.app_pb2.global___AuthenticationType
- class viam.gen.app.v1.app_pb2.FragmentVisibility
Bases:
_FragmentVisibility
- viam.gen.app.v1.app_pb2.FRAGMENT_VISIBILITY_UNSPECIFIED: FragmentVisibility
- viam.gen.app.v1.app_pb2.FRAGMENT_VISIBILITY_PRIVATE: FragmentVisibility
- viam.gen.app.v1.app_pb2.FRAGMENT_VISIBILITY_PUBLIC: FragmentVisibility
- viam.gen.app.v1.app_pb2.FRAGMENT_VISIBILITY_PUBLIC_UNLISTED: FragmentVisibility
- viam.gen.app.v1.app_pb2.global___FragmentVisibility
- class viam.gen.app.v1.app_pb2.FragmentErrorType
Bases:
_FragmentErrorType
- viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_UNSPECIFIED: FragmentErrorType
- viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_NO_ACCESS: FragmentErrorType
- viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_NESTING_LIMIT_EXCEEDED: FragmentErrorType
- viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_CHILD_ID_INVALID: FragmentErrorType
- viam.gen.app.v1.app_pb2.FRAGMENT_ERROR_TYPE_CYCLE_DETECTED: FragmentErrorType
- viam.gen.app.v1.app_pb2.global___FragmentErrorType
- 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 registry items are visible only within the owning org
- viam.gen.app.v1.app_pb2.VISIBILITY_PUBLIC: Visibility
Public registry items are visible to everyone
- viam.gen.app.v1.app_pb2.VISIBILITY_PUBLIC_UNLISTED: Visibility
Public Unlisted registry items are usable in everyone’s robot but are hidden from the registry page as if they are private
- viam.gen.app.v1.app_pb2.global___Visibility
- class viam.gen.app.v1.app_pb2.ClientAuthentication
Bases:
_ClientAuthentication
- viam.gen.app.v1.app_pb2.CLIENT_AUTHENTICATION_UNSPECIFIED: ClientAuthentication
- viam.gen.app.v1.app_pb2.CLIENT_AUTHENTICATION_REQUIRED: ClientAuthentication
- viam.gen.app.v1.app_pb2.CLIENT_AUTHENTICATION_NOT_REQUIRED: ClientAuthentication
- viam.gen.app.v1.app_pb2.CLIENT_AUTHENTICATION_NOT_REQUIRED_WHEN_USING_PKCE: ClientAuthentication
- viam.gen.app.v1.app_pb2.global___ClientAuthentication
- class viam.gen.app.v1.app_pb2.PKCE
Bases:
_PKCE
- viam.gen.app.v1.app_pb2.global___PKCE
- class viam.gen.app.v1.app_pb2.URLValidation
Bases:
_URLValidation
- viam.gen.app.v1.app_pb2.URL_VALIDATION_UNSPECIFIED: URLValidation
- viam.gen.app.v1.app_pb2.URL_VALIDATION_EXACT_MATCH: URLValidation
- viam.gen.app.v1.app_pb2.URL_VALIDATION_ALLOW_WILDCARDS: URLValidation
- viam.gen.app.v1.app_pb2.global___URLValidation
- class viam.gen.app.v1.app_pb2.EnabledGrant
Bases:
_EnabledGrant
- viam.gen.app.v1.app_pb2.ENABLED_GRANT_UNSPECIFIED: EnabledGrant
- viam.gen.app.v1.app_pb2.ENABLED_GRANT_AUTHORIZATION_CODE: EnabledGrant
- viam.gen.app.v1.app_pb2.ENABLED_GRANT_IMPLICIT: EnabledGrant
- viam.gen.app.v1.app_pb2.ENABLED_GRANT_PASSWORD: EnabledGrant
- viam.gen.app.v1.app_pb2.ENABLED_GRANT_REFRESH_TOKEN: EnabledGrant
- viam.gen.app.v1.app_pb2.ENABLED_GRANT_DEVICE_CODE: EnabledGrant
- viam.gen.app.v1.app_pb2.global___EnabledGrant
- 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.
- id: str
- name: str
- location: str
- property last_access: google.protobuf.timestamp_pb2.Timestamp
- property created_on: google.protobuf.timestamp_pb2.Timestamp
- 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 = ..., last_updated: 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.
- 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
- 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.
- property last_updated: google.protobuf.timestamp_pb2.Timestamp
latest timestamp when a robot part was updated
- HasField(field_name: Literal['created_on', b'created_on', 'last_access', b'last_access', 'last_updated', b'last_updated', '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 = ..., edited_by: global___AuthenticatorInfo | 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.
- part: str
- robot: str
- property when: google.protobuf.timestamp_pb2.Timestamp
- property old: global___RobotPart
- property edited_by: global___AuthenticatorInfo
- HasField(field_name: Literal['edited_by', b'edited_by', '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.AuthenticatorInfo(*, type: global___AuthenticationType = ..., value: str = ..., is_deactivated: 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.
- type: global___AuthenticationType
- value: str
- is_deactivated: bool
- viam.gen.app.v1.app_pb2.global___AuthenticatorInfo
- 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.
- 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
- property created_on: google.protobuf.timestamp_pb2.Timestamp
- 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.
- user_id: str
- property emails: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
- property date_added: google.protobuf.timestamp_pb2.Timestamp
- property last_login: google.protobuf.timestamp_pb2.Timestamp
- 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.
- organization_id: str
- email: str
- property created_on: google.protobuf.timestamp_pb2.Timestamp
- property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]
- 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.
- organization_id: str
- property members: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrganizationMember]
- property invites: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___OrganizationInvite]
- 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.
- 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.
- property authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]
- 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.
- organization_id: str
- email: str
- property add_authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]
- property remove_authorizations: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Authorization]
- 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.BillingAddress(*, address_line_1: str = ..., address_line_2: str | None = ..., city: str = ..., state: str = ..., zipcode: str = ...)
Bases:
google.protobuf.message.Message
Third Party Org Services
- address_line_1: str
- address_line_2: str
- city: str
- state: str
- zipcode: str
- HasField(field_name: Literal['_address_line_2', b'_address_line_2', 'address_line_2', b'address_line_2']) 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['_address_line_2', b'_address_line_2']) Literal['address_line_2'] | 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___BillingAddress
- class viam.gen.app.v1.app_pb2.EnableBillingServiceRequest(*, org_id: str = ..., billing_address: global___BillingAddress | 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.
- org_id: str
- property billing_address: global___BillingAddress
- HasField(field_name: Literal['billing_address', b'billing_address']) 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___EnableBillingServiceRequest
- class viam.gen.app.v1.app_pb2.EnableBillingServiceResponse
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___EnableBillingServiceResponse
- class viam.gen.app.v1.app_pb2.UpdateBillingServiceRequest(*, org_id: str = ..., billing_address: global___BillingAddress | 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.
- org_id: str
- property billing_address: global___BillingAddress
- HasField(field_name: Literal['billing_address', b'billing_address']) 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___UpdateBillingServiceRequest
- class viam.gen.app.v1.app_pb2.UpdateBillingServiceResponse
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___UpdateBillingServiceResponse
- class viam.gen.app.v1.app_pb2.GetBillingServiceConfigRequest(*, 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___GetBillingServiceConfigRequest
- class viam.gen.app.v1.app_pb2.GetBillingServiceConfigResponse(*, billing_address: global___BillingAddress | None = ..., support_email: str = ..., logo_url: str = ..., billing_dashboard_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.
- support_email: str
- logo_url: str
- billing_dashboard_url: str
- property billing_address: global___BillingAddress
- HasField(field_name: Literal['billing_address', b'billing_address']) 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___GetBillingServiceConfigResponse
- class viam.gen.app.v1.app_pb2.DisableBillingServiceRequest(*, 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___DisableBillingServiceRequest
- class viam.gen.app.v1.app_pb2.DisableBillingServiceResponse
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___DisableBillingServiceResponse
- class viam.gen.app.v1.app_pb2.OrganizationSetSupportEmailRequest(*, org_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.
- org_id: str
- email: str
- viam.gen.app.v1.app_pb2.global___OrganizationSetSupportEmailRequest
- class viam.gen.app.v1.app_pb2.OrganizationSetSupportEmailResponse
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___OrganizationSetSupportEmailResponse
- class viam.gen.app.v1.app_pb2.OrganizationGetSupportEmailRequest(*, 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___OrganizationGetSupportEmailRequest
- class viam.gen.app.v1.app_pb2.OrganizationGetSupportEmailResponse(*, 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___OrganizationGetSupportEmailResponse
- 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.
- secret: str
use secrets field.
- Type:
Deprecated
- location_id: str
Location ID containing this LocationAuth.
- property secrets: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___SharedSecret]
List of secrets used to authenticate to the Location.
- 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.
- id: str
Location ID.
- name: str
Location name.
- parent_location_id: str
Location ID of the parent location.
- robot_count: int
- 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.
- 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
Bases:
google.protobuf.message.Message
SharedSecret is a secret used for LocationAuth and RobotParts.
Bases:
_State
Secret is enabled and can be used in authentication.
Secret is disabled and must not be used to authenticate to rpc.
The payload of the secret. Used during authentication to the rpc framework.
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.
Date/time the secret was first created.
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.
- 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
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 to be shared.
Organization ID to share the location with.
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.
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 to be unshared.
Organization ID to unshare the location with.
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.
- 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.
- config_json: str
- 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___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 = ..., start: google.protobuf.timestamp_pb2.Timestamp | None = ..., end: google.protobuf.timestamp_pb2.Timestamp | None = ..., limit: int | None = ..., source: 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
Remove this field
- Type:
TODO(https
- Type:
//viam.atlassian.net/browse/APP-3877)
- filter: str
- page_token: str
- limit: int
- source: str
- property levels: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
logs of all levels are returned when the levels field is empty
- property start: google.protobuf.timestamp_pb2.Timestamp
- property end: google.protobuf.timestamp_pb2.Timestamp
- HasField(field_name: Literal['_end', b'_end', '_filter', b'_filter', '_limit', b'_limit', '_page_token', b'_page_token', '_source', b'_source', '_start', b'_start', 'end', b'end', 'filter', b'filter', 'limit', b'limit', 'page_token', b'page_token', 'source', b'source', 'start', b'start']) 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['_end', b'_end']) Literal['end'] | None
- WhichOneof(oneof_group: Literal['_filter', b'_filter']) Literal['filter'] | None
- WhichOneof(oneof_group: Literal['_limit', b'_limit']) Literal['limit'] | None
- WhichOneof(oneof_group: Literal['_page_token', b'_page_token']) Literal['page_token'] | None
- WhichOneof(oneof_group: Literal['_source', b'_source']) Literal['source'] | None
- WhichOneof(oneof_group: Literal['_start', b'_start']) Literal['start'] | 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.
- next_page_token: str
- property logs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[viam.gen.common.v1.common_pb2.LogEntry]
- 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.
- id: str
- name: str
- property robot_config: google.protobuf.struct_pb2.Struct
- 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.
- id: str
- key: str
- name: str
- property created_on: google.protobuf.timestamp_pb2.Timestamp
- 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 = ..., visibility: global___FragmentVisibility = ..., last_updated: 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.
- 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
- visibility: global___FragmentVisibility
the visibility of a fragment; public, private or unlisted
- property fragment: google.protobuf.struct_pb2.Struct
- property created_on: google.protobuf.timestamp_pb2.Timestamp
- property last_updated: google.protobuf.timestamp_pb2.Timestamp
latest timestamp when fragment was updated
- HasField(field_name: Literal['created_on', b'created_on', 'fragment', b'fragment', 'last_updated', b'last_updated']) 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.FragmentHistoryEntry(*, fragment: str = ..., edited_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., old: global___Fragment | None = ..., edited_by: global___AuthenticatorInfo | 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.
- fragment: str
- property edited_on: google.protobuf.timestamp_pb2.Timestamp
- property old: global___Fragment
- property edited_by: global___AuthenticatorInfo
- HasField(field_name: Literal['edited_by', b'edited_by', 'edited_on', b'edited_on', 'old', b'old']) 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___FragmentHistoryEntry
- class viam.gen.app.v1.app_pb2.FragmentError(*, error_type: global___FragmentErrorType = ..., fragment_id: str = ..., detail: 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.
- error_type: global___FragmentErrorType
- fragment_id: str
- detail: str
- viam.gen.app.v1.app_pb2.global___FragmentError
- class viam.gen.app.v1.app_pb2.ResolvedFragment(*, fragment_id: str = ..., resolved_config: google.protobuf.struct_pb2.Struct | None = ..., error: global___FragmentError | 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.
- fragment_id: str
- property resolved_config: google.protobuf.struct_pb2.Struct
- property error: global___FragmentError
- HasField(field_name: Literal['error', b'error', 'resolved_config', b'resolved_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___ResolvedFragment
- class viam.gen.app.v1.app_pb2.ListFragmentsRequest(*, organization_id: str = ..., show_public: bool = ..., fragment_visibility: collections.abc.Iterable[global___FragmentVisibility] | 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
- show_public: bool
- property fragment_visibility: google.protobuf.internal.containers.RepeatedScalarFieldContainer[global___FragmentVisibility]
- 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 = ..., visibility: global___FragmentVisibility | 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.
- name: str
- organization_id: str
- visibility: global___FragmentVisibility
- property config: google.protobuf.struct_pb2.Struct
- HasField(field_name: Literal['_visibility', b'_visibility', 'config', b'config', 'visibility', b'visibility']) 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['_visibility', b'_visibility']) Literal['visibility'] | 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___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 = ..., visibility: global___FragmentVisibility | 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
- name: str
- public: bool
- visibility: global___FragmentVisibility
- property config: google.protobuf.struct_pb2.Struct
- HasField(field_name: Literal['_public', b'_public', '_visibility', b'_visibility', 'config', b'config', 'public', b'public', 'visibility', b'visibility']) 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
- WhichOneof(oneof_group: Literal['_visibility', b'_visibility']) Literal['visibility'] | 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.GetFragmentHistoryRequest(*, id: str = ..., page_token: str | None = ..., page_limit: int | 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
- page_token: str
- page_limit: int
- HasField(field_name: Literal['_page_limit', b'_page_limit', '_page_token', b'_page_token', 'page_limit', b'page_limit', '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['_page_limit', b'_page_limit']) Literal['page_limit'] | 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___GetFragmentHistoryRequest
- class viam.gen.app.v1.app_pb2.GetFragmentHistoryResponse(*, history: collections.abc.Iterable[global___FragmentHistoryEntry] | 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.
- next_page_token: str
- property history: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FragmentHistoryEntry]
- viam.gen.app.v1.app_pb2.global___GetFragmentHistoryResponse
- 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.ListMachineFragmentsRequest(*, machine_id: str = ..., additional_fragment_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.
- machine_id: str
the machine_id used to filter fragments defined in a machine’s parts. Also returns any fragments nested within the fragments defined in parts.
- property additional_fragment_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
additional fragment_ids to append to the response. useful when needing to view fragments that will be provisionally added to the machine alongside existing fragments.
- viam.gen.app.v1.app_pb2.global___ListMachineFragmentsRequest
- class viam.gen.app.v1.app_pb2.ListMachineFragmentsResponse(*, fragments: collections.abc.Iterable[global___Fragment] | None = ..., resolved_fragments: collections.abc.Iterable[global___ResolvedFragment] | 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]
- property resolved_fragments: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___ResolvedFragment]
- viam.gen.app.v1.app_pb2.global___ListMachineFragmentsResponse
- 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.
- organization_id: str
- property resource_ids: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
optional filter
- 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.
- resource_type: str
- resource_id: str
- property permissions: google.protobuf.internal.containers.RepeatedScalarFieldContainer[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 = ..., first_run: 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.
- 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
- first_run: str
The path to a setup script that is run before a newly downloaded module starts.
- 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
- HasField(field_name: Literal['_first_run', b'_first_run', 'first_run', b'first_run']) 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['_first_run', b'_first_run']) Literal['first_run'] | 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___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 = ..., first_run: 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.
- entrypoint: str
The executable to run to start the module program
- first_run: str
The path to a setup script that is run before a newly downloaded module starts.
- 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
- HasField(field_name: Literal['_first_run', b'_first_run', 'first_run', b'first_run']) 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['_first_run', b'_first_run']) Literal['first_run'] | 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___ModuleMetadata
- class viam.gen.app.v1.app_pb2.MLModelMetadata(*, 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 = ...)
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.
- model_type: viam.gen.app.mltraining.v1.ml_training_pb2.ModelType.ValueType
- model_framework: viam.gen.app.mltraining.v1.ml_training_pb2.ModelFramework.ValueType
- 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.MLTrainingVersion(*, version: 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.
- version: str
- property created_on: google.protobuf.timestamp_pb2.Timestamp
- 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___MLTrainingVersion
- class viam.gen.app.v1.app_pb2.MLTrainingMetadata(*, versions: collections.abc.Iterable[global___MLTrainingVersion] | 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.
- 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
- property versions: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___MLTrainingVersion]
A list of package versions for ML training source distribution
- 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.
- 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
- 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.
- 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 = ..., url: 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.
- item_id: str
- type: viam.gen.app.packages.v1.packages_pb2.PackageType.ValueType
- description: str
- visibility: global___Visibility
- url: str
- HasField(field_name: Literal['_url', b'_url', 'url', b'url']) 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['_url', b'_url']) Literal['url'] | 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___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 = ..., public_namespaces: 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.
- organization_id: str
The id of the organization to return registry items for.
- search_term: str
- page_token: str
- 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]
- property public_namespaces: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
One or more public namespaces to return results for.
- 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.TransferRegistryItemRequest(*, item_id: str = ..., new_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.
- item_id: str
- new_public_namespace: str
- viam.gen.app.v1.app_pb2.global___TransferRegistryItemRequest
- class viam.gen.app.v1.app_pb2.TransferRegistryItemResponse
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___TransferRegistryItemResponse
- 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 = ..., first_run: 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.
- 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
- first_run: str
The path to a setup script that is run before a newly downloaded module starts.
- property models: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Model]
A list of models that are available in the module
- HasField(field_name: Literal['_first_run', b'_first_run', 'first_run', b'first_run']) 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['_first_run', b'_first_run']) Literal['first_run'] | 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___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 = ..., platform_tags: 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.
- 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
- property platform_tags: google.protobuf.internal.containers.RepeatedScalarFieldContainer[str]
Platform tag constraints. When a robot requests its config, it uploads a platform and a list of platform tags. The platform is checked against platform above, and the tags are checked against this list.
- 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.
- file: bytes
The file contents to be uploaded
- property module_file_info: global___ModuleFileInfo
The information about the module file being 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 = ..., first_run: 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.
- 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
- first_run: str
The path to a setup script that is run before a newly downloaded module starts.
- 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
- HasField(field_name: Literal['_first_run', b'_first_run', 'first_run', b'first_run']) 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['_first_run', b'_first_run']) Literal['first_run'] | 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___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 = ..., first_run: 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.
- 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
- first_run: str
The path to a setup script that is run before a newly downloaded module starts.
- 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
- HasField(field_name: Literal['_first_run', b'_first_run', 'first_run', b'first_run']) 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['_first_run', b'_first_run']) Literal['first_run'] | 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___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.
- platform: str
The OS and architecture the module is built to run on
- property uploaded_at: google.protobuf.timestamp_pb2.Timestamp
The time when the file was uploaded
- 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.