DescribeLoadBalancersRequest (tencentcloud-sdk-java-intl-en 3.0.671 API)

java.lang.Object
- com.tencentcloudapi.common.AbstractModel
- - com.tencentcloudapi.clb.v20180317.models.DescribeLoadBalancersRequest

public class DescribeLoadBalancersRequest
extends AbstractModel

Constructor Summary

Constructors
Constructor and Description
`DescribeLoadBalancersRequest()`
`DescribeLoadBalancersRequest(DescribeLoadBalancersRequest 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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String[]`	`getBackendPrivateIps()` Get Private IPs of the backend services bound with the load balancer.
`String[]`	`getBackendPublicIps()` Get Public IPs of the backend services bound with the load balancer.
`String`	`getDomain()` Get Domain name assigned to a CLB instance by Tencent Cloud.
`Filter[]`	`getFilters()` Get Each request can have up to 10 `Filters` and 100 `Filter.Values`.
`Long`	`getForward()` Get CLB instance type.
`Long`	`getLimit()` Get Number of returned CLB instances.
`String[]`	`getLoadBalancerIds()` Get CLB instance IDs.
`String`	`getLoadBalancerName()` Get CLB instance name.
`String`	`getLoadBalancerType()` Get CLB instance network type: OPEN: public network; INTERNAL: private network.
`String[]`	`getLoadBalancerVips()` Get VIP address of a CLB instance (there can be multiple addresses)
`String`	`getMasterZone()` Get Primary AZ ID, e.g., `100001` (Guangzhou Zone 1).
`Long`	`getOffset()` Get Data offset.
`String`	`getOrderBy()` Get Sort by parameter.
`Long`	`getOrderType()` Get 1: reverse; 0: sequential.
`Long`	`getProjectId()` Get ID of the project to which a CLB instance belongs, which can be obtained through the DescribeProject API.
`String`	`getSearchKey()` Get Search field which fuzzy matches name, domain name, or VIP.
`String`	`getSecurityGroup()` Get Security group ID, e.g., `sg-m1cc****`.
`String`	`getVpcId()` Get VPC where a CLB instance resides, such as vpc-bhqkbhdx.
`Long`	`getWithRs()` Get Whether a CLB instance is bound to a real server.
`void`	`setBackendPrivateIps(String[] BackendPrivateIps)` Set Private IPs of the backend services bound with the load balancer.
`void`	`setBackendPublicIps(String[] BackendPublicIps)` Set Public IPs of the backend services bound with the load balancer.
`void`	`setDomain(String Domain)` Set Domain name assigned to a CLB instance by Tencent Cloud.
`void`	`setFilters(Filter[] Filters)` Set Each request can have up to 10 `Filters` and 100 `Filter.Values`.
`void`	`setForward(Long Forward)` Set CLB instance type.
`void`	`setLimit(Long Limit)` Set Number of returned CLB instances.
`void`	`setLoadBalancerIds(String[] LoadBalancerIds)` Set CLB instance IDs.
`void`	`setLoadBalancerName(String LoadBalancerName)` Set CLB instance name.
`void`	`setLoadBalancerType(String LoadBalancerType)` Set CLB instance network type: OPEN: public network; INTERNAL: private network.
`void`	`setLoadBalancerVips(String[] LoadBalancerVips)` Set VIP address of a CLB instance (there can be multiple addresses)
`void`	`setMasterZone(String MasterZone)` Set Primary AZ ID, e.g., `100001` (Guangzhou Zone 1).
`void`	`setOffset(Long Offset)` Set Data offset.
`void`	`setOrderBy(String OrderBy)` Set Sort by parameter.
`void`	`setOrderType(Long OrderType)` Set 1: reverse; 0: sequential.
`void`	`setProjectId(Long ProjectId)` Set ID of the project to which a CLB instance belongs, which can be obtained through the DescribeProject API.
`void`	`setSearchKey(String SearchKey)` Set Search field which fuzzy matches name, domain name, or VIP.
`void`	`setSecurityGroup(String SecurityGroup)` Set Security group ID, e.g., `sg-m1cc****`.
`void`	`setVpcId(String VpcId)` Set VPC where a CLB instance resides, such as vpc-bhqkbhdx.
`void`	`setWithRs(Long WithRs)` Set Whether a CLB instance is bound to a real server.
`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
  - DescribeLoadBalancersRequest
```
public DescribeLoadBalancersRequest()
```
  - DescribeLoadBalancersRequest
```
public DescribeLoadBalancersRequest(DescribeLoadBalancersRequest 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
  - getLoadBalancerIds
```
public String[] getLoadBalancerIds()
```
    Get CLB instance IDs. There can be up to 20 IDs.
    
    Returns:
    
    LoadBalancerIds CLB instance IDs. There can be up to 20 IDs.
  - setLoadBalancerIds
```
public void setLoadBalancerIds(String[] LoadBalancerIds)
```
    Set CLB instance IDs. There can be up to 20 IDs.
    
    Parameters:
    
    LoadBalancerIds - CLB instance IDs. There can be up to 20 IDs.
  - getLoadBalancerType
```
public String getLoadBalancerType()
```
    Get CLB instance network type: OPEN: public network; INTERNAL: private network.
    
    Returns:
    
    LoadBalancerType CLB instance network type: OPEN: public network; INTERNAL: private network.
  - setLoadBalancerType
```
public void setLoadBalancerType(String LoadBalancerType)
```
    Set CLB instance network type: OPEN: public network; INTERNAL: private network.
    
    Parameters:
    
    LoadBalancerType - CLB instance network type: OPEN: public network; INTERNAL: private network.
  - getForward
```
public Long getForward()
```
    Get CLB instance type. 1: generic CLB instance; 0: classic CLB instance
    
    Returns:
    
    Forward CLB instance type. 1: generic CLB instance; 0: classic CLB instance
  - setForward
```
public void setForward(Long Forward)
```
    Set CLB instance type. 1: generic CLB instance; 0: classic CLB instance
    
    Parameters:
    
    Forward - CLB instance type. 1: generic CLB instance; 0: classic CLB instance
  - getLoadBalancerName
```
public String getLoadBalancerName()
```
    Get CLB instance name.
    
    Returns:
    
    LoadBalancerName CLB instance name.
  - setLoadBalancerName
```
public void setLoadBalancerName(String LoadBalancerName)
```
    Set CLB instance name.
    
    Parameters:
    
    LoadBalancerName - CLB instance name.
  - getDomain
```
public String getDomain()
```
    Get Domain name assigned to a CLB instance by Tencent Cloud. This parameter is meaningful only for the public network classic CLB.
    
    Returns:
    
    Domain Domain name assigned to a CLB instance by Tencent Cloud. This parameter is meaningful only for the public network classic CLB.
  - setDomain
```
public void setDomain(String Domain)
```
    Set Domain name assigned to a CLB instance by Tencent Cloud. This parameter is meaningful only for the public network classic CLB.
    
    Parameters:
    
    Domain - Domain name assigned to a CLB instance by Tencent Cloud. This parameter is meaningful only for the public network classic CLB.
  - getLoadBalancerVips
```
public String[] getLoadBalancerVips()
```
    Get VIP address of a CLB instance (there can be multiple addresses)
    
    Returns:
    
    LoadBalancerVips VIP address of a CLB instance (there can be multiple addresses)
  - setLoadBalancerVips
```
public void setLoadBalancerVips(String[] LoadBalancerVips)
```
    Set VIP address of a CLB instance (there can be multiple addresses)
    
    Parameters:
    
    LoadBalancerVips - VIP address of a CLB instance (there can be multiple addresses)
  - getBackendPublicIps
```
public String[] getBackendPublicIps()
```
    Get Public IPs of the backend services bound with the load balancer. Only the public IPs of CVMs are supported now.
    
    Returns:
    
    BackendPublicIps Public IPs of the backend services bound with the load balancer. Only the public IPs of CVMs are supported now.
  - setBackendPublicIps
```
public void setBackendPublicIps(String[] BackendPublicIps)
```
    Set Public IPs of the backend services bound with the load balancer. Only the public IPs of CVMs are supported now.
    
    Parameters:
    
    BackendPublicIps - Public IPs of the backend services bound with the load balancer. Only the public IPs of CVMs are supported now.
  - getBackendPrivateIps
```
public String[] getBackendPrivateIps()
```
    Get Private IPs of the backend services bound with the load balancer. Only the private IPs of CVMs are supported now.
    
    Returns:
    
    BackendPrivateIps Private IPs of the backend services bound with the load balancer. Only the private IPs of CVMs are supported now.
  - setBackendPrivateIps
```
public void setBackendPrivateIps(String[] BackendPrivateIps)
```
    Set Private IPs of the backend services bound with the load balancer. Only the private IPs of CVMs are supported now.
    
    Parameters:
    
    BackendPrivateIps - Private IPs of the backend services bound with the load balancer. Only the private IPs of CVMs are supported now.
  - getOffset
```
public Long getOffset()
```
    Get Data offset. Default value: 0.
    
    Returns:
    
    Offset Data offset. Default value: 0.
  - setOffset
```
public void setOffset(Long Offset)
```
    Set Data offset. Default value: 0.
    
    Parameters:
    
    Offset - Data offset. Default value: 0.
  - getLimit
```
public Long getLimit()
```
    Get Number of returned CLB instances. Default value: 20. Maximum value: 100.
    
    Returns:
    
    Limit Number of returned CLB instances. Default value: 20. Maximum value: 100.
  - setLimit
```
public void setLimit(Long Limit)
```
    Set Number of returned CLB instances. Default value: 20. Maximum value: 100.
    
    Parameters:
    
    Limit - Number of returned CLB instances. Default value: 20. Maximum value: 100.
  - getOrderBy
```
public String getOrderBy()
```
    Get Sort by parameter. Value range: LoadBalancerName, CreateTime, Domain, LoadBalancerType.
    
    Returns:
    
    OrderBy Sort by parameter. Value range: LoadBalancerName, CreateTime, Domain, LoadBalancerType.
  - setOrderBy
```
public void setOrderBy(String OrderBy)
```
    Set Sort by parameter. Value range: LoadBalancerName, CreateTime, Domain, LoadBalancerType.
    
    Parameters:
    
    OrderBy - Sort by parameter. Value range: LoadBalancerName, CreateTime, Domain, LoadBalancerType.
  - getOrderType
```
public Long getOrderType()
```
    Get 1: reverse; 0: sequential. Default value: reverse by creation time |
    
    Returns:
    
    OrderType 1: reverse; 0: sequential. Default value: reverse by creation time |
  - setOrderType
```
public void setOrderType(Long OrderType)
```
    Set 1: reverse; 0: sequential. Default value: reverse by creation time |
    
    Parameters:
    
    OrderType - 1: reverse; 0: sequential. Default value: reverse by creation time |
  - getSearchKey
```
public String getSearchKey()
```
    Get Search field which fuzzy matches name, domain name, or VIP.
    
    Returns:
    
    SearchKey Search field which fuzzy matches name, domain name, or VIP.
  - setSearchKey
```
public void setSearchKey(String SearchKey)
```
    Set Search field which fuzzy matches name, domain name, or VIP.
    
    Parameters:
    
    SearchKey - Search field which fuzzy matches name, domain name, or VIP.
  - getProjectId
```
public Long getProjectId()
```
    Get ID of the project to which a CLB instance belongs, which can be obtained through the DescribeProject API.
    
    Returns:
    
    ProjectId ID of the project to which a CLB instance belongs, which can be obtained through the DescribeProject API.
  - setProjectId
```
public void setProjectId(Long ProjectId)
```
    Set ID of the project to which a CLB instance belongs, which can be obtained through the DescribeProject API.
    
    Parameters:
    
    ProjectId - ID of the project to which a CLB instance belongs, which can be obtained through the DescribeProject API.
  - getWithRs
```
public Long getWithRs()
```
    Get Whether a CLB instance is bound to a real server. 0: no; 1: yes; -1: query all.
    
    Returns:
    
    WithRs Whether a CLB instance is bound to a real server. 0: no; 1: yes; -1: query all.
  - setWithRs
```
public void setWithRs(Long WithRs)
```
    Set Whether a CLB instance is bound to a real server. 0: no; 1: yes; -1: query all.
    
    Parameters:
    
    WithRs - Whether a CLB instance is bound to a real server. 0: no; 1: yes; -1: query all.
  - getVpcId
```
public String getVpcId()
```
    Get VPC where a CLB instance resides, such as vpc-bhqkbhdx. Basic network does not support queries by VpcId.
    
    Returns:
    
    VpcId VPC where a CLB instance resides, such as vpc-bhqkbhdx. Basic network does not support queries by VpcId.
  - setVpcId
```
public void setVpcId(String VpcId)
```
    Set VPC where a CLB instance resides, such as vpc-bhqkbhdx. Basic network does not support queries by VpcId.
    
    Parameters:
    
    VpcId - VPC where a CLB instance resides, such as vpc-bhqkbhdx. Basic network does not support queries by VpcId.
  - getSecurityGroup
```
public String getSecurityGroup()
```
    Get Security group ID, e.g., `sg-m1cc****`.
    
    Returns:
    
    SecurityGroup Security group ID, e.g., `sg-m1cc****`.
  - setSecurityGroup
```
public void setSecurityGroup(String SecurityGroup)
```
    Set Security group ID, e.g., `sg-m1cc****`.
    
    Parameters:
    
    SecurityGroup - Security group ID, e.g., `sg-m1cc****`.
  - getMasterZone
```
public String getMasterZone()
```
    Get Primary AZ ID, e.g., `100001` (Guangzhou Zone 1).
    
    Returns:
    
    MasterZone Primary AZ ID, e.g., `100001` (Guangzhou Zone 1).
  - setMasterZone
```
public void setMasterZone(String MasterZone)
```
    Set Primary AZ ID, e.g., `100001` (Guangzhou Zone 1).
    
    Parameters:
    
    MasterZone - Primary AZ ID, e.g., `100001` (Guangzhou Zone 1).
  - getFilters
```
public Filter[] getFilters()
```
    Get Each request can have up to 10 `Filters` and 100 `Filter.Values`. Detailed filter conditions:
  - internet-charge-type - Type: String - Required: No - Filter by CLB network billing mode, including `TRAFFIC_POSTPAID_BY_HOUR`

Returns:: Filters Each request can have up to 10 `Filters` and 100 `Filter.Values`. Detailed filter conditions:
internet-charge-type - Type: String - Required: No - Filter by CLB network billing mode, including `TRAFFIC_POSTPAID_BY_HOUR`

setFilters
```
public void setFilters(Filter[] Filters)
```
Set Each request can have up to 10 `Filters` and 100 `Filter.Values`. Detailed filter conditions:
internet-charge-type - Type: String - Required: No - Filter by CLB network billing mode, including `TRAFFIC_POSTPAID_BY_HOUR`

Class DescribeLoadBalancersRequest

Constructor Summary

Method Summary

Methods inherited from class com.tencentcloudapi.common.AbstractModel

Methods inherited from class java.lang.Object

Constructor Detail

DescribeLoadBalancersRequest

DescribeLoadBalancersRequest

Method Detail

getLoadBalancerIds

setLoadBalancerIds

getLoadBalancerType

setLoadBalancerType

getForward

setForward

getLoadBalancerName

setLoadBalancerName

getDomain

setDomain

getLoadBalancerVips

setLoadBalancerVips

getBackendPublicIps

setBackendPublicIps

getBackendPrivateIps

setBackendPrivateIps

getOffset

setOffset

getLimit

setLimit

getOrderBy

setOrderBy

getOrderType

setOrderType

getSearchKey

setSearchKey

getProjectId

setProjectId

getWithRs

setWithRs

getVpcId

setVpcId

getSecurityGroup

setSecurityGroup

getMasterZone

setMasterZone

getFilters

setFilters

toMap