com.tencentcloudapi.batch.v20170312.models

Class DescribeJobsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.batch.v20170312.models.DescribeJobsRequest

public class DescribeJobsRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeJobsRequest()
DescribeJobsRequest(DescribeJobsRequest source) NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Summary

Modifier and Type	Method and Description
Filter[]	getFilters() Get 过滤条件 job-id - String - 是否必填：否 -（过滤条件）按照作业ID过滤。 job-name - String - 是否必填：否 -（过滤条件）按照作业名称过滤。 job-state - String - 是否必填：否 -（过滤条件）按照作业状态过滤。 - SUBMITTED：已提交； - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。 zone - String - 是否必填：否 -（过滤条件）按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。 tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - String - 是否必填：否 -（过滤条件）按照标签值进行过滤。 tag:tag-key - String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 与JobIds参数不能同时指定。
String[]	getJobIds() Get 作业ID列表，与Filters参数不能同时指定。
Long	getLimit() Get 返回job数量限制，最大值: 100，默认值: 20.
Long	getOffset() Get 偏移量
void	setFilters(Filter[] Filters) Set 过滤条件 job-id - String - 是否必填：否 -（过滤条件）按照作业ID过滤。 job-name - String - 是否必填：否 -（过滤条件）按照作业名称过滤。 job-state - String - 是否必填：否 -（过滤条件）按照作业状态过滤。 - SUBMITTED：已提交； - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。 zone - String - 是否必填：否 -（过滤条件）按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。 tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - String - 是否必填：否 -（过滤条件）按照标签值进行过滤。 tag:tag-key - String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 与JobIds参数不能同时指定。
void	setJobIds(String[] JobIds) Set 作业ID列表，与Filters参数不能同时指定。
void	setLimit(Long Limit) Set 返回job数量限制，最大值: 100，默认值: 20.
void	setOffset(Long Offset) Set 偏移量
void	toMap(HashMap<String,String> map, String prefix) Internal implementation, normal users should not use it.

Methods inherited from class com.tencentcloudapi.common.AbstractModel

any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeJobsRequest

public DescribeJobsRequest()

DescribeJobsRequest

public DescribeJobsRequest(DescribeJobsRequest source)

NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy, and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.

Method Detail

getJobIds

public String[] getJobIds()

Get 作业ID列表，与Filters参数不能同时指定。

Returns:

JobIds 作业ID列表，与Filters参数不能同时指定。

setJobIds

public void setJobIds(String[] JobIds)

Set 作业ID列表，与Filters参数不能同时指定。

Parameters:

JobIds - 作业ID列表，与Filters参数不能同时指定。

getFilters

public Filter[] getFilters()

Get 过滤条件

job-id - String - 是否必填：否 -（过滤条件）按照作业ID过滤。 job-name - String - 是否必填：否 -（过滤条件）按照作业名称过滤。 job-state - String - 是否必填：否 -（过滤条件）按照作业状态过滤。 - SUBMITTED：已提交； - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。 zone - String - 是否必填：否 -（过滤条件）按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。 tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - String - 是否必填：否 -（过滤条件）按照标签值进行过滤。 tag:tag-key - String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 与JobIds参数不能同时指定。

Returns:

Filters 过滤条件

job-id - String - 是否必填：否 -（过滤条件）按照作业ID过滤。

job-name - String - 是否必填：否 -（过滤条件）按照作业名称过滤。

job-state - String - 是否必填：否 -（过滤条件）按照作业状态过滤。

- SUBMITTED：已提交； - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。

zone - String - 是否必填：否 -（过滤条件）按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。

tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。

tag-value - String - 是否必填：否 -（过滤条件）按照标签值进行过滤。

tag:tag-key - String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。

与JobIds参数不能同时指定。

setFilters

public void setFilters(Filter[] Filters)

Set 过滤条件

job-id - String - 是否必填：否 -（过滤条件）按照作业ID过滤。 job-name - String - 是否必填：否 -（过滤条件）按照作业名称过滤。 job-state - String - 是否必填：否 -（过滤条件）按照作业状态过滤。 - SUBMITTED：已提交； - PENDING：等待中； - RUNNABLE：可运行； - STARTING：启动中； - RUNNING：运行中； - SUCCEED：成功； - FAILED：失败； - FAILED_INTERRUPTED：失败后保留实例。 zone - String - 是否必填：否 -（过滤条件）按照[可用区](https://cloud.tencent.com/document/product/213/15707)过滤。 tag-key - String - 是否必填：否 -（过滤条件）按照标签键进行过滤。 tag-value - String - 是否必填：否 -（过滤条件）按照标签值进行过滤。 tag:tag-key - String - 是否必填：否 -（过滤条件）按照标签键值对进行过滤。 tag-key使用具体的标签键进行替换。 与JobIds参数不能同时指定。