Class SapTableSource


public final class SapTableSource extends TabularSource
A copy activity source for SAP Table source.
  • Constructor Details

    • SapTableSource

      public SapTableSource()
  • Method Details

    • rowCount

      public Object rowCount()
      Get the rowCount property: The number of rows to be retrieved. Type: integer(or Expression with resultType integer).
      Returns:
      the rowCount value.
    • withRowCount

      public SapTableSource withRowCount(Object rowCount)
      Set the rowCount property: The number of rows to be retrieved. Type: integer(or Expression with resultType integer).
      Parameters:
      rowCount - the rowCount value to set.
      Returns:
      the SapTableSource object itself.
    • rowSkips

      public Object rowSkips()
      Get the rowSkips property: The number of rows that will be skipped. Type: integer (or Expression with resultType integer).
      Returns:
      the rowSkips value.
    • withRowSkips

      public SapTableSource withRowSkips(Object rowSkips)
      Set the rowSkips property: The number of rows that will be skipped. Type: integer (or Expression with resultType integer).
      Parameters:
      rowSkips - the rowSkips value to set.
      Returns:
      the SapTableSource object itself.
    • rfcTableFields

      public Object rfcTableFields()
      Get the rfcTableFields property: The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).
      Returns:
      the rfcTableFields value.
    • withRfcTableFields

      public SapTableSource withRfcTableFields(Object rfcTableFields)
      Set the rfcTableFields property: The fields of the SAP table that will be retrieved. For example, column0, column1. Type: string (or Expression with resultType string).
      Parameters:
      rfcTableFields - the rfcTableFields value to set.
      Returns:
      the SapTableSource object itself.
    • rfcTableOptions

      public Object rfcTableOptions()
      Get the rfcTableOptions property: The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).
      Returns:
      the rfcTableOptions value.
    • withRfcTableOptions

      public SapTableSource withRfcTableOptions(Object rfcTableOptions)
      Set the rfcTableOptions property: The options for the filtering of the SAP Table. For example, COLUMN0 EQ SOME VALUE. Type: string (or Expression with resultType string).
      Parameters:
      rfcTableOptions - the rfcTableOptions value to set.
      Returns:
      the SapTableSource object itself.
    • batchSize

      public Object batchSize()
      Get the batchSize property: Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).
      Returns:
      the batchSize value.
    • withBatchSize

      public SapTableSource withBatchSize(Object batchSize)
      Set the batchSize property: Specifies the maximum number of rows that will be retrieved at a time when retrieving data from SAP Table. Type: integer (or Expression with resultType integer).
      Parameters:
      batchSize - the batchSize value to set.
      Returns:
      the SapTableSource object itself.
    • customRfcReadTableFunctionModule

      public Object customRfcReadTableFunctionModule()
      Get the customRfcReadTableFunctionModule property: Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
      Returns:
      the customRfcReadTableFunctionModule value.
    • withCustomRfcReadTableFunctionModule

      public SapTableSource withCustomRfcReadTableFunctionModule(Object customRfcReadTableFunctionModule)
      Set the customRfcReadTableFunctionModule property: Specifies the custom RFC function module that will be used to read data from SAP Table. Type: string (or Expression with resultType string).
      Parameters:
      customRfcReadTableFunctionModule - the customRfcReadTableFunctionModule value to set.
      Returns:
      the SapTableSource object itself.
    • sapDataColumnDelimiter

      public Object sapDataColumnDelimiter()
      Get the sapDataColumnDelimiter property: The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
      Returns:
      the sapDataColumnDelimiter value.
    • withSapDataColumnDelimiter

      public SapTableSource withSapDataColumnDelimiter(Object sapDataColumnDelimiter)
      Set the sapDataColumnDelimiter property: The single character that will be used as delimiter passed to SAP RFC as well as splitting the output data retrieved. Type: string (or Expression with resultType string).
      Parameters:
      sapDataColumnDelimiter - the sapDataColumnDelimiter value to set.
      Returns:
      the SapTableSource object itself.
    • partitionOption

      public Object partitionOption()
      Get the partitionOption property: The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime".
      Returns:
      the partitionOption value.
    • withPartitionOption

      public SapTableSource withPartitionOption(Object partitionOption)
      Set the partitionOption property: The partition mechanism that will be used for SAP table read in parallel. Possible values include: "None", "PartitionOnInt", "PartitionOnCalendarYear", "PartitionOnCalendarMonth", "PartitionOnCalendarDate", "PartitionOnTime".
      Parameters:
      partitionOption - the partitionOption value to set.
      Returns:
      the SapTableSource object itself.
    • partitionSettings

      public SapTablePartitionSettings partitionSettings()
      Get the partitionSettings property: The settings that will be leveraged for SAP table source partitioning.
      Returns:
      the partitionSettings value.
    • withPartitionSettings

      public SapTableSource withPartitionSettings(SapTablePartitionSettings partitionSettings)
      Set the partitionSettings property: The settings that will be leveraged for SAP table source partitioning.
      Parameters:
      partitionSettings - the partitionSettings value to set.
      Returns:
      the SapTableSource object itself.
    • withQueryTimeout

      public SapTableSource withQueryTimeout(Object queryTimeout)
      Set the queryTimeout property: Query timeout. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Overrides:
      withQueryTimeout in class TabularSource
      Parameters:
      queryTimeout - the queryTimeout value to set.
      Returns:
      the TabularSource object itself.
    • withAdditionalColumns

      public SapTableSource withAdditionalColumns(Object additionalColumns)
      Set the additionalColumns property: Specifies the additional columns to be added to source data. Type: array of objects(AdditionalColumns) (or Expression with resultType array of objects).
      Overrides:
      withAdditionalColumns in class TabularSource
      Parameters:
      additionalColumns - the additionalColumns value to set.
      Returns:
      the TabularSource object itself.
    • withSourceRetryCount

      public SapTableSource withSourceRetryCount(Object sourceRetryCount)
      Set the sourceRetryCount property: Source retry count. Type: integer (or Expression with resultType integer).
      Overrides:
      withSourceRetryCount in class TabularSource
      Parameters:
      sourceRetryCount - the sourceRetryCount value to set.
      Returns:
      the CopySource object itself.
    • withSourceRetryWait

      public SapTableSource withSourceRetryWait(Object sourceRetryWait)
      Set the sourceRetryWait property: Source retry wait. Type: string (or Expression with resultType string), pattern: ((\d+)\.)?(\d\d):(60|([0-5][0-9])):(60|([0-5][0-9])).
      Overrides:
      withSourceRetryWait in class TabularSource
      Parameters:
      sourceRetryWait - the sourceRetryWait value to set.
      Returns:
      the CopySource object itself.
    • withMaxConcurrentConnections

      public SapTableSource withMaxConcurrentConnections(Object maxConcurrentConnections)
      Set the maxConcurrentConnections property: The maximum concurrent connection count for the source data store. Type: integer (or Expression with resultType integer).
      Overrides:
      withMaxConcurrentConnections in class TabularSource
      Parameters:
      maxConcurrentConnections - the maxConcurrentConnections value to set.
      Returns:
      the CopySource object itself.
    • withDisableMetricsCollection

      public SapTableSource withDisableMetricsCollection(Object disableMetricsCollection)
      Set the disableMetricsCollection property: If true, disable data store metrics collection. Default is false. Type: boolean (or Expression with resultType boolean).
      Overrides:
      withDisableMetricsCollection in class TabularSource
      Parameters:
      disableMetricsCollection - the disableMetricsCollection value to set.
      Returns:
      the CopySource object itself.
    • validate

      public void validate()
      Validates the instance.
      Overrides:
      validate in class TabularSource
      Throws:
      IllegalArgumentException - thrown if the instance is not valid.