com.tencentcloudapi.redis.v20180412.models

Class DescribeInstanceBackupsRequest

java.lang.Object

com.tencentcloudapi.common.AbstractModel

com.tencentcloudapi.redis.v20180412.models.DescribeInstanceBackupsRequest

public class DescribeInstanceBackupsRequest
extends AbstractModel

Constructor Summary

Constructors

Constructor and Description
DescribeInstanceBackupsRequest()
DescribeInstanceBackupsRequest(DescribeInstanceBackupsRequest 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	getBeginTime() Get Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 16:46:34.
String	getEndTime() Get End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 19:09:26.
String	getInstanceId() Get ID of the instance to be operated on, which can be obtained through the `InstanceId` field in the return value of the `DescribeInstance` API.
String	getInstanceName() Get Instance name, which can be fuzzily searched.
Long	getLimit() Get Number of backups returned per page.
Long	getOffset() Get Pagination offset, which is an integral multiple of `Limit`.
Long[]	getStatus() Get Backup task status: `1`: The backup is in the process.
void	setBeginTime(String BeginTime) Set Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 16:46:34.
void	setEndTime(String EndTime) Set End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 19:09:26.
void	setInstanceId(String InstanceId) Set ID of the instance to be operated on, which can be obtained through the `InstanceId` field in the return value of the `DescribeInstance` API.
void	setInstanceName(String InstanceName) Set Instance name, which can be fuzzily searched.
void	setLimit(Long Limit) Set Number of backups returned per page.
void	setOffset(Long Offset) Set Pagination offset, which is an integral multiple of `Limit`.
void	setStatus(Long[] Status) Set Backup task status: `1`: The backup is in the process.
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

DescribeInstanceBackupsRequest

public DescribeInstanceBackupsRequest()

DescribeInstanceBackupsRequest

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

getLimit

public Long getLimit()

Get Number of backups returned per page. Default value: `20`. Maximum value: `100`.

Returns:

Limit Number of backups returned per page. Default value: `20`. Maximum value: `100`.

setLimit

public void setLimit(Long Limit)

Set Number of backups returned per page. Default value: `20`. Maximum value: `100`.

Parameters:

Limit - Number of backups returned per page. Default value: `20`. Maximum value: `100`.

getOffset

public Long getOffset()

Get Pagination offset, which is an integral multiple of `Limit`. `offset` = `limit` * (page number - 1).

Returns:

Offset Pagination offset, which is an integral multiple of `Limit`. `offset` = `limit` * (page number - 1).

setOffset

public void setOffset(Long Offset)

Set Pagination offset, which is an integral multiple of `Limit`. `offset` = `limit` * (page number - 1).

Parameters:

Offset - Pagination offset, which is an integral multiple of `Limit`. `offset` = `limit` * (page number - 1).

getInstanceId

public String getInstanceId()

Get ID of the instance to be operated on, which can be obtained through the `InstanceId` field in the return value of the `DescribeInstance` API.

Returns:

InstanceId ID of the instance to be operated on, which can be obtained through the `InstanceId` field in the return value of the `DescribeInstance` API.

setInstanceId

public void setInstanceId(String InstanceId)

Set ID of the instance to be operated on, which can be obtained through the `InstanceId` field in the return value of the `DescribeInstance` API.

Parameters:

InstanceId - ID of the instance to be operated on, which can be obtained through the `InstanceId` field in the return value of the `DescribeInstance` API.

getBeginTime

public String getBeginTime()

Get Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 16:46:34. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.

Returns:

BeginTime Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 16:46:34. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.

setBeginTime

public void setBeginTime(String BeginTime)

Set Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 16:46:34. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.

Parameters:

BeginTime - Start time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 16:46:34. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.

getEndTime

public String getEndTime()

Get End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 19:09:26. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.

Returns:

EndTime End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 19:09:26. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.

setEndTime

public void setEndTime(String EndTime)

Set End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 19:09:26. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.

Parameters:

EndTime - End time in the format of yyyy-MM-dd HH:mm:ss, such as 2017-02-08 19:09:26. This parameter is used to query the list of instance backups started during the [beginTime, endTime] range.

getStatus

public Long[] getStatus()

Get Backup task status: `1`: The backup is in the process. `2`: The backup is normal. `3`: The backup is being converted to an RDB file. `4`: Conversion to RDB has been completed. `-1`: The backup expired. `-2`: The backup has been deleted.

Returns:

Status Backup task status: `1`: The backup is in the process. `2`: The backup is normal. `3`: The backup is being converted to an RDB file. `4`: Conversion to RDB has been completed. `-1`: The backup expired. `-2`: The backup has been deleted.

setStatus

public void setStatus(Long[] Status)

Set Backup task status: `1`: The backup is in the process. `2`: The backup is normal. `3`: The backup is being converted to an RDB file. `4`: Conversion to RDB has been completed. `-1`: The backup expired. `-2`: The backup has been deleted.

Parameters:

Status - Backup task status: `1`: The backup is in the process. `2`: The backup is normal. `3`: The backup is being converted to an RDB file. `4`: Conversion to RDB has been completed. `-1`: The backup expired. `-2`: The backup has been deleted.

getInstanceName

public String getInstanceName()

Get Instance name, which can be fuzzily searched.

Returns:

InstanceName Instance name, which can be fuzzily searched.

setInstanceName

public void setInstanceName(String InstanceName)

Set Instance name, which can be fuzzily searched.

Parameters:

InstanceName - Instance name, which can be fuzzily searched.

toMap

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

Internal implementation, normal users should not use it.

Specified by:

toMap in class AbstractModel