viam.gen.provisioning.v1.provisioning_pb2 ========================================= .. py:module:: viam.gen.provisioning.v1.provisioning_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Attributes ---------- .. autoapisummary:: viam.gen.provisioning.v1.provisioning_pb2.DESCRIPTOR viam.gen.provisioning.v1.provisioning_pb2.Global___ExitProvisioningRequest viam.gen.provisioning.v1.provisioning_pb2.Global___ExitProvisioningResponse viam.gen.provisioning.v1.provisioning_pb2.Global___GetSmartMachineStatusRequest viam.gen.provisioning.v1.provisioning_pb2.Global___GetSmartMachineStatusResponse viam.gen.provisioning.v1.provisioning_pb2.Global___SetNetworkCredentialsRequest viam.gen.provisioning.v1.provisioning_pb2.Global___SetNetworkCredentialsResponse viam.gen.provisioning.v1.provisioning_pb2.Global___SetSmartMachineCredentialsRequest viam.gen.provisioning.v1.provisioning_pb2.Global___SetSmartMachineCredentialsResponse viam.gen.provisioning.v1.provisioning_pb2.Global___GetNetworkListRequest viam.gen.provisioning.v1.provisioning_pb2.Global___GetNetworkListResponse viam.gen.provisioning.v1.provisioning_pb2.Global___ProvisioningInfo viam.gen.provisioning.v1.provisioning_pb2.Global___NetworkInfo viam.gen.provisioning.v1.provisioning_pb2.Global___CloudConfig viam.gen.provisioning.v1.provisioning_pb2.Global___APIKey Classes ------- .. autoapisummary:: viam.gen.provisioning.v1.provisioning_pb2.ExitProvisioningRequest viam.gen.provisioning.v1.provisioning_pb2.ExitProvisioningResponse viam.gen.provisioning.v1.provisioning_pb2.GetSmartMachineStatusRequest viam.gen.provisioning.v1.provisioning_pb2.GetSmartMachineStatusResponse viam.gen.provisioning.v1.provisioning_pb2.SetNetworkCredentialsRequest viam.gen.provisioning.v1.provisioning_pb2.SetNetworkCredentialsResponse viam.gen.provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsRequest viam.gen.provisioning.v1.provisioning_pb2.SetSmartMachineCredentialsResponse viam.gen.provisioning.v1.provisioning_pb2.GetNetworkListRequest viam.gen.provisioning.v1.provisioning_pb2.GetNetworkListResponse viam.gen.provisioning.v1.provisioning_pb2.ProvisioningInfo viam.gen.provisioning.v1.provisioning_pb2.NetworkInfo viam.gen.provisioning.v1.provisioning_pb2.CloudConfig viam.gen.provisioning.v1.provisioning_pb2.APIKey Module Contents --------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: ExitProvisioningRequest Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:type:: Global___ExitProvisioningRequest :canonical: ExitProvisioningRequest .. py:class:: ExitProvisioningResponse Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:type:: Global___ExitProvisioningResponse :canonical: ExitProvisioningResponse .. py:class:: GetSmartMachineStatusRequest Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:type:: Global___GetSmartMachineStatusRequest :canonical: GetSmartMachineStatusRequest .. py:class:: GetSmartMachineStatusResponse(*, provisioning_info: Global___ProvisioningInfo | None = ..., has_smart_machine_credentials: bool = ..., is_online: bool = ..., latest_connection_attempt: Global___NetworkInfo | None = ..., errors: collections.abc.Iterable[str] | None = ..., agent_version: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: has_smart_machine_credentials :type: bool .. py:attribute:: is_online :type: bool .. py:attribute:: agent_version :type: str .. py:method:: provisioning_info() -> Global___ProvisioningInfo .. py:method:: latest_connection_attempt() -> Global___NetworkInfo .. py:method:: errors() -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[str] .. py:method:: HasField(field_name: _HasFieldArgType) -> 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___GetSmartMachineStatusResponse :canonical: GetSmartMachineStatusResponse .. py:class:: SetNetworkCredentialsRequest(*, type: str = ..., ssid: str = ..., psk: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: type :type: str .. py:attribute:: ssid :type: str .. py:attribute:: psk :type: str .. py:type:: Global___SetNetworkCredentialsRequest :canonical: SetNetworkCredentialsRequest .. py:class:: SetNetworkCredentialsResponse Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:type:: Global___SetNetworkCredentialsResponse :canonical: SetNetworkCredentialsResponse .. py:class:: SetSmartMachineCredentialsRequest(*, cloud: Global___CloudConfig | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:method:: cloud() -> Global___CloudConfig .. py:method:: HasField(field_name: _HasFieldArgType) -> 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___SetSmartMachineCredentialsRequest :canonical: SetSmartMachineCredentialsRequest .. py:class:: SetSmartMachineCredentialsResponse Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:type:: Global___SetSmartMachineCredentialsResponse :canonical: SetSmartMachineCredentialsResponse .. py:class:: GetNetworkListRequest Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:type:: Global___GetNetworkListRequest :canonical: GetNetworkListRequest .. py:class:: GetNetworkListResponse(*, networks: collections.abc.Iterable[Global___NetworkInfo] | None = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:method:: networks() -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___NetworkInfo] .. py:type:: Global___GetNetworkListResponse :canonical: GetNetworkListResponse .. py:class:: ProvisioningInfo(*, fragment_id: str = ..., model: str = ..., manufacturer: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: fragment_id :type: str .. py:attribute:: model :type: str .. py:attribute:: manufacturer :type: str .. py:type:: Global___ProvisioningInfo :canonical: ProvisioningInfo .. py:class:: NetworkInfo(*, type: str = ..., ssid: str = ..., security: str = ..., signal: int = ..., connected: bool = ..., last_error: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: type :type: str .. py:attribute:: ssid :type: str .. py:attribute:: security :type: str .. py:attribute:: signal :type: int .. py:attribute:: connected :type: bool .. py:attribute:: last_error :type: str .. py:type:: Global___NetworkInfo :canonical: NetworkInfo .. py:class:: CloudConfig(*, id: str = ..., secret: str = ..., app_address: str = ..., api_key: Global___APIKey | None = ...) Bases: :py:obj:`google.protobuf.message.Message` minimal CloudConfig to create /etc/viam.json .. py:attribute:: id :type: str SmartMachine part id .. py:attribute:: secret :type: str SmartMachine part secret .. py:attribute:: app_address :type: str .. py:method:: api_key() -> Global___APIKey .. py:method:: HasField(field_name: _HasFieldArgType) -> 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:type:: Global___CloudConfig :canonical: CloudConfig .. py:class:: APIKey(*, id: str = ..., key: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Abstract base class for protocol messages. Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below. .. py:attribute:: id :type: str .. py:attribute:: key :type: str .. py:type:: Global___APIKey :canonical: APIKey