com.tencentcloudapi.ckafka.v20190819.models

Class DescribeInstancesDetailRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.DescribeInstancesDetailRequest

public class DescribeInstancesDetailRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeInstancesDetailRequest()
DescribeInstancesDetailRequest(DescribeInstancesDetailRequest 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.
String	getInstanceId() Get (Filter) filter by instance ID
String[]	getInstanceIdList() Get Filter by instance ID.
String	getInstanceIds() Get This parameter has been deprecated and replaced with `InstanceIdList`.
Long	getLimit() Get Number of returned results.
Long	getOffset() Get Offset.
String	getSearchWord() Get Filter by instance name, instance ID, AZ, VPC ID, or subnet ID.
Long[]	getStatus() Get (Filter) instance status.
String	getTagKey() Get Tag key match.
Tag[]	getTagList() Get Filter instances by a set of tags
void	setFilters(Filter[] Filters) Set Filter.
void	setInstanceId(String InstanceId) Set (Filter) filter by instance ID
void	setInstanceIdList(String[] InstanceIdList) Set Filter by instance ID.
void	setInstanceIds(String InstanceIds) Set This parameter has been deprecated and replaced with `InstanceIdList`.
void	setLimit(Long Limit) Set Number of returned results.
void	setOffset(Long Offset) Set Offset.
void	setSearchWord(String SearchWord) Set Filter by instance name, instance ID, AZ, VPC ID, or subnet ID.
void	setStatus(Long[] Status) Set (Filter) instance status.
void	setTagKey(String TagKey) Set Tag key match.
void	setTagList(Tag[] TagList) Set Filter instances by a set of tags
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, getMultipartRequestParams, set, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, toJsonString

Methods inherited from class java.lang.Object

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

Constructor Detail

DescribeInstancesDetailRequest

public DescribeInstancesDetailRequest()

DescribeInstancesDetailRequest

public DescribeInstancesDetailRequest(DescribeInstancesDetailRequest 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

getInstanceId

public String getInstanceId()

Get (Filter) filter by instance ID

Returns:

InstanceId (Filter) filter by instance ID

setInstanceId

public void setInstanceId(String InstanceId)

Set (Filter) filter by instance ID

Parameters:

InstanceId - (Filter) filter by instance ID

getSearchWord

public String getSearchWord()

Get Filter by instance name, instance ID, AZ, VPC ID, or subnet ID. Fuzzy query is supported.

Returns:

SearchWord Filter by instance name, instance ID, AZ, VPC ID, or subnet ID. Fuzzy query is supported.

setSearchWord

public void setSearchWord(String SearchWord)

Set Filter by instance name, instance ID, AZ, VPC ID, or subnet ID. Fuzzy query is supported.

Parameters:

SearchWord - Filter by instance name, instance ID, AZ, VPC ID, or subnet ID. Fuzzy query is supported.

getStatus

public Long[] getStatus()

Get (Filter) instance status. 0: creating, 1: running, 2: deleting. If this parameter is left empty, all instances will be returned by default

Returns:

Status (Filter) instance status. 0: creating, 1: running, 2: deleting. If this parameter is left empty, all instances will be returned by default

setStatus

public void setStatus(Long[] Status)

Set (Filter) instance status. 0: creating, 1: running, 2: deleting. If this parameter is left empty, all instances will be returned by default

Parameters:

Status - (Filter) instance status. 0: creating, 1: running, 2: deleting. If this parameter is left empty, all instances will be returned by default

getOffset

public Long getOffset()

Get Offset. If this parameter is left empty, `0` will be used by default.

Returns:

Offset Offset. If this parameter is left empty, `0` will be used by default.

setOffset

public void setOffset(Long Offset)

Set Offset. If this parameter is left empty, `0` will be used by default.

Parameters:

Offset - Offset. If this parameter is left empty, `0` will be used by default.

getLimit

public Long getLimit()

Get Number of returned results. If this parameter is left empty, `10` will be used by default. The maximum value is `20`.

Returns:

Limit Number of returned results. If this parameter is left empty, `10` will be used by default. The maximum value is `20`.

setLimit

public void setLimit(Long Limit)

Set Number of returned results. If this parameter is left empty, `10` will be used by default. The maximum value is `20`.

Parameters:

Limit - Number of returned results. If this parameter is left empty, `10` will be used by default. The maximum value is `20`.

getTagKey

public String getTagKey()

Get Tag key match.

Returns:

TagKey Tag key match.

setTagKey

public void setTagKey(String TagKey)

Set Tag key match.

Parameters:

TagKey - Tag key match.

getFilters

public Filter[] getFilters()

Get Filter. Valid values of `filter.Name` include `Ip`, `VpcId`, `SubNetId`, `InstanceType`, and `InstanceId`. Up to 10 values can be passed for `filter.Values`.

Returns:

Filters Filter. Valid values of `filter.Name` include `Ip`, `VpcId`, `SubNetId`, `InstanceType`, and `InstanceId`. Up to 10 values can be passed for `filter.Values`.

setFilters

public void setFilters(Filter[] Filters)

Set Filter. Valid values of `filter.Name` include `Ip`, `VpcId`, `SubNetId`, `InstanceType`, and `InstanceId`. Up to 10 values can be passed for `filter.Values`.

Parameters:

Filters - Filter. Valid values of `filter.Name` include `Ip`, `VpcId`, `SubNetId`, `InstanceType`, and `InstanceId`. Up to 10 values can be passed for `filter.Values`.

getInstanceIds

public String getInstanceIds()

Get This parameter has been deprecated and replaced with `InstanceIdList`.

Returns:

InstanceIds This parameter has been deprecated and replaced with `InstanceIdList`.

setInstanceIds

public void setInstanceIds(String InstanceIds)

Set This parameter has been deprecated and replaced with `InstanceIdList`.

Parameters:

InstanceIds - This parameter has been deprecated and replaced with `InstanceIdList`.

getInstanceIdList

public String[] getInstanceIdList()

Get Filter by instance ID.

Returns:

InstanceIdList Filter by instance ID.

setInstanceIdList

public void setInstanceIdList(String[] InstanceIdList)

Set Filter by instance ID.

Parameters:

InstanceIdList - Filter by instance ID.

getTagList

public Tag[] getTagList()

Get Filter instances by a set of tags

Returns:

TagList Filter instances by a set of tags

setTagList

public void setTagList(Tag[] TagList)

Set Filter instances by a set of tags

Parameters:

TagList - Filter instances by a set of tags

toMap

public void toMap(HashMap<String,String> map,
                  String prefix)

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel