viam.proto.app.datapipelines

@generated by Viam. Do not edit manually!

Classes

DataPipelinesServiceBase

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

DataPipelinesServiceStub

UnimplementedDataPipelinesServiceBase

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

CreateDataPipelineRequest

Abstract base class for protocol messages.

CreateDataPipelineResponse

Abstract base class for protocol messages.

DataPipeline

Abstract base class for protocol messages.

DeleteDataPipelineRequest

Abstract base class for protocol messages.

DeleteDataPipelineResponse

Abstract base class for protocol messages.

GetDataPipelineRequest

Abstract base class for protocol messages.

GetDataPipelineResponse

Abstract base class for protocol messages.

ListDataPipelinesRequest

Abstract base class for protocol messages.

ListDataPipelinesResponse

Abstract base class for protocol messages.

UpdateDataPipelineRequest

Abstract base class for protocol messages.

UpdateDataPipelineResponse

Abstract base class for protocol messages.

Package Contents

class viam.proto.app.datapipelines.DataPipelinesServiceBase[source]

Bases: abc.ABC

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

abstract GetDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineResponse]) None[source]
Async:

abstract ListDataPipelines(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesRequest, app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesResponse]) None[source]
Async:

abstract CreateDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineResponse]) None[source]
Async:

abstract UpdateDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineResponse]) None[source]
Async:

abstract DeleteDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineResponse]) None[source]
Async:

__mapping__() Dict[str, grpclib.const.Handler][source]
class viam.proto.app.datapipelines.DataPipelinesServiceStub(channel: grpclib.client.Channel)[source]
GetDataPipeline
ListDataPipelines
CreateDataPipeline
UpdateDataPipeline
DeleteDataPipeline
class viam.proto.app.datapipelines.UnimplementedDataPipelinesServiceBase[source]

Bases: DataPipelinesServiceBase

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

async GetDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineResponse]) None[source]
async ListDataPipelines(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesRequest, app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesResponse]) None[source]
async CreateDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineResponse]) None[source]
async UpdateDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineResponse]) None[source]
async DeleteDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineResponse]) None[source]
class viam.proto.app.datapipelines.CreateDataPipelineRequest(*, organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: 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.

organization_id: str

The associated Viam organization ID.

name: str

A unique identifier at the org level.

schedule: str

A cron expression representing the expected execution schedule in UTC (note this also defines the input time window; an hourly schedule would process 1 hour of data at a time).

property mql_binary: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.

class viam.proto.app.datapipelines.CreateDataPipelineResponse(*, 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.

id: str

The ID of the newly created data pipeline.

class viam.proto.app.datapipelines.DataPipeline(*, id: str = ..., organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: str = ..., enabled: bool = ..., created_on: google.protobuf.timestamp_pb2.Timestamp | None = ..., updated_at: google.protobuf.timestamp_pb2.Timestamp | 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
organization_id: str

The associated Viam organization ID.

name: str

A unique identifier at the org level.

schedule: str

A cron expression representing the expected execution schedule in UTC (note this also defines the input time window; an hourly schedule would process 1 hour of data at a time).

enabled: bool

Whether or not the pipeline is enabled.

property mql_binary: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.

property created_on: google.protobuf.timestamp_pb2.Timestamp

The time the pipeline was created.

property updated_at: google.protobuf.timestamp_pb2.Timestamp

The time the pipeline was last updated.

HasField(field_name: Literal['created_on', b'created_on', 'updated_at', b'updated_at']) 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.datapipelines.DeleteDataPipelineRequest(*, 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.

id: str

The ID of the data pipeline to delete.

class viam.proto.app.datapipelines.DeleteDataPipelineResponse

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.datapipelines.GetDataPipelineRequest(*, 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.

id: str

The ID of the data pipeline to retrieve.

class viam.proto.app.datapipelines.GetDataPipelineResponse(*, data_pipeline: global___DataPipeline | 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 data_pipeline: global___DataPipeline
HasField(field_name: Literal['data_pipeline', b'data_pipeline']) 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.datapipelines.ListDataPipelinesRequest(*, organization_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.

organization_id: str

The associated Viam organization ID.

class viam.proto.app.datapipelines.ListDataPipelinesResponse(*, data_pipelines: collections.abc.Iterable[global___DataPipeline] | 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 data_pipelines: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DataPipeline]
class viam.proto.app.datapipelines.UpdateDataPipelineRequest(*, id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: str = ..., enabled: bool = ...)

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

The ID of the data pipeline to update.

name: str

A unique identifier at the org level.

schedule: str

A cron expression representing the expected execution schedule in UTC (note this also defines the input time window; an hourly schedule would process 1 hour of data at a time).

enabled: bool

Whether or not the pipeline is enabled.

property mql_binary: google.protobuf.internal.containers.RepeatedScalarFieldContainer[bytes]

A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.

class viam.proto.app.datapipelines.UpdateDataPipelineResponse

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.