Package cern.nxcals.api.custom.service

Interface FundamentalService

  • public interface FundamentalService

    • Method Summary

      All Methods Instance Methods Abstract Methods Default Methods 
      Modifier and Type Method Description
      org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getAll​(TimeWindow timeWindow, java.util.Set<FundamentalFilter> fundamentalFilters)
      Return a Dataset for a given time window that contains data for fundamental variables that are matching the provided set of fundamental filters.
      default org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getFor​(TimeWindow timeWindow, java.lang.String accelerator)
      Return a Dataset for a given time window that contains data of fundamental variables for specified machine.
      default org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getFor​(TimeWindow timeWindow, java.lang.String accelerator, java.lang.String... accelerators)
      Return a Dataset for a given time window that contains data of fundamental variables for specified machines.
      org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getFor​(TimeWindow timeWindow, java.util.Collection<java.lang.String> accelerators)
      Return a Dataset for a given time window that contains data of fundamental variables for specified machines.

    • Method Detail

      • getAll

        org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getAll​(TimeWindow timeWindow,
                                                              java.util.Set<FundamentalFilter> fundamentalFilters)
        Return a Dataset for a given time window that contains data for fundamental variables that are matching the provided set of fundamental filters. Please, note that variables are obtained from each filter separately and then joined/unioned together. I.e. variable will be included if it satisfies any of the provided filters.
        Parameters:
        timeWindow - a TimeWindow that defines time bounds for the data search
        fundamentalFilters - a set of FundamentalFilter based on which fundamental variables are selected.
        Returns:
        a Dataset with data for fundamental variables based on the fundamental filters

      • getFor

        @Experimental
default org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getFor​(TimeWindow timeWindow,
                                                                      java.lang.String accelerator)
        Return a Dataset for a given time window that contains data of fundamental variables for specified machine.
        Parameters:
        timeWindow - a TimeWindow that defines time bounds for the data search
        accelerator - a String with machine name.
        Returns:
        a Dataset with data for fundamental variable for given machine

      • getFor

        @Experimental
org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getFor​(TimeWindow timeWindow,
                                                              java.util.Collection<java.lang.String> accelerators)
        Return a Dataset for a given time window that contains data of fundamental variables for specified machines.
        Parameters:
        timeWindow - a TimeWindow that defines time bounds for the data search
        accelerators - a Collection with machine names.
        Returns:
        a Dataset with data for fundamental variable for given machine

      • getFor

        @Experimental
default org.apache.spark.sql.Dataset<org.apache.spark.sql.Row> getFor​(TimeWindow timeWindow,
                                                                      java.lang.String accelerator,
                                                                      java.lang.String... accelerators)
        Return a Dataset for a given time window that contains data of fundamental variables for specified machines.
        Parameters:
        timeWindow - a TimeWindow that defines time bounds for the data search
        accelerators - a Collection with machine names.
        Returns:
        a Dataset with data for fundamental variable for given machine