Package com.google.cloud.bigquery

Class RoutineInfo

java.lang.Object
com.google.cloud.bigquery.RoutineInfo
All Implemented Interfaces:
Serializable
Direct Known Subclasses:
Routine
public class RoutineInfo extends Object implements Serializable
Google BigQuery routine information. A Routine is an API abstraction that encapsulates several related concepts inside the BigQuery service, including scalar user defined functions (UDFS) and stored procedures.

For more information about the REST representation of routines, see: https://cloud.google.com/bigquery/docs/reference/rest/v2/routines

For more information about working with scalar functions, see: https://cloud.google.com/bigquery/docs/reference/standard-sql/user-defined-functions

See Also:

  • Method Details

    • getRoutineId

      public RoutineId getRoutineId()
      Returns the RoutineId identified for the routine resource. *

    • getEtag

      public String getEtag()
      Returns the hash of the routine resource.

    • getRoutineType

      public String getRoutineType()
      Returns the type of the routine, e.g. SCALAR_FUNCTION.

    • getCreationTime

      public Long getCreationTime()
      Returns the creation time of the routine, represented as milliseconds since the epoch.

    • getDescription

      public String getDescription()
      Returns the description of the routine.

    • getDeterminismLevel

      public String getDeterminismLevel()
      Returns the determinism level of the JavaScript UDF if defined.

    • getLastModifiedTime

      public Long getLastModifiedTime()
      Returns the last modification time of the routine, represented as milliseconds since the epoch.

    • getLanguage

      public String getLanguage()
      Returns the language of the routine. Currently supported languages include SQL and JAVASCRIPT.

    • getArguments

      public List<RoutineArgument> getArguments()
      Returns the list of arguments for the routine.

    • getReturnType

      public StandardSQLDataType getReturnType()
      If specified, returns the data type returned from the routine.

    • getReturnTableType

      public StandardSQLTableType getReturnTableType()
      If specified, returns the table type returned from the routine.

    • getImportedLibraries

      public List<String> getImportedLibraries()
      Returns the list of imported libraries for the routine. Only relevant for routines implemented using the JAVASCRIPT language.

    • getBody

      public String getBody()
      Returns the definition body of the routine.

    • getRemoteFunctionOptions

      public RemoteFunctionOptions getRemoteFunctionOptions()
      Returns the Remote function specific options.

    • getDataGovernanceType

      public String getDataGovernanceType()
      Returns the data governance type of the routine, e.g. DATA_MASKING.

    • toBuilder

      public RoutineInfo.Builder toBuilder()
      Returns a builder pre-populated using the current values of this routine.

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object

    • newBuilder

      public static RoutineInfo.Builder newBuilder(RoutineId routineId)
      Returns a builder for a RoutineInfo object given routine identity.

    • of

      public static RoutineInfo of(RoutineId routineId)
      Returns a RoutineInfo object given routine identity.