Package viam.app.datapipelines.v1

Interface DataPipelines.DataPipelineOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
DataPipelines.DataPipeline, DataPipelines.DataPipeline.Builder
Enclosing class:
DataPipelines
public static interface DataPipelines.DataPipelineOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Timestamp
    getCreatedOn()
    The time the pipeline was created.
    Data.TabularDataSourceType
    getDataSourceType()
    The type of data source for the pipeline.
    int
    getDataSourceTypeValue()
    The type of data source for the pipeline.
    boolean
    getEnabled()
    Whether or not the pipeline is enabled.
    String
    getId()
    string id = 1 [json_name = "id"];
    com.google.protobuf.ByteString
    getIdBytes()
    string id = 1 [json_name = "id"];
    com.google.protobuf.ByteString
    getMqlBinary(int index)
    A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.
    int
    getMqlBinaryCount()
    A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.
    List<com.google.protobuf.ByteString>
    getMqlBinaryList()
    A MongoDB aggregation pipeline as a list of BSON documents, where each document is one stage in the pipeline.
    String
    getName()
    A unique identifier at the org level.
    com.google.protobuf.ByteString
    getNameBytes()
    A unique identifier at the org level.
    String
    getOrganizationId()
    The associated Viam organization ID.
    com.google.protobuf.ByteString
    getOrganizationIdBytes()
    The associated Viam organization ID.
    String
    getSchedule()
    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).
    com.google.protobuf.ByteString
    getScheduleBytes()
    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).
    com.google.protobuf.Timestamp
    getUpdatedAt()
    The time the pipeline was last updated.
    boolean
    hasCreatedOn()
    The time the pipeline was created.
    boolean
    hasDataSourceType()
    The type of data source for the pipeline.
    boolean
    hasUpdatedAt()
    The time the pipeline was last updated.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getId

      String getId()
      string id = 1 [json_name = "id"];
      Returns:
      The id.

    • getIdBytes

      com.google.protobuf.ByteString getIdBytes()
      string id = 1 [json_name = "id"];
      Returns:
      The bytes for id.

    • getOrganizationId

      String getOrganizationId()
       The associated Viam organization ID.
      string organization_id = 2 [json_name = "organizationId"];
      Returns:
      The organizationId.

    • getOrganizationIdBytes

      com.google.protobuf.ByteString getOrganizationIdBytes()
       The associated Viam organization ID.
      string organization_id = 2 [json_name = "organizationId"];
      Returns:
      The bytes for organizationId.

    • getName

      String getName()
       A unique identifier at the org level.
      string name = 3 [json_name = "name"];
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       A unique identifier at the org level.
      string name = 3 [json_name = "name"];
      Returns:
      The bytes for name.

    • getMqlBinaryList

      List<com.google.protobuf.ByteString> getMqlBinaryList()
       A MongoDB aggregation pipeline as a list of BSON documents, where
 each document is one stage in the pipeline.
      repeated bytes mql_binary = 4 [json_name = "mqlBinary"];
      Returns:
      A list containing the mqlBinary.

    • getMqlBinaryCount

      int getMqlBinaryCount()
       A MongoDB aggregation pipeline as a list of BSON documents, where
 each document is one stage in the pipeline.
      repeated bytes mql_binary = 4 [json_name = "mqlBinary"];
      Returns:
      The count of mqlBinary.

    • getMqlBinary

      com.google.protobuf.ByteString getMqlBinary(int index)
       A MongoDB aggregation pipeline as a list of BSON documents, where
 each document is one stage in the pipeline.
      repeated bytes mql_binary = 4 [json_name = "mqlBinary"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The mqlBinary at the given index.

    • getSchedule

      String getSchedule()
       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).
      string schedule = 5 [json_name = "schedule"];
      Returns:
      The schedule.

    • getScheduleBytes

      com.google.protobuf.ByteString getScheduleBytes()
       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).
      string schedule = 5 [json_name = "schedule"];
      Returns:
      The bytes for schedule.

    • getEnabled

      boolean getEnabled()
       Whether or not the pipeline is enabled.
      bool enabled = 6 [json_name = "enabled"];
      Returns:
      The enabled.

    • hasCreatedOn

      boolean hasCreatedOn()
       The time the pipeline was created.
      .google.protobuf.Timestamp created_on = 7 [json_name = "createdOn"];
      Returns:
      Whether the createdOn field is set.

    • getCreatedOn

      com.google.protobuf.Timestamp getCreatedOn()
       The time the pipeline was created.
      .google.protobuf.Timestamp created_on = 7 [json_name = "createdOn"];
      Returns:
      The createdOn.

    • hasUpdatedAt

      boolean hasUpdatedAt()
       The time the pipeline was last updated.
      .google.protobuf.Timestamp updated_at = 8 [json_name = "updatedAt"];
      Returns:
      Whether the updatedAt field is set.

    • getUpdatedAt

      com.google.protobuf.Timestamp getUpdatedAt()
       The time the pipeline was last updated.
      .google.protobuf.Timestamp updated_at = 8 [json_name = "updatedAt"];
      Returns:
      The updatedAt.

    • hasDataSourceType

      boolean hasDataSourceType()
       The type of data source for the pipeline. If not specified, default is standard data storage.
      optional .viam.app.data.v1.TabularDataSourceType data_source_type = 9 [json_name = "dataSourceType"];
      Returns:
      Whether the dataSourceType field is set.

    • getDataSourceTypeValue

      int getDataSourceTypeValue()
       The type of data source for the pipeline. If not specified, default is standard data storage.
      optional .viam.app.data.v1.TabularDataSourceType data_source_type = 9 [json_name = "dataSourceType"];
      Returns:
      The enum numeric value on the wire for dataSourceType.

    • getDataSourceType

      Data.TabularDataSourceType getDataSourceType()
       The type of data source for the pipeline. If not specified, default is standard data storage.
      optional .viam.app.data.v1.TabularDataSourceType data_source_type = 9 [json_name = "dataSourceType"];
      Returns:
      The dataSourceType.