Snowpark Scala API Reference1.21.0 < 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

c

com.snowflake.snowpark.udaf

# UDAF21

###

#### abstract class UDAF21[S, O, A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20] extends UDAF

The Scala UDAF (user-defined aggregate function) abstract class that has 21 arguments.

S

  The type of the aggregation state.

O

  The type of the output value.

Since

  1.19.0

Linear Supertypes
UDAF, Serializable, AnyRef, Any

Ordering

1. Alphabetic
2. By Inheritance

Inherited

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

1. Hide All
2. Show All

Visibility

1. Public
2. Protected

### Instance Constructors

1.  new UDAF21()(implicit a0Tag: scala.reflect.api.JavaUniverse.TypeTag[A0], a1Tag: scala.reflect.api.JavaUniverse.TypeTag[A1], a2Tag: scala.reflect.api.JavaUniverse.TypeTag[A2], a3Tag: scala.reflect.api.JavaUniverse.TypeTag[A3], a4Tag: scala.reflect.api.JavaUniverse.TypeTag[A4], a5Tag: scala.reflect.api.JavaUniverse.TypeTag[A5], a6Tag: scala.reflect.api.JavaUniverse.TypeTag[A6], a7Tag: scala.reflect.api.JavaUniverse.TypeTag[A7], a8Tag: scala.reflect.api.JavaUniverse.TypeTag[A8], a9Tag: scala.reflect.api.JavaUniverse.TypeTag[A9], a10Tag: scala.reflect.api.JavaUniverse.TypeTag[A10], a11Tag: scala.reflect.api.JavaUniverse.TypeTag[A11], a12Tag: scala.reflect.api.JavaUniverse.TypeTag[A12], a13Tag: scala.reflect.api.JavaUniverse.TypeTag[A13], a14Tag: scala.reflect.api.JavaUniverse.TypeTag[A14], a15Tag: scala.reflect.api.JavaUniverse.TypeTag[A15], a16Tag: scala.reflect.api.JavaUniverse.TypeTag[A16], a17Tag: scala.reflect.api.JavaUniverse.TypeTag[A17], a18Tag: scala.reflect.api.JavaUniverse.TypeTag[A18], a19Tag: scala.reflect.api.JavaUniverse.TypeTag[A19], a20Tag: scala.reflect.api.JavaUniverse.TypeTag[A20])

### Abstract Value Members

1.  abstract def accumulate(state: S, arg0: A0, arg1: A1, arg2: A2, arg3: A3, arg4: A4, arg5: A5, arg6: A6, arg7: A7, arg8: A8, arg9: A9, arg10: A10, arg11: A11, arg12: A12, arg13: A13, arg14: A14, arg15: A15, arg16: A16, arg17: A17, arg18: A18, arg19: A19, arg20: A20): S

   Updates the aggregation state with a new input row.

   Updates the aggregation state with a new input row.

   state

     The current aggregation state.

   arg0

     The input value for argument 1.

   arg1

     The input value for argument 2.

   arg2

     The input value for argument 3.

   arg3

     The input value for argument 4.

   arg4

     The input value for argument 5.

   arg5

     The input value for argument 6.

   arg6

     The input value for argument 7.

   arg7

     The input value for argument 8.

   arg8

     The input value for argument 9.

   arg9

     The input value for argument 10.

   arg10

     The input value for argument 11.

   arg11

     The input value for argument 12.

   arg12

     The input value for argument 13.

   arg13

     The input value for argument 14.

   arg14

     The input value for argument 15.

   arg15

     The input value for argument 16.

   arg16

     The input value for argument 17.

   arg17

     The input value for argument 18.

   arg18

     The input value for argument 19.

   arg19

     The input value for argument 20.

   returns

     The updated aggregation state.

   Since

     1.19.0

2.  abstract def initialize(): S

   returns

     The initial state of the aggregation.

   Since

     1.19.0

3.  abstract def merge(state1: S, state2: S): S

   Merges two aggregation states into one.

   Merges two aggregation states into one.

   state1

     The first aggregation state.

   state2

     The second aggregation state.

   returns

     The merged aggregation state.

   Since

     1.19.0

4.  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.

   Definition Classes
     UDAF
   Since

     1.19.0

5.  abstract def terminate(state: S): O

   Produces the final output value from the aggregation state.

   Produces the final output value from the aggregation state.

   state

     The final aggregation state.

   returns

     The output value.

   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(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
6.  final def eq(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef
7.  def equals(arg0: AnyRef): Boolean
   Definition Classes
     AnyRef → Any
8.  final def getClass(): Class[_ <: AnyRef]
   Definition Classes
     AnyRef → Any
   Annotations
     @HotSpotIntrinsicCandidate() @native()
9.  def hashCode(): Int
   Definition Classes
     AnyRef → Any
   Annotations
     @HotSpotIntrinsicCandidate() @native()
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.

    Definition Classes
      UDAF
    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
      @HotSpotIntrinsicCandidate() @native()
14.  final def notifyAll(): Unit
    Definition Classes
      AnyRef
    Annotations
      @HotSpotIntrinsicCandidate() @native()
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(classOf[java.lang.InterruptedException])
18.  final def wait(arg0: Long): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException]) @native()
19.  final def wait(): Unit
    Definition Classes
      AnyRef
    Annotations
      @throws(classOf[java.lang.InterruptedException])

### Deprecated Value Members

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

     (Since version 9)

### Inherited from UDAF

### Inherited from Serializable

### Inherited from AnyRef

### Inherited from Any

### Ungrouped