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 Filter `job-id` - String - Optional - Filter by the job ID. `job-name` - String - Optional - Filter by the job name. `job-state` - String - Optional - Filter by the job state. `zone` - String - Optional - Filter by the availability zone. `tag-key` - String - Optional - Tag key. `tag-value` - String - Optional - Tag value. `tag:tag-key` - String - Optional - Filter by the tag key-value pair.
String[]	getJobIds() Get List of job IDs.
Long	getLimit() Get Maximum number of returned items
Long	getOffset() Get Offset
void	setFilters(Filter[] Filters) Set Filter `job-id` - String - Optional - Filter by the job ID. `job-name` - String - Optional - Filter by the job name. `job-state` - String - Optional - Filter by the job state. `zone` - String - Optional - Filter by the availability zone. `tag-key` - String - Optional - Tag key. `tag-value` - String - Optional - Tag value. `tag:tag-key` - String - Optional - Filter by the tag key-value pair.
void	setJobIds(String[] JobIds) Set List of job IDs.
void	setLimit(Long Limit) Set Maximum number of returned items
void	setOffset(Long Offset) Set Offset
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, 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 List of job IDs. It cannot be specified together with `Filters`.

Returns:

JobIds List of job IDs. It cannot be specified together with `Filters`.

setJobIds

public void setJobIds(String[] JobIds)

Set List of job IDs. It cannot be specified together with `Filters`.

Parameters:

JobIds - List of job IDs. It cannot be specified together with `Filters`.

getFilters

public Filter[] getFilters()

Get Filter

`job-id` - String - Optional - Filter by the job ID. `job-name` - String - Optional - Filter by the job name. `job-state` - String - Optional - Filter by the job state. `zone` - String - Optional - Filter by the availability zone. `tag-key` - String - Optional - Tag key. `tag-value` - String - Optional - Tag value. `tag:tag-key` - String - Optional - Filter by the tag key-value pair. The tag-key should be replaced by a specified tag key. It cannot be specified together with `JobIds`.

Returns:

Filters Filter

`job-id` - String - Optional - Filter by the job ID.

`job-name` - String - Optional - Filter by the job name.

`job-state` - String - Optional - Filter by the job state.

`zone` - String - Optional - Filter by the availability zone.

`tag-key` - String - Optional - Tag key.

`tag-value` - String - Optional - Tag value.

`tag:tag-key` - String - Optional - Filter by the tag key-value pair. The tag-key should be replaced by a specified tag key.

It cannot be specified together with `JobIds`.

setFilters

public void setFilters(Filter[] Filters)

Set Filter

`job-id` - String - Optional - Filter by the job ID. `job-name` - String - Optional - Filter by the job name. `job-state` - String - Optional - Filter by the job state. `zone` - String - Optional - Filter by the availability zone. `tag-key` - String - Optional - Tag key. `tag-value` - String - Optional - Tag value. `tag:tag-key` - String - Optional - Filter by the tag key-value pair. The tag-key should be replaced by a specified tag key. It cannot be specified together with `JobIds`.