com.tencentcloudapi.ckafka.v20190819.models

Class DescribeInstancesRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.ckafka.v20190819.models.DescribeInstancesRequest

public class DescribeInstancesRequest
extends AbstractModel

Field Summary

Fields inherited from class com.tencentcloudapi.common.AbstractModel

header, skipSign

Constructor Summary

Constructors

Constructor and Description
DescribeInstancesRequest()
DescribeInstancesRequest(DescribeInstancesRequest 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
String	getInstanceId() Get (Filter) filter by instance ID
Long	getLimit() Get Number of results to be returned.
Long	getOffset() Get Offset.
String	getSearchWord() Get (Filter) filter by instance name.
Long[]	getStatus() Get (Filter) instance status.
String	getTagKey() Get Tag key value (this field has been deprecated).
String	getVpcId() Get VPC ID.
void	setInstanceId(String InstanceId) Set (Filter) filter by instance ID
void	setLimit(Long Limit) Set Number of results to be returned.
void	setOffset(Long Offset) Set Offset.
void	setSearchWord(String SearchWord) Set (Filter) filter by instance name.
void	setStatus(Long[] Status) Set (Filter) instance status.
void	setTagKey(String TagKey) Set Tag key value (this field has been deprecated).
void	setVpcId(String VpcId) Set VPC ID.
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

DescribeInstancesRequest

public DescribeInstancesRequest()

DescribeInstancesRequest

public DescribeInstancesRequest(DescribeInstancesRequest 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) filter by instance name. Fuzzy search is supported

Returns:

SearchWord (Filter) filter by instance name. Fuzzy search is supported

setSearchWord

public void setSearchWord(String SearchWord)

Set (Filter) filter by instance name. Fuzzy search is supported

Parameters:

SearchWord - (Filter) filter by instance name. Fuzzy search 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 results to be returned. If this parameter is left empty, 10 will be used by default. The maximum value is 100.

Returns:

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

setLimit

public void setLimit(Long Limit)

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

Parameters:

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

getTagKey

public String getTagKey()

Get Tag key value (this field has been deprecated).

Returns:

TagKey Tag key value (this field has been deprecated).

setTagKey

public void setTagKey(String TagKey)

Set Tag key value (this field has been deprecated).

Parameters:

TagKey - Tag key value (this field has been deprecated).

getVpcId

public String getVpcId()

Get VPC ID.

Returns:

VpcId VPC ID.

setVpcId

public void setVpcId(String VpcId)

Set VPC ID.

Parameters:

VpcId - VPC ID.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel

Parameters:

map - The map to populate with the model's parameters.

prefix - A string prefix for the keys.