samza-api/src/main/java/org/apache/samza/sql/udfs/SamzaSqlUdfMethod.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one
 * or more contributor license agreements.  See the NOTICE file
 * distributed with this work for additional information
 * regarding copyright ownership.  The ASF licenses this file
 * to you under the Apache License, Version 2.0 (the
 * "License"); you may not use this file except in compliance
 * with the License.  You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied.  See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */

package org.apache.samza.sql.udfs;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.apache.samza.sql.schema.SamzaSqlFieldType;


/**
 * Java annotation to identity the Samza SQL Udf method and it's argument types and return types.
 */
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
public @interface SamzaSqlUdfMethod {

  /**
   * Whether the argument check needs to be disabled. This is useful if the udf takes in
   * dynamic number of arguments
   */
  boolean disableArgumentCheck() default false;

  /**
   * Type of the arguments for the Samza SQL udf method
   */
  SamzaSqlFieldType[] params() default {};

  /**
   * Return type for the Samza SQL UDF
   */
  SamzaSqlFieldType returns() default SamzaSqlFieldType.ANY;
}