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.
`DataPipelineRun`	Abstract base class for protocol messages.
`DataPipelineRunStatus`
`DeleteDataPipelineRequest`	Abstract base class for protocol messages.
`DeleteDataPipelineResponse`	Abstract base class for protocol messages.
`DisableDataPipelineRequest`	Abstract base class for protocol messages.
`DisableDataPipelineResponse`	Abstract base class for protocol messages.
`EnableDataPipelineRequest`	Abstract base class for protocol messages.
`EnableDataPipelineResponse`	Abstract base class for protocol messages.
`GetDataPipelineRequest`	Abstract base class for protocol messages.
`GetDataPipelineResponse`	Abstract base class for protocol messages.
`ListDataPipelineRunsRequest`	Abstract base class for protocol messages.
`ListDataPipelineRunsResponse`	Abstract base class for protocol messages.
`ListDataPipelinesRequest`	Abstract base class for protocol messages.
`ListDataPipelinesResponse`	Abstract base class for protocol messages.
`RenameDataPipelineRequest`	Abstract base class for protocol messages.
`RenameDataPipelineResponse`	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.

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

Async:

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

Async:

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

Async:

abstractmethod RenameDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.RenameDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.RenameDataPipelineResponse]) → None[source]

Async:

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

Async:

abstractmethod EnableDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineResponse]) → None[source]

Async:

abstractmethod DisableDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineResponse]) → None[source]

Async:

abstractmethod ListDataPipelineRuns(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsRequest, app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsResponse]) → None[source]

Async:

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

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

GetDataPipeline

ListDataPipelines

CreateDataPipeline

RenameDataPipeline

DeleteDataPipeline

EnableDataPipeline

DisableDataPipeline

ListDataPipelineRuns

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 RenameDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.RenameDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.RenameDataPipelineResponse]) → None[source]

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

async EnableDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineResponse]) → None[source]

async DisableDataPipeline(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineRequest, app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineResponse]) → None[source]

async ListDataPipelineRuns(stream: grpclib.server.Stream[app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsRequest, app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsResponse]) → None[source]

class viam.proto.app.datapipelines.CreateDataPipelineRequest(*, organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: str = ..., enable_backfill: bool | None = ..., data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType | 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: 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).

enable_backfill: bool: When true, pipeline runs will be scheduled for the organization’s past data.

data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType: The type of data source for the pipeline. If not specified, default is standard data storage.

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.

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__data_source_type) → _WhichOneofReturnType__data_source_type | None

WhichOneof(oneof_group: _WhichOneofArgType__enable_backfill) → _WhichOneofReturnType__enable_backfill | 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.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 = ..., data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType | 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.

data_source_type: app.data.v1.data_pb2.TabularDataSourceType.ValueType: The type of data source for the pipeline. If not specified, default is standard data storage.

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.

created_on() → google.protobuf.timestamp_pb2.Timestamp: The time the pipeline was created.

updated_at() → google.protobuf.timestamp_pb2.Timestamp: The time the pipeline was last updated.

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__data_source_type) → _WhichOneofReturnType__data_source_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.datapipelines.DataPipelineRun(*, id: str = ..., start_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., end_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., data_start_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., data_end_time: google.protobuf.timestamp_pb2.Timestamp | None = ..., status: Global___DataPipelineRunStatus = ..., error_message: 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 run.

status: Global___DataPipelineRunStatus: The status of the run.

error_message: str: The error message if the run failed.

start_time() → google.protobuf.timestamp_pb2.Timestamp: The time the run started.

end_time() → google.protobuf.timestamp_pb2.Timestamp: The time the run ended.

data_start_time() → google.protobuf.timestamp_pb2.Timestamp: The start time of the data that was processed in the run.

data_end_time() → google.protobuf.timestamp_pb2.Timestamp: The end time of the data that was processed in the run.

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.datapipelines.DataPipelineRunStatus: Bases: _DataPipelineRunStatus

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.DisableDataPipelineRequest(*, 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 disable.

class viam.proto.app.datapipelines.DisableDataPipelineResponse

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.EnableDataPipelineRequest(*, 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 enable.

class viam.proto.app.datapipelines.EnableDataPipelineResponse

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.

data_pipeline() → Global___DataPipeline

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.datapipelines.ListDataPipelineRunsRequest(*, id: str = ..., page_size: int = ..., page_token: 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 list runs for.

page_size: int: pagination fields

page_token: str

class viam.proto.app.datapipelines.ListDataPipelineRunsResponse(*, pipeline_id: str = ..., runs: collections.abc.Iterable[Global___DataPipelineRun] | None = ..., next_page_token: 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.

pipeline_id: str: The ID of the data pipeline the runs are for.

next_page_token: str: A token to retrieve the next page of results.

runs() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___DataPipelineRun]: The runs that were run.

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.

data_pipelines() → google.protobuf.internal.containers.RepeatedCompositeFieldContainer[Global___DataPipeline]

class viam.proto.app.datapipelines.RenameDataPipelineRequest(*, id: str = ..., name: 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 rename.

name: str: A unique identifier at the organization level.

class viam.proto.app.datapipelines.RenameDataPipelineResponse

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.