com.aliyun.odps

Class Odps

java.lang.Object

com.aliyun.odps.Odps

public class Odps
extends Object

Odps类是ODPS SDK的入口

构造Odps对象:

 
 Account account = new AliyunAccount("my_access_id", "my_access_key");

 Odps odps = new Odps(account);
 odps.setDefaultProject("my_project");

 for (Table t : odps.tables()) {
     ....
 }
 
 

设置默认Project:

SDK中很多集合类上提供的方法有两个版本，比如:

• odps.tables().get("table_name")
• odps.tables().get("project_name", "table_name")

第一个版本的函数会使用Odps对象上保存的默认Project，设置默认Project的方法如下:

 odps.setDefaultProject("my_project");
 

Constructor Summary

Constructors

Constructor and Description
Odps(Account account) 指定Account构造Odps对象
Odps(Account account, AppAccount appAccount)
Odps(Odps odps)

Method Summary

Modifier and Type	Method and Description
Classifications	classifications() 获取表示ODPS所有Classification的集合对象
Odps	clone()
Functions	functions() 获取表示ODPS所有Function的集合对象
Account	getAccount() 获取Account 暂未开放，仅限内部使用
AccountFormat	getAccountFormat() 获取参数 account 格式
AppAccount	getAppAccount() 获取AppAccount
AppStsAccount	getAppStsAccount() 获取AppStsAccount
String	getCurrentSchema() Get current schema.
String	getDefaultProject() 取得当前对象的默认Project名称
String	getEndpoint() 获取ODPS服务的地址
Map<String,String>	getGlobalSettings() 获取全局配置的副本（deep copy）
String	getLogViewHost() 获取logview host地址，可能为null
com.aliyun.odps.rest.RestClient	getRestClient() 获取ODPS底层传输接口
String	getUserAgent() 获取访问API时附加的User-Agent信息
Instances	instances() 获得表示ODPS所有Instance的集合对象
LogView	logview() 获取Logview工具类
OfflineModels	offlineModels()
Projects	projects() 获取表示ODPS所有Project的集合对象
Quotas	quotas()
Resources	resources() 获取表示ODPS所有Resource的集合对象
Schemas	schemas()
void	setAccount(Account account)
void	setAccountFormat(AccountFormat format) 设置参数 account 格式
void	setAppAccount(AppAccount appAccount)
void	setAppStsAccount(AppStsAccount appStsAccount)
void	setCurrentSchema(String schema) Set current schema.
void	setDefaultProject(String defaultProject) 指定默认使用的Project名称，同时将当前schema置为该project下的默认schema
void	setEndpoint(String endpoint) 设置ODPS服务的地址
void	setGlobalSettings(Map<String,String> settings) 设置全局配置，全局配置将会被替换为参数传入的配置
void	setLogViewHost(String host) 设置logview host地址
void	setUserAgent(String userAgent) 设置访问API时附加的User-Agent信息
Tables	tables() 获取表示ODPS所有Table的集合对象
Tenant	tenant()
Volumes	volumes() 获取表示ODPS所有Volumes的集合对象
XFlows	xFlows()

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Odps

public Odps(Account account)

指定Account构造Odps对象

Parameters:

account - 认证信息

Odps

public Odps(Account account,
            AppAccount appAccount)

Odps

public Odps(Odps odps)

Method Detail

setAccount

public void setAccount(Account account)

setAppAccount

public void setAppAccount(AppAccount appAccount)

setAppStsAccount

public void setAppStsAccount(AppStsAccount appStsAccount)

tenant

public Tenant tenant()

projects

public Projects projects()

获取表示ODPS所有Project的集合对象

Returns:

Projects

schemas

public Schemas schemas()

tables

public Tables tables()

获取表示ODPS所有Table的集合对象

Returns:

Tables

instances

public Instances instances()

获得表示ODPS所有Instance的集合对象

Returns:

Instances

resources

public Resources resources()

获取表示ODPS所有Resource的集合对象

Returns:

Resources

functions

public Functions functions()

获取表示ODPS所有Function的集合对象

Returns:

Functions

volumes

public Volumes volumes()

获取表示ODPS所有Volumes的集合对象

Returns:

Volumes

classifications

public Classifications classifications()

获取表示ODPS所有Classification的集合对象

quotas

public Quotas quotas()

getAccount

public Account getAccount()

获取Account 暂未开放，仅限内部使用

Returns:

Account

getAppAccount

public AppAccount getAppAccount()

获取AppAccount

Returns:

AppAccount

getAppStsAccount

public AppStsAccount getAppStsAccount()

获取AppStsAccount

Returns:

AppStsAccount

getEndpoint

public String getEndpoint()

获取ODPS服务的地址

Returns:

ODPS服务地址

setEndpoint

public void setEndpoint(String endpoint)

设置ODPS服务的地址

Parameters:

endpoint - ODPS服务地址

getDefaultProject

public String getDefaultProject()

取得当前对象的默认Project名称

Returns:

默认Project名称

getCurrentSchema

public String getCurrentSchema()

Get current schema.

Returns:

Current schema name. Null or empty string means using the default schema.

setDefaultProject

public void setDefaultProject(String defaultProject)

指定默认使用的Project名称，同时将当前schema置为该project下的默认schema

Parameters:

defaultProject - 默认Project名称，不允许为null或空串

setCurrentSchema

public void setCurrentSchema(String schema)

Set current schema.

Parameters:

schema - Schema name. Null or empty string means using the default schema.

setUserAgent

public void setUserAgent(String userAgent)

设置访问API时附加的User-Agent信息

Parameters:

userAgent - User Agent信息

getUserAgent

public String getUserAgent()

获取访问API时附加的User-Agent信息

Returns:

User Agent信息

logview

public LogView logview()

获取Logview工具类

Returns:

LogView

xFlows

public XFlows xFlows()

offlineModels

public OfflineModels offlineModels()

clone

public Odps clone()

Overrides:

clone in class Object

getRestClient

public com.aliyun.odps.rest.RestClient getRestClient()

获取ODPS底层传输接口

Returns:

RestClient

getLogViewHost

public String getLogViewHost()

获取logview host地址，可能为null

Returns:

logview host地址

setLogViewHost

public void setLogViewHost(String host)

设置logview host地址

Parameters:

host - 地址

setAccountFormat

public void setAccountFormat(AccountFormat format)

设置参数 account 格式

Parameters:

format - account 格式

getAccountFormat

public AccountFormat getAccountFormat()

获取参数 account 格式

Returns:

account 格式

setGlobalSettings

public void setGlobalSettings(Map<String,String> settings)

设置全局配置，全局配置将会被替换为参数传入的配置

Parameters:

settings - 新的全局配置

getGlobalSettings

public Map<String,String> getGlobalSettings()

获取全局配置的副本（deep copy）

Returns:

全局配置的副本