Job 操作

初始化 Job 任务



请求参数（InitiateJobRequest）

变量名	类型	描述
vaultId	String	待新建Job的Vault的ID
archiveId	String	待下载的Archive的ID，可选参数
type	JobType	Job类型
description	String	Job的描述字段
retrievalRange	Range	待下载的Archive字节范围，可选参数

接口定义/**
* 初始化Job同步接口
* @param initiateJobRequest 初始化Job请求对象
* @return
* @throws OASClientException
* @throws OASServerException
*/
public InitiateJobResult initiateJob(InitiateJobRequest initiateJobRequest)
    throws OASClientException, OASServerException;

/**
* 初始化Job异步接口
* @param initiateJobRequest 初始化Job请求对象
* @param handler 异步请求处理器
* @return
* @throws OASClientException
* @throws OASServerException
*/
public <T> ListenableFuture<T> initiateJobAsync(
    InitiateJobRequest initiateJobRequest, AsyncHandler<T> handler)
    throws OASClientException, OASServerException;




响应结果（InitiateJobResult）

变量名	类型	描述
location	String	创建成功的Job的URI
jobId	String	创建成功的Job的ID

Job Output 下载



请求参数（GetJobOutputRequest）

变量名	类型	描述
vaultId	String	待下载的Job所属Vault的ID
jobId	String	待下载的Job的ID
range	Range	待下载的字节范围
file	File	保存下载结果的文件

接口定义/**
* Job Output下载同步接口
* @param getJobOutputRequest Job Output下载请求对象
* @return
* @throws OASClientException
* @throws OASServerException
*/
public GetJobOutputResult getJobOutput(GetJobOutputRequest getJobOutputRequest)
    throws OASClientException, OASServerException;

/**
* Job Output下载异步接口
* @param getJobOutputRequest Job Output下载请求对象
* @param handler 异步请求处理器
* @return
* @throws OASClientException
* @throws OASServerException
*/
public <T> ListenableFuture<T> getJobOutputAsync(
    GetJobOutputRequest getJobOutputRequest, AsyncHandler<T> handler)
    throws OASClientException, OASServerException;




响应结果（GetJobOutputResult）

变量名	类型	描述
file	File	保存下载结果的文件
contentEtag	String	校验码字段，可能为空
range	Range	下载的字节范围，可能为空
sizeTotal	long	下载的字节长度

获取 Job 列表



请求参数（ListJobsRequest）

变量名	类型	描述
vaultId	String	待查询的Vault的ID
limit	int	返回列表的最大长度
marker	String	列表的起始标识

接口定义/**
* 获取Job列表同步接口
* @param listJobsRequest 获取Job列表请求对象
* @return
* @throws OASClientException
* @throws OASServerException
*/
public ListJobsResult listJobs(ListJobsRequest listJobsRequest)
    throws OASClientException, OASServerException;

/**
* 获取Job列表异步接口
* @param listJobsRequest 获取Job列表请求对象
* @param handler 异步请求处理器
* @return
* @throws OASClientException
* @throws OASServerException
*/
public <T> ListenableFuture<T> listJobsAsync(
    ListJobsRequest listJobsRequest, AsyncHandler<T> handler)
    throws OASClientException, OASServerException;




响应结果（ListVaultsResult）

变量名	类型	描述
marker	String	下一次查询的起始标识
vaultList	List<VaultDescriptor>	Job的JSON描述列表

Job 任务状态查询



请求参数（DescribeJobRequest）

变量名	类型	描述
vaultId	String	待查询的Job所属Vault的ID
jobId	String	待查询的Job的ID

接口定义/**
* Job信息查询同步接口
* @param describeJobRequest Job信息查询请求对象
* @return
* @throws OASClientException
* @throws OASServerException
*/
public DescribeJobResult describeJob(DescribeJobRequest describeJobRequest)
    throws OASClientException, OASServerException;

/**
* Job信息查询异步接口
* @param describeJobRequest Job信息查询请求对象
* @param handler
* @return
* @throws OASClientException
* @throws OASServerException
*/
public <T> ListenableFuture<T> describeJobAsync(
    DescribeJobRequest describeJobRequest, AsyncHandler<T> handler)
    throws OASClientException, OASServerException;




响应结果（DescribeJobResult）

变量名	类型	描述
descriptor	JobDescriptor	Job的JSON描述

Descriptor


[backcolor=transparent]OASDescriptor是服务器返回的JSON数据的封装，以下各个类均是[backcolor=transparent]OASDescriptor的子类，本节仅介绍JSON标签与变量名之间的对应关系，每个JSON标签的具体含义请参阅API手册。[backcolor=transparent]OASDescriptor的每一个成员变量均带有getter、setter和with方法。

VaultDescriptor


[backcolor=transparent]VaultDescriptor是Vault的JSON描述的封装，详见API手册4.1.3节返回体。

JSON标签	变量名	类型
CreationDate	creationDate	Date
LastInventoryDate	lastInventoryDate	Date
NumberOfArchives	numberOfArchives	int
SizeInBytes	size	long
VaultId	vaultId	String
VaultName	vaultName	String

MultipartUploadDescriptor


[backcolor=transparent]MultipartUploadDescriptor是Multipart Upload任务的JSON描述的封装，详见API手册4.3.2一节返回体。注意，当调用获取Multipart Upload任务列表接口（API手册4.3.2）时，partList为空列表。partList仅在调用获取Part列表接口（API手册4.3.5）时被设置。

JSON标签	变量名	类型
ArchiveDescription	description	String
CreationDate	creationDate	Date
MultipartUploadId	uploadId	String
PartSizeInBytes	partSize	long
Parts	partList	List<PartDescriptor>

PartDescriptor


[backcolor=transparent]PartDescriptor是Part的JSON描述的封装，详见API手册4.3.5一节返回体。

JSON标签	变量名	类型
ContentEtag	contentEtag	String
RangeInBytes	range	Range

JobDescriptor


[backcolor=transparent]JobDescriptor是Job任务的JSON描述的封装，详见API手册4.4.4一节返回体。

JSON标签	变量名	类型
Action	action	JobType
ArchiveId	archiveId	String
ArchiveSizeInBytes	archiveSize	long
ArchiveContentEtag	archiveContentEtag	String
Completed	completed	boolean
CompletionDate	completionDate	Date
CreationDate	creationDate	Date
InventorySizeInBytes	inventorySize	long
JobDescription	description	String
JobId	jobId	String
StatusCode	statusCode	JobStatus
StatusMessage	statusMessage	String

其他类型



JobStatus


枚举，表示Job任务状态，取值为 IN_PROGRESS， SUCCEEDED和 FAILED

JobType


枚举，表示Job任务类型，取值为 ARCHIVE_RETRIEVAL和 INVENTORY_RETRIEVAL

Range


类，范围的描述，包含 start和 end两个变量（[backcolor=transparent]long）