Snowpark Scala API Reference1.19.1 < Back
 

# Packages

-  package root
  Definition Classes
    root
-  package com
  Definition Classes
    root
-  package snowflake
  Definition Classes
    com
-  package snowpark
  Definition Classes
    snowflake
-  package udaf
  Definition Classes
    snowpark
- UDAF
- UDAF1
- UDAF10
- UDAF11
- UDAF12
- UDAF13
- UDAF14
- UDAF15
- UDAF16
- UDAF17
- UDAF18
- UDAF19
- UDAF2
- UDAF20
- UDAF21
- UDAF22
- UDAF3
- UDAF4
- UDAF5
- UDAF6
- UDAF7
- UDAF8
- UDAF9

t

com.snowflake.snowpark.udaf

# UDAF 

###

#### sealed trait UDAF extends Serializable

The Scala UDAF (user-defined aggregate function) trait.

Since

  1.19.0

Linear Supertypes
Serializable, AnyRef, Any
Known Subclasses
UDAF1, UDAF10, UDAF11, UDAF12, UDAF13, UDAF14, UDAF15, UDAF16, UDAF17, UDAF18, UDAF19, UDAF2, UDAF20, UDAF21, UDAF22, UDAF3, UDAF4, UDAF5, UDAF6, UDAF7, UDAF8, UDAF9
 
Ordering

1. Alphabetic
2. By Inheritance

Inherited

1. UDAF
2. Serializable
3. AnyRef
4. Any

1. Hide All
2. Show All

Visibility

1. Public
2. All

### Abstract Value Members

1.  abstract def outputType(): DataType

   A DataType that describes the type of the value returned by the terminate() method.

   A DataType that describes the type of the value returned by the terminate() method.

   For example, if a UDAF returns an integer value, outputType() should return IntegerType: {{ override def outputType(): DataType = IntegerType }}

   returns

     A DataType describing the output type.

   Since

     1.19.0

### Concrete Value Members

1.  final def !=(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
2.  final def ##(): Int
   Definition Classes
     AnyRef → Any
3.  final def ==(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
4.  final def asInstanceOf[T0]: T0
   Definition Classes
     Any
5.  def clone(): AnyRef
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( ... ) @native() @HotSpotIntrinsicCandidate()
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: Any): Boolean
   Definition Classes
     AnyRef → Any
8.  final def getClass(): Class[_]
   Definition Classes
     AnyRef → Any
   Annotations
     @native() @HotSpotIntrinsicCandidate()
9.  def hashCode(): Int
   Definition Classes
     AnyRef → Any
   Annotations
     @native() @HotSpotIntrinsicCandidate()
10.  def inputSchema(): StructType

    A StructType that describes the input schema of the aggregate function.

    A StructType that describes the input schema of the aggregate function. By default, returns an empty StructType.

    returns

      A StructType describing the input schema.

    Since

      1.19.0

11.  final def isInstanceOf[T0]: Boolean
    Definition Classes
      Any
12.  final def ne(arg0: AnyRef): Boolean
    Definition Classes
      AnyRef
13.  final def notify(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @HotSpotIntrinsicCandidate()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @native() @HotSpotIntrinsicCandidate()
15.  final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
      AnyRef
16.  def toString(): String
    Definition Classes
      AnyRef → Any
17.  final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )
18.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... ) @native()
19.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws( ... )

### Deprecated Value Members

1.  def finalize(): Unit
   Attributes
     protected[lang]
   Definition Classes
     AnyRef
   Annotations
     @throws( classOf[java.lang.Throwable] ) @Deprecated
   Deprecated

### Inherited from Serializable

### Inherited from AnyRef

### Inherited from Any

### Ungrouped