viam.proto.app.packages

@generated by Viam. Do not edit manually!

Classes

`PackageServiceBase`	Helper class that provides a standard way to create an ABC using
`PackageServiceStub`
`UnimplementedPackageServiceBase`	Helper class that provides a standard way to create an ABC using
`CreatePackageRequest`	Abstract base class for protocol messages.
`CreatePackageResponse`	Returns the package ID and version which are populated in GetPackageRequest and DeletePackageRequest to
`DeletePackageRequest`	Abstract base class for protocol messages.
`DeletePackageResponse`	Abstract base class for protocol messages.
`FileInfo`	Abstract base class for protocol messages.
`GetPackageRequest`	Abstract base class for protocol messages.
`GetPackageResponse`	Abstract base class for protocol messages.
`ListPackagesRequest`	Abstract base class for protocol messages.
`ListPackagesResponse`	Abstract base class for protocol messages.
`Package`	Abstract base class for protocol messages.
`PackageInfo`	Abstract base class for protocol messages.
`PackageType`

Package Contents

class viam.proto.app.packages.PackageServiceBase[source]

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

abstractmethod CreatePackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.CreatePackageRequest, app.packages.v1.packages_pb2.CreatePackageResponse]) → None[source]

Async:

abstractmethod DeletePackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.DeletePackageRequest, app.packages.v1.packages_pb2.DeletePackageResponse]) → None[source]

Async:

abstractmethod GetPackage(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.GetPackageRequest, app.packages.v1.packages_pb2.GetPackageResponse]) → None[source]

Async:

abstractmethod ListPackages(stream: grpclib.server.Stream[app.packages.v1.packages_pb2.ListPackagesRequest, app.packages.v1.packages_pb2.ListPackagesResponse]) → None[source]

Async:

__mapping__() → Dict[str, grpclib.const.Handler][source]

class viam.proto.app.packages.PackageServiceStub(channel: grpclib.client.Channel)[source]

CreatePackage

DeletePackage

GetPackage

ListPackages

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.

contents: bytes: .tar.gz file

info() → Global___PackageInfo

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, 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: _WhichOneofArgType_package) → _WhichOneofReturnType_package | 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 = ..., is_directory: 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.

name: str

size: int

is_directory: bool

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, 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: _WhichOneofArgType__is_directory) → _WhichOneofReturnType__is_directory | 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.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: _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, 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: _WhichOneofArgType__include_url) → _WhichOneofReturnType__include_url | None

WhichOneof(oneof_group: _WhichOneofArgType__platform) → _WhichOneofReturnType__platform | None

WhichOneof(oneof_group: _WhichOneofArgType__type) → _WhichOneofReturnType__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.

package() → Global___Package

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, 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: _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, 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: _WhichOneofArgType__include_url) → _WhichOneofReturnType__include_url | None

WhichOneof(oneof_group: _WhichOneofArgType__name) → _WhichOneofReturnType__name | None

WhichOneof(oneof_group: _WhichOneofArgType__type) → _WhichOneofReturnType__type | None

WhichOneof(oneof_group: _WhichOneofArgType__version) → _WhichOneofReturnType__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.

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.

url: str

checksum: str

id: str

info() → Global___PackageInfo

created_on() → google.protobuf.timestamp_pb2.Timestamp

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, 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.

organization_id: str

name: str

version: str

type: Global___PackageType

platform: str

files() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___FileInfo]

metadata() → google.protobuf.struct_pb2.Struct

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, 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: _WhichOneofArgType__platform) → _WhichOneofReturnType__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