Function (ODPS SDK Core 0.51.10-public API)

java.lang.Object
- com.aliyun.odps.LazyLoad
- - com.aliyun.odps.Function

```
public class Function
extends LazyLoad
```
Function表示ODPS中的函数

Constructor Summary

Constructors
Constructor and Description

Function()

Constructors
Constructor and Description
`Function()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addSimpleTag(String category, String key, String value)` Attach a simple tag to this function.
`void`	`addTag(Tag tag)` Attach a `Tag` to this function.
`String`	`getClassPath()` 获得函数使用的类名
`String`	`getClassType()` Deprecated.
`Date`	`getCreatedTime()` 获取函数创建时间
`String`	`getEmbeddedFunctionCode()` Returns code if this is an embedded function, otherwise null
`String`	`getEmbeddedFunctionFilename()` Return filename if this is an embedded function, otherwise null
`String`	`getEmbeddedFunctionProgramLanguage()` Returns program language if this is an embedded function, otherwise null
`String`	`getName()` 获得函数名
`String`	`getOwner()` 获得函数所属用户
`String`	`getProject()` 获取函数所在`Project`名称
`List<String>`	`getResourceFullNames()` Get the full names of resources that this function depends on.
`List<String>`	`getResourceNames()` Deprecated.
`List<Resource>`	`getResources()` 获得函数相关的资源列表。UDF所用到的资源列表，这个里面必须包括UDF代码所在的资源。如果用户UDF中需要读取其他资源文件，这个列表中还得包括UDF所读取的资源文件列表。
`String`	`getSchemaName()`
`Map<String,Map<String,String>>`	`getSimpleTags()` Get simple tags attached to this function.
`String`	`getSqlDefinitionText()` Get the SQL definition text of this function.
`List<Tag>`	`getTags()` Get `Tag`(s) attached to this function.
`boolean`	`isEmbeddedFunction()` Returns true if this is an embedded function, otherwise false
`boolean`	`isSqlFunction()` Check if this function is a SQL function.
`void`	`reload()` 重新加载属性值
`void`	`removeSimpleTag(String category, String key, String value)` Remove a simple tag.
`void`	`removeTag(Tag tag)` Remove a `Tag`.
`void`	`setClassPath(String classPath)` 设置函数使用的类名
`void`	`setClassType(String classType)` Deprecated.
`void`	`setName(String name)` 设置函数名
`void`	`setResources(List<String> resources)` 设置函数依赖的相关资源
`void`	`updateOwner(String newOwner)`

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Function
```
public Function()
```
- Method Detail
  - getName
```
public String getName()
```
    获得函数名
    
    Returns:
    
    函数名
  - setName
```
public void setName(String name)
```
    设置函数名
    
    Parameters:
    
    name - 函数名
  - getOwner
```
public String getOwner()
```
    获得函数所属用户
    
    Returns:
    
    用户名
  - getCreatedTime
```
public Date getCreatedTime()
```
    获取函数创建时间
    
    Returns:
    
    函数创建时间
  - getClassType
```
@Deprecated
public String getClassType()
```
    Deprecated.
    
    使用getClassPath替代
  - getClassPath
```
public String getClassPath()
```
    获得函数使用的类名
    
    Returns:
    
    函数使用的类名
  - setClassType
```
@Deprecated
public void setClassType(String classType)
```
    Deprecated.
    
    建议使用setClassPath替代
  - setClassPath
```
public void setClassPath(String classPath)
```
    设置函数使用的类名
    
    Parameters:
    
    classPath - 函数使用的类名
  - getResources
```
public List<Resource> getResources()
```
    获得函数相关的资源列表。UDF所用到的资源列表，这个里面必须包括UDF代码所在的资源。如果用户UDF中需要读取其他资源文件，这个列表中还得包括UDF所读取的资源文件列表。
    
    Returns:
    
    资源列表
  - getResourceNames
```
@Deprecated
public List<String> getResourceNames()
```
    Deprecated.
    
    This method is deprecated. See getResourceFullNames()
  - getResourceFullNames
```
public List<String> getResourceFullNames()
```
    Get the full names of resources that this function depends on. This method lazy loads the function information, and a ReloadException will be thrown if lazy loading failed.
    
    Returns:
    
    Full names. Possible patters: /resources/ /schemas//resources/
  - setResources
```
public void setResources(List<String> resources)
```
    设置函数依赖的相关资源
    
    Parameters:
    
    resources - 资源列表
  - getProject
```
public String getProject()
```
    获取函数所在Project名称
    
    Returns:
    
    Project名称
  - getSchemaName
```
public String getSchemaName()
```
  - isSqlFunction
```
public boolean isSqlFunction()
```
    Check if this function is a SQL function.
    
    Returns:
    
    if this is a SQL function, return true, else false.
  - getSqlDefinitionText
```
public String getSqlDefinitionText()
```
    Get the SQL definition text of this function.
    
    Returns:
    
    if this is a SQL function, return the SQL definition text, else null.
  - isEmbeddedFunction
```
public boolean isEmbeddedFunction()
```
    Returns true if this is an embedded function, otherwise false
    
    Returns:
    
    true if this is an embedded function, otherwise false
  - getEmbeddedFunctionProgramLanguage
```
public String getEmbeddedFunctionProgramLanguage()
```
    Returns program language if this is an embedded function, otherwise null
    
    Returns:
    
    program language if this is an embedded function, otherwise null
  - getEmbeddedFunctionCode
```
public String getEmbeddedFunctionCode()
```
    Returns code if this is an embedded function, otherwise null
    
    Returns:
    
    code if this is an embedded function, otherwise null
  - getEmbeddedFunctionFilename
```
public String getEmbeddedFunctionFilename()
```
    Return filename if this is an embedded function, otherwise null
    
    Returns:
    
    filename if this is an embedded function, otherwise null
  - reload
```
public void reload()
            throws OdpsException
```
    Description copied from class: LazyLoad
    
    重新加载属性值
    
    Specified by:
    
    reload in class LazyLoad
    
    Throws:
    
    OdpsException
  - updateOwner
```
public void updateOwner(String newOwner)
                 throws OdpsException
```
    Throws:
    
    OdpsException
  - getTags
```
public List<Tag> getTags()
```
    Get Tag(s) attached to this function.
    
    Returns:
    
    list of Tag
  - getSimpleTags
```
public Map<String,Map<String,String>> getSimpleTags()
```
    Get simple tags attached to this function.
    
    Returns:
    
    a map from category to key value pairs
  - addTag
```
public void addTag(Tag tag)
            throws OdpsException
```
    Attach a Tag to this function. The function and tag should be in a same project.
    
    Parameters:
    
    tag - tag to attach
    
    Throws:
    
    OdpsException
  - addSimpleTag
```
public void addSimpleTag(String category,
                         String key,
                         String value)
                  throws OdpsException
```
    Attach a simple tag to this function. A simple tag is a triad consisted of category, tag key, and tag value.
    
    Parameters:
    
    category - simple tag category, could be nul.
    
    key - simple tag key, cannot be null.
    
    value - simple tag value, cannot be null.
    
    Throws:
    
    OdpsException
  - removeTag
```
public void removeTag(Tag tag)
               throws OdpsException
```
    Remove a Tag.
    
    Parameters:
    
    tag - tag to remove.
    
    Throws:
    
    OdpsException
  - removeSimpleTag
```
public void removeSimpleTag(String category,
                            String key,
                            String value)
                     throws OdpsException
```
    Remove a simple tag. A simple tag is a triad consisted of category, tag key, and tag value.
    
    Parameters:
    
    category - category.
    
    key - key.
    
    value - value.
    
    Throws:
    
    OdpsException

Class Function

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Function

Method Detail

getName

setName

getOwner

getCreatedTime

getClassType

getClassPath

setClassType

setClassPath

getResources

getResourceNames

getResourceFullNames

setResources

getProject

getSchemaName

isSqlFunction

getSqlDefinitionText

isEmbeddedFunction

getEmbeddedFunctionProgramLanguage

getEmbeddedFunctionCode

getEmbeddedFunctionFilename

reload

updateOwner

getTags

getSimpleTags

addTag

addSimpleTag

removeTag

removeSimpleTag