Package viam.app.datapipelines.v1

Interface DataPipelines.CreateDataPipelineRequestOrBuilder

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

  • Method Summary

    Modifier and Type
    Method
    Description
    Data.TabularDataSourceType
    getDataSourceType()
    The type of data source for the pipeline.
    int
    getDataSourceTypeValue()
    The type of data source for the pipeline.
    boolean
    getEnableBackfill()
    When true, pipeline runs will be scheduled for the organization's past data.
    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).
    boolean
    hasDataSourceType()
    The type of data source for the pipeline.
    boolean
    hasEnableBackfill()
    When true, pipeline runs will be scheduled for the organization's past data.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getOrganizationId

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

    • getOrganizationIdBytes

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

    • getName

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

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       A unique identifier at the org level.
      string name = 2 [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 = 3 [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 = 3 [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 = 3 [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 = 4 [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 = 4 [json_name = "schedule"];
      Returns:
      The bytes for schedule.

    • hasEnableBackfill

      boolean hasEnableBackfill()
       When true, pipeline runs will be scheduled for the organization's past data.
      optional bool enable_backfill = 5 [json_name = "enableBackfill"];
      Returns:
      Whether the enableBackfill field is set.

    • getEnableBackfill

      boolean getEnableBackfill()
       When true, pipeline runs will be scheduled for the organization's past data.
      optional bool enable_backfill = 5 [json_name = "enableBackfill"];
      Returns:
      The enableBackfill.

    • 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 = 6 [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 = 6 [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 = 6 [json_name = "dataSourceType"];
      Returns:
      The dataSourceType.