viam.gen.app.datapipelines.v1.data_pipelines_pb2
@generated by mypy-protobuf. Do not edit manually! isort:skip_file
Attributes
Classes
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
Abstract base class for protocol messages. |
|
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.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 = ..., 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.
- 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