viam.gen.app.datapipelines.v1.data_pipelines_pb2 ================================================ .. py:module:: viam.gen.app.datapipelines.v1.data_pipelines_pb2 .. autoapi-nested-parse:: @generated by mypy-protobuf. Do not edit manually! isort:skip_file Attributes ---------- .. autoapisummary:: viam.gen.app.datapipelines.v1.data_pipelines_pb2.DESCRIPTOR viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_UNSPECIFIED viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_SCHEDULED viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_STARTED viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_COMPLETED viam.gen.app.datapipelines.v1.data_pipelines_pb2.DATA_PIPELINE_RUN_STATUS_FAILED viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DataPipelineRunStatus viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DataPipeline viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___GetDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___GetDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___ListDataPipelinesRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___ListDataPipelinesResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___CreateDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___CreateDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___UpdateDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___UpdateDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DeleteDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DeleteDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___EnableDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___EnableDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DisableDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DisableDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___ListDataPipelineRunsRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___ListDataPipelineRunsResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.global___DataPipelineRun Classes ------- .. autoapisummary:: viam.gen.app.datapipelines.v1.data_pipelines_pb2.DataPipelineRunStatus viam.gen.app.datapipelines.v1.data_pipelines_pb2.DataPipeline viam.gen.app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.GetDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.ListDataPipelinesResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.CreateDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.UpdateDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.DeleteDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.EnableDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.DisableDataPipelineResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsRequest viam.gen.app.datapipelines.v1.data_pipelines_pb2.ListDataPipelineRunsResponse viam.gen.app.datapipelines.v1.data_pipelines_pb2.DataPipelineRun Module Contents --------------- .. py:data:: DESCRIPTOR :type: google.protobuf.descriptor.FileDescriptor .. py:class:: DataPipelineRunStatus Bases: :py:obj:`_DataPipelineRunStatus` .. py:data:: DATA_PIPELINE_RUN_STATUS_UNSPECIFIED :type: DataPipelineRunStatus .. py:data:: DATA_PIPELINE_RUN_STATUS_SCHEDULED :type: DataPipelineRunStatus .. py:data:: DATA_PIPELINE_RUN_STATUS_STARTED :type: DataPipelineRunStatus .. py:data:: DATA_PIPELINE_RUN_STATUS_COMPLETED :type: DataPipelineRunStatus .. py:data:: DATA_PIPELINE_RUN_STATUS_FAILED :type: DataPipelineRunStatus .. py:data:: global___DataPipelineRunStatus .. py:class:: 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: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType | None = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str .. py:attribute:: organization_id :type: str The associated Viam organization ID. .. py:attribute:: name :type: str A unique identifier at the org level. .. py:attribute:: schedule :type: 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). .. py:attribute:: enabled :type: bool Whether or not the pipeline is enabled. .. py:attribute:: data_source_type :type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType The type of data source for the pipeline. If not specified, default is standard data storage. .. py:property:: mql_binary :type: 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. .. py:property:: created_on :type: google.protobuf.timestamp_pb2.Timestamp The time the pipeline was created. .. py:property:: updated_at :type: google.protobuf.timestamp_pb2.Timestamp The time the pipeline was last updated. .. py:method:: HasField(field_name: Literal['_data_source_type', b'_data_source_type', 'created_on', b'created_on', 'data_source_type', b'data_source_type', '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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group: Literal['_data_source_type', b'_data_source_type']) -> Literal['data_source_type'] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___DataPipeline .. py:class:: GetDataPipelineRequest(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str The ID of the data pipeline to retrieve. .. py:data:: global___GetDataPipelineRequest .. py:class:: GetDataPipelineResponse(*, data_pipeline: global___DataPipeline | None = ...) Bases: :py:obj:`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. .. py:property:: data_pipeline :type: global___DataPipeline .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___GetDataPipelineResponse .. py:class:: ListDataPipelinesRequest(*, organization_id: str = ...) Bases: :py:obj:`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. .. py:attribute:: organization_id :type: str The associated Viam organization ID. .. py:data:: global___ListDataPipelinesRequest .. py:class:: ListDataPipelinesResponse(*, data_pipelines: collections.abc.Iterable[global___DataPipeline] | None = ...) Bases: :py:obj:`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. .. py:property:: data_pipelines :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DataPipeline] .. py:data:: global___ListDataPipelinesResponse .. py:class:: CreateDataPipelineRequest(*, organization_id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: str = ..., enable_backfill: bool | None = ..., data_source_type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType | None = ...) Bases: :py:obj:`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. .. py:attribute:: organization_id :type: str The associated Viam organization ID. .. py:attribute:: name :type: str A unique identifier at the org level. .. py:attribute:: schedule :type: 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). .. py:attribute:: enable_backfill :type: bool When true, pipeline runs will be scheduled for the organization's past data. .. py:attribute:: data_source_type :type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType The type of data source for the pipeline. If not specified, default is standard data storage. .. py:property:: mql_binary :type: 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. .. py:method:: HasField(field_name: Literal['_data_source_type', b'_data_source_type', '_enable_backfill', b'_enable_backfill', 'data_source_type', b'data_source_type', 'enable_backfill', b'enable_backfill']) -> 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group: Literal['_data_source_type', b'_data_source_type']) -> Literal['data_source_type'] | None WhichOneof(oneof_group: Literal['_enable_backfill', b'_enable_backfill']) -> Literal['enable_backfill'] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___CreateDataPipelineRequest .. py:class:: CreateDataPipelineResponse(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str The ID of the newly created data pipeline. .. py:data:: global___CreateDataPipelineResponse .. py:class:: UpdateDataPipelineRequest(*, id: str = ..., name: str = ..., mql_binary: collections.abc.Iterable[bytes] | None = ..., schedule: str = ..., data_source_type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType | None = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str The ID of the data pipeline to update. .. py:attribute:: name :type: str A unique identifier at the org level. .. py:attribute:: schedule :type: 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). .. py:attribute:: data_source_type :type: viam.gen.app.data.v1.data_pb2.TabularDataSourceType.ValueType The type of data source for the pipeline. If not specified, default is standard data storage. .. py:property:: mql_binary :type: 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. .. py:method:: HasField(field_name: Literal['_data_source_type', b'_data_source_type', 'data_source_type', b'data_source_type']) -> 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:method:: WhichOneof(oneof_group: Literal['_data_source_type', b'_data_source_type']) -> Literal['data_source_type'] | None Returns the name of the field that is set inside a oneof group. If no field is set, returns None. :param oneof_group: the name of the oneof group to check. :type oneof_group: str :returns: The name of the group that is set, or None. :rtype: str or None :raises ValueError: no group with the given name exists .. py:data:: global___UpdateDataPipelineRequest .. py:class:: UpdateDataPipelineResponse Bases: :py:obj:`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. .. py:data:: global___UpdateDataPipelineResponse .. py:class:: DeleteDataPipelineRequest(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str The ID of the data pipeline to delete. .. py:data:: global___DeleteDataPipelineRequest .. py:class:: DeleteDataPipelineResponse Bases: :py:obj:`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. .. py:data:: global___DeleteDataPipelineResponse .. py:class:: EnableDataPipelineRequest(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str The ID of the data pipeline to enable. .. py:data:: global___EnableDataPipelineRequest .. py:class:: EnableDataPipelineResponse Bases: :py:obj:`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. .. py:data:: global___EnableDataPipelineResponse .. py:class:: DisableDataPipelineRequest(*, id: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str The ID of the data pipeline to disable. .. py:data:: global___DisableDataPipelineRequest .. py:class:: DisableDataPipelineResponse Bases: :py:obj:`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. .. py:data:: global___DisableDataPipelineResponse .. py:class:: ListDataPipelineRunsRequest(*, id: str = ..., page_size: int = ..., page_token: str = ...) Bases: :py:obj:`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. .. py:attribute:: id :type: str The ID of the data pipeline to list runs for. .. py:attribute:: page_size :type: int pagination fields .. py:attribute:: page_token :type: str .. py:data:: global___ListDataPipelineRunsRequest .. py:class:: ListDataPipelineRunsResponse(*, pipeline_id: str = ..., runs: collections.abc.Iterable[global___DataPipelineRun] | None = ..., next_page_token: str = ...) Bases: :py:obj:`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. .. py:attribute:: pipeline_id :type: str The ID of the data pipeline the runs are for. .. py:attribute:: next_page_token :type: str A token to retrieve the next page of results. .. py:property:: runs :type: google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___DataPipelineRun] The runs that were run. .. py:data:: global___ListDataPipelineRunsResponse .. py:class:: 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: :py:obj:`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. .. py:attribute:: id :type: str The ID of the run. .. py:attribute:: status :type: global___DataPipelineRunStatus The status of the run. .. py:property:: start_time :type: google.protobuf.timestamp_pb2.Timestamp The time the run started. .. py:property:: end_time :type: google.protobuf.timestamp_pb2.Timestamp The time the run ended. .. py:property:: data_start_time :type: google.protobuf.timestamp_pb2.Timestamp The start time of the data that was processed in the run. .. py:property:: data_end_time :type: google.protobuf.timestamp_pb2.Timestamp The end time of the data that was processed in the run. .. py:method:: 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, :exc:`ValueError` will be raised. :param field_name: The name of the field to check for presence. :type field_name: str :returns: Whether a value has been set for the named field. :rtype: bool :raises ValueError: if the `field_name` is not a member of this message. .. py:data:: global___DataPipelineRun