viam.proto.app.packages
@generated by Viam. Do not edit manually!
Package Contents
Classes
Helper class that provides a standard way to create an ABC using |
|
Helper class that provides a standard way to create an ABC using |
|
Abstract base class for protocol messages. |
|
Returns the package ID and version which are populated in GetPackageRequest and DeletePackageRequest to |
|
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. |
|
- class viam.proto.app.packages.PackageServiceBase[source]
Bases:
abc.ABC
Helper class that provides a standard way to create an ABC using inheritance.
- abstract async CreatePackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.CreatePackageRequest, app.packages.v1.packages_pb2.CreatePackageResponse]) None [source]
- abstract async DeletePackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.DeletePackageRequest, app.packages.v1.packages_pb2.DeletePackageResponse]) None [source]
- abstract async GetPackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.GetPackageRequest, app.packages.v1.packages_pb2.GetPackageResponse]) None [source]
- abstract async ListPackages(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.ListPackagesRequest, app.packages.v1.packages_pb2.ListPackagesResponse]) None [source]
- class viam.proto.app.packages.UnimplementedPackageServiceBase[source]
Bases:
PackageServiceBase
Helper class that provides a standard way to create an ABC using inheritance.
- async CreatePackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.CreatePackageRequest, app.packages.v1.packages_pb2.CreatePackageResponse]) None [source]
- async DeletePackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.DeletePackageRequest, app.packages.v1.packages_pb2.DeletePackageResponse]) None [source]
- async GetPackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.GetPackageRequest, app.packages.v1.packages_pb2.GetPackageResponse]) None [source]
- async ListPackages(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.ListPackagesRequest, app.packages.v1.packages_pb2.ListPackagesResponse]) None [source]
- class viam.proto.app.packages.CreatePackageRequest(*, info: global___PackageInfo | None = ..., contents: bytes = ...)
Bases:
google.protobuf.message.Message
Abstract base class for protocol messages.
Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.
- property info: global___PackageInfo
- contents: bytes
.tar.gz file
- 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,
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[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.
- 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
- class viam.proto.app.packages.CreatePackageResponse(*, id: str = ..., version: str = ...)
Bases:
google.protobuf.message.Message
Returns the package ID and version which are populated in GetPackageRequest and DeletePackageRequest to retrieve or delete this package.
- id: str
- version: str
- class viam.proto.app.packages.DeletePackageRequest(*, id: str = ..., version: str = ..., type: global___PackageType = ...)
Bases:
google.protobuf.message.Message
Abstract base class for 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
- version: str
- type: global___PackageType
- class viam.proto.app.packages.DeletePackageResponse
Bases:
google.protobuf.message.Message
Abstract base class for 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.proto.app.packages.FileInfo(*, name: str = ..., size: int = ...)
Bases:
google.protobuf.message.Message
Abstract base class for 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
- size: int
- class viam.proto.app.packages.GetPackageRequest(*, id: str = ..., version: str = ..., include_url: bool | None = ..., type: global___PackageType | None = ..., platform: 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
- version: str
- include_url: bool
- type: global___PackageType
- platform: str
- 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,
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[_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.
- 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
- class viam.proto.app.packages.GetPackageResponse(*, package: global___Package | 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 package: global___Package
- 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,
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.proto.app.packages.ListPackagesRequest(*, organization_id: str = ..., name: str | None = ..., version: str | None = ..., type: global___PackageType | None = ..., include_url: 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
- name: str
- version: str
- type: global___PackageType
- include_url: bool
- 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,
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[_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.
- 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
- class viam.proto.app.packages.ListPackagesResponse(*, packages: collections.abc.Iterable[global___Package] | 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 packages: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___Package]
- class viam.proto.app.packages.Package(*, info: global___PackageInfo | None = ..., url: str = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., checksum: str = ..., id: str = ...)
Bases:
google.protobuf.message.Message
Abstract base class for protocol messages.
Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.
- property info: global___PackageInfo
- property created_on: google.protobuf.timestamp_pb2.Timestamp
- url: str
- checksum: str
- id: str
- 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,
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.proto.app.packages.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:
google.protobuf.message.Message
Abstract base class for protocol messages.
Protocol message classes are almost always generated by the protocol compiler. These generated types subclass Message and implement the methods shown below.
- property files: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___FileInfo]
- property metadata: google.protobuf.struct_pb2.Struct
- organization_id: str
- name: str
- version: str
- type: global___PackageType
- platform: str
- 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,
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[_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.
- 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
- class viam.proto.app.packages.PackageType
Bases:
_PackageType