viam.gen.app.datapipelines.v1.data_pipelines_pb2

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

Attributes

DESCRIPTOR

DATA_PIPELINE_RUN_STATUS_UNSPECIFIED

DATA_PIPELINE_RUN_STATUS_SCHEDULED

DATA_PIPELINE_RUN_STATUS_STARTED

DATA_PIPELINE_RUN_STATUS_COMPLETED

DATA_PIPELINE_RUN_STATUS_FAILED

global___DataPipelineRunStatus

global___DataPipeline

global___GetDataPipelineRequest

global___GetDataPipelineResponse

global___ListDataPipelinesRequest

global___ListDataPipelinesResponse

global___CreateDataPipelineRequest

global___CreateDataPipelineResponse

global___UpdateDataPipelineRequest

global___UpdateDataPipelineResponse

global___DeleteDataPipelineRequest

global___DeleteDataPipelineResponse

global___EnableDataPipelineRequest

global___EnableDataPipelineResponse

global___DisableDataPipelineRequest

global___DisableDataPipelineResponse

global___ListDataPipelineRunsRequest

global___ListDataPipelineRunsResponse

global___DataPipelineRun

Classes

DataPipelineRunStatus

DataPipeline

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.

CreateDataPipelineRequest

Abstract base class for protocol messages.

CreateDataPipelineResponse

Abstract base class for protocol messages.

UpdateDataPipelineRequest

Abstract base class for protocol messages.

UpdateDataPipelineResponse

Abstract base class for protocol messages.

DeleteDataPipelineRequest

Abstract base class for protocol messages.

DeleteDataPipelineResponse

Abstract base class for protocol messages.

EnableDataPipelineRequest

Abstract base class for protocol messages.

EnableDataPipelineResponse

Abstract base class for protocol messages.

DisableDataPipelineRequest

Abstract base class for protocol messages.

DisableDataPipelineResponse

Abstract base class for protocol messages.

ListDataPipelineRunsRequest

Abstract base class for protocol messages.

ListDataPipelineRunsResponse

Abstract base class for protocol messages.

DataPipelineRun

Abstract base class for protocol messages.

Module Contents

viam.gen.app.datapipelines.v1.data_pipelines_pb2.DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.DataPipelineRunStatus

Bases: _DataPipelineRunStatus

viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_UNSPECIFIED: DataPipelineRunStatus
viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_SCHEDULED: DataPipelineRunStatus
viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_STARTED: DataPipelineRunStatus
viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_COMPLETED: DataPipelineRunStatus
viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_FAILED: DataPipelineRunStatus
viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DataPipelineRunStatus
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DataPipeline
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___GetDataPipelineRequest
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___GetDataPipelineResponse
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___ListDataPipelinesRequest
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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]
viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___ListDataPipelinesResponse
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___CreateDataPipelineRequest
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___CreateDataPipelineResponse
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineRequest(*, 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.

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

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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___UpdateDataPipelineRequest
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___UpdateDataPipelineResponse
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DeleteDataPipelineRequest
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DeleteDataPipelineResponse
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___EnableDataPipelineRequest
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___EnableDataPipelineResponse
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DisableDataPipelineRequest
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DisableDataPipelineResponse
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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
viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___ListDataPipelineRunsRequest
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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.

property runs: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DataPipelineRun]

The runs that were run.

viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___ListDataPipelineRunsResponse
class viam.gen.app.datapipelines.v1.data_pipelines_pb2.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 = ...)

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.

property start_time: google.protobuf.timestamp_pb2.Timestamp

The time the run started.

property end_time: google.protobuf.timestamp_pb2.Timestamp

The time the run ended.

property data_start_time: google.protobuf.timestamp_pb2.Timestamp

The start time of the data that was processed in the run.

property data_end_time: google.protobuf.timestamp_pb2.Timestamp

The end time of the data that was processed in the run.

HasField(field_name: Literal['data_end_time', b'data_end_time', 'data_start_time', b'data_start_time', 'end_time', b'end_time', 'start_time', b'start_time']) 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.app.datapipelines.v1.data_pipelines_pb2.global___DataPipelineRun