viam.gen.component.switch.v1.switch_pb2

@generated by mypy-protobuf. Do not edit manually! isort:skip_file

Attributes

`DESCRIPTOR`
`global___SetPositionRequest`
`global___SetPositionResponse`
`global___GetPositionRequest`
`global___GetPositionResponse`
`global___GetNumberOfPositionsRequest`
`global___GetNumberOfPositionsResponse`

Classes

`SetPositionRequest`	Abstract base class for protocol messages.
`SetPositionResponse`	Abstract base class for protocol messages.
`GetPositionRequest`	Abstract base class for protocol messages.
`GetPositionResponse`	Abstract base class for protocol messages.
`GetNumberOfPositionsRequest`	Abstract base class for protocol messages.
`GetNumberOfPositionsResponse`	Abstract base class for protocol messages.

Module Contents

viam.gen.component.switch.v1.switch_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor

class viam.gen.component.switch.v1.switch_pb2.SetPositionRequest(*, name: str = ..., position: int = ..., extra: 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.

name: str

position: int

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['extra', b'extra']) → 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.component.switch.v1.switch_pb2.global___SetPositionRequest

class viam.gen.component.switch.v1.switch_pb2.SetPositionResponse

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.component.switch.v1.switch_pb2.global___SetPositionResponse

class viam.gen.component.switch.v1.switch_pb2.GetPositionRequest(*, name: str = ..., extra: 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.

name: str

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['extra', b'extra']) → 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.component.switch.v1.switch_pb2.global___GetPositionRequest

class viam.gen.component.switch.v1.switch_pb2.GetPositionResponse(*, position: 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.

position: int

viam.gen.component.switch.v1.switch_pb2.global___GetPositionResponse

class viam.gen.component.switch.v1.switch_pb2.GetNumberOfPositionsRequest(*, name: str = ..., extra: 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.

name: str

property extra: google.protobuf.struct_pb2.Struct

HasField(field_name: Literal['extra', b'extra']) → 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.component.switch.v1.switch_pb2.global___GetNumberOfPositionsRequest

class viam.gen.component.switch.v1.switch_pb2.GetNumberOfPositionsResponse(*, number_of_positions: 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.

number_of_positions: int

viam.gen.component.switch.v1.switch_pb2.global___GetNumberOfPositionsResponse