:py:mod:`viam.gen.app.packages.v1.packages_pb2` =============================================== .. py:module:: viam.gen.app.packages.v1.packages_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Module Contents --------------- Classes ~~~~~~~ .. autoapisummary:: viam.gen.app.packages.v1.packages_pb2.PackageType viam.gen.app.packages.v1.packages_pb2.FileInfo viam.gen.app.packages.v1.packages_pb2.PackageInfo viam.gen.app.packages.v1.packages_pb2.CreatePackageRequest viam.gen.app.packages.v1.packages_pb2.CreatePackageResponse viam.gen.app.packages.v1.packages_pb2.DeletePackageRequest viam.gen.app.packages.v1.packages_pb2.DeletePackageResponse viam.gen.app.packages.v1.packages_pb2.Package viam.gen.app.packages.v1.packages_pb2.GetPackageRequest viam.gen.app.packages.v1.packages_pb2.GetPackageResponse viam.gen.app.packages.v1.packages_pb2.ListPackagesRequest viam.gen.app.packages.v1.packages_pb2.ListPackagesResponse Attributes ~~~~~~~~~~ .. autoapisummary:: viam.gen.app.packages.v1.packages_pb2.DESCRIPTOR viam.gen.app.packages.v1.packages_pb2.PACKAGE_TYPE_UNSPECIFIED viam.gen.app.packages.v1.packages_pb2.PACKAGE_TYPE_ARCHIVE viam.gen.app.packages.v1.packages_pb2.PACKAGE_TYPE_ML_MODEL viam.gen.app.packages.v1.packages_pb2.PACKAGE_TYPE_MODULE viam.gen.app.packages.v1.packages_pb2.PACKAGE_TYPE_SLAM_MAP viam.gen.app.packages.v1.packages_pb2.PACKAGE_TYPE_ML_TRAINING viam.gen.app.packages.v1.packages_pb2.global___PackageType viam.gen.app.packages.v1.packages_pb2.global___FileInfo viam.gen.app.packages.v1.packages_pb2.global___PackageInfo viam.gen.app.packages.v1.packages_pb2.global___CreatePackageRequest viam.gen.app.packages.v1.packages_pb2.global___CreatePackageResponse viam.gen.app.packages.v1.packages_pb2.global___DeletePackageRequest viam.gen.app.packages.v1.packages_pb2.global___DeletePackageResponse viam.gen.app.packages.v1.packages_pb2.global___Package viam.gen.app.packages.v1.packages_pb2.global___GetPackageRequest viam.gen.app.packages.v1.packages_pb2.global___GetPackageResponse viam.gen.app.packages.v1.packages_pb2.global___ListPackagesRequest viam.gen.app.packages.v1.packages_pb2.global___ListPackagesResponse .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: PackageType Bases: :py:obj:`_PackageType` .. py:data:: PACKAGE_TYPE_UNSPECIFIED :type: PackageType .. py:data:: PACKAGE_TYPE_ARCHIVE :type: PackageType .. py:data:: PACKAGE_TYPE_ML_MODEL :type: PackageType .. py:data:: PACKAGE_TYPE_MODULE :type: PackageType .. py:data:: PACKAGE_TYPE_SLAM_MAP :type: PackageType .. py:data:: PACKAGE_TYPE_ML_TRAINING :type: PackageType .. py:data:: global___PackageType .. py:class:: FileInfo(*, name: str = ..., size: int = ..., is_directory: bool | 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:attribute:: name :type: str .. py:attribute:: size :type: int .. py:attribute:: is_directory :type: bool .. py:method:: HasField(field_name: Literal[_is_directory, b'_is_directory', is_directory, b'is_directory']) -> 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:method:: WhichOneof(oneof_group: Literal[_is_directory, b'_is_directory']) -> Literal[is_directory] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___FileInfo .. py:class:: PackageInfo(*, organization_id: str = ..., name: str = ..., version: str = ..., type: global___PackageType = ..., platform: str | None = ..., files: collections.abc.Iterable[global___FileInfo] | None = ..., metadata: google.protobuf.struct_pb2.Struct | 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:property:: files :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FileInfo] .. py:property:: metadata :type: google.protobuf.struct_pb2.Struct .. py:attribute:: organization_id :type: str .. py:attribute:: name :type: str .. py:attribute:: version :type: str .. py:attribute:: type :type: global___PackageType .. py:attribute:: platform :type: str .. py:method:: HasField(field_name: Literal[_platform, b'_platform', metadata, b'metadata', platform, b'platform']) -> 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:method:: WhichOneof(oneof_group: Literal[_platform, b'_platform']) -> Literal[platform] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___PackageInfo .. py:class:: CreatePackageRequest(*, info: global___PackageInfo | None = ..., contents: bytes = ...) 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:property:: info :type: global___PackageInfo .. py:attribute:: contents :type: bytes .tar.gz file .. py:method:: HasField(field_name: Literal[contents, b'contents', info, b'info', package, b'package']) -> 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:method:: WhichOneof(oneof_group: Literal[package, b'package']) -> Literal[info, contents] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___CreatePackageRequest .. py:class:: CreatePackageResponse(*, id: str = ..., version: str = ...) Bases: :py:obj:`google.protobuf.message.Message` Returns the package ID and version which are populated in GetPackageRequest and DeletePackageRequest to retrieve or delete this package. .. py:attribute:: id :type: str .. py:attribute:: version :type: str .. py:data:: global___CreatePackageResponse .. py:class:: DeletePackageRequest(*, id: str = ..., version: str = ..., type: global___PackageType = ...) 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:: version :type: str .. py:attribute:: type :type: global___PackageType .. py:data:: global___DeletePackageRequest .. py:class:: DeletePackageResponse 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:data:: global___DeletePackageResponse .. py:class:: Package(*, info: global___PackageInfo | None = ..., url: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., checksum: str = ..., id: 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:property:: info :type: global___PackageInfo .. py:property:: created_on :type: google.protobuf.timestamp_pb2.Timestamp .. py:attribute:: url :type: str .. py:attribute:: checksum :type: str .. py:attribute:: id :type: str .. py:method:: HasField(field_name: Literal[created_on, b'created_on', info, b'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, :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:data:: global___Package .. py:class:: GetPackageRequest(*, id: str = ..., version: str = ..., include_url: bool | None = ..., type: global___PackageType | None = ..., platform: str | 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:attribute:: id :type: str .. py:attribute:: version :type: str .. py:attribute:: include_url :type: bool .. py:attribute:: type :type: global___PackageType .. py:attribute:: platform :type: str .. py:method:: HasField(field_name: Literal[_include_url, b'_include_url', _platform, b'_platform', _type, b'_type', include_url, b'include_url', platform, b'platform', type, b'type']) -> 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:method:: WhichOneof(oneof_group: Literal[_include_url, b'_include_url']) -> Literal[include_url] | None WhichOneof(oneof_group: Literal[_platform, b'_platform']) -> Literal[platform] | None WhichOneof(oneof_group: Literal[_type, b'_type']) -> Literal[type] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___GetPackageRequest .. py:class:: GetPackageResponse(*, package: global___Package | 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:property:: package :type: global___Package .. py:method:: HasField(field_name: Literal[package, b'package']) -> 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:data:: global___GetPackageResponse .. py:class:: ListPackagesRequest(*, organization_id: str = ..., name: str | None = ..., version: str | None = ..., type: global___PackageType | None = ..., include_url: bool | 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:attribute:: organization_id :type: str .. py:attribute:: name :type: str .. py:attribute:: version :type: str .. py:attribute:: type :type: global___PackageType .. py:attribute:: include_url :type: bool .. py:method:: HasField(field_name: Literal[_include_url, b'_include_url', _name, b'_name', _type, b'_type', _version, b'_version', include_url, b'include_url', name, b'name', type, b'type', version, b'version']) -> 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:method:: WhichOneof(oneof_group: Literal[_include_url, b'_include_url']) -> Literal[include_url] | None WhichOneof(oneof_group: Literal[_name, b'_name']) -> Literal[name] | None WhichOneof(oneof_group: Literal[_type, b'_type']) -> Literal[type] | None WhichOneof(oneof_group: Literal[_version, b'_version']) -> Literal[version] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___ListPackagesRequest .. py:class:: ListPackagesResponse(*, packages: collections.abc.Iterable[global___Package] | 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:property:: packages :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Package] .. py:data:: global___ListPackagesResponse