DescribeRuleAttributeResponseBody.Builder (alibabacloud-slb20140515 1.0.6 API)

java.lang.Object
- com.aliyun.sdk.service.slb20140515.models.DescribeRuleAttributeResponseBody.Builder

封闭类:: DescribeRuleAttributeResponseBody

public static final class DescribeRuleAttributeResponseBody.Builder
extends Object

构造器概要

构造器
构造器和说明

Builder()

构造器
构造器和说明
`Builder()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DescribeRuleAttributeResponseBody`	`build()`
`DescribeRuleAttributeResponseBody.Builder`	`cookie(String cookie)` The cookie to be configured on the backend server.
`DescribeRuleAttributeResponseBody.Builder`	`cookieTimeout(Integer cookieTimeout)` The timeout period of a cookie.
`DescribeRuleAttributeResponseBody.Builder`	`domain(String domain)` The domain name that is configured in the forwarding rule.
`DescribeRuleAttributeResponseBody.Builder`	`healthCheck(String healthCheck)` Specifies whether to enable health checks.
`DescribeRuleAttributeResponseBody.Builder`	`healthCheckConnectPort(Integer healthCheckConnectPort)` The port of the backend server that is used for health checks.
`DescribeRuleAttributeResponseBody.Builder`	`healthCheckDomain(String healthCheckDomain)` The domain name that is used for health checks.
`DescribeRuleAttributeResponseBody.Builder`	`healthCheckHttpCode(String healthCheckHttpCode)` The HTTP status code that indicates a successful health check.
`DescribeRuleAttributeResponseBody.Builder`	`healthCheckInterval(Integer healthCheckInterval)` The time interval between two consecutive health checks.
`DescribeRuleAttributeResponseBody.Builder`	`healthCheckTimeout(Integer healthCheckTimeout)` The timeout period of a health check response.
`DescribeRuleAttributeResponseBody.Builder`	`healthCheckURI(String healthCheckURI)` The URI that is used for health checks.
`DescribeRuleAttributeResponseBody.Builder`	`healthyThreshold(Integer healthyThreshold)` The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy.
`DescribeRuleAttributeResponseBody.Builder`	`listenerPort(String listenerPort)` The listener port that is used by the SLB instance.
`DescribeRuleAttributeResponseBody.Builder`	`listenerSync(String listenerSync)` Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.
`DescribeRuleAttributeResponseBody.Builder`	`loadBalancerId(String loadBalancerId)` The ID of the SLB instance.
`DescribeRuleAttributeResponseBody.Builder`	`requestId(String requestId)` The ID of the request.
`DescribeRuleAttributeResponseBody.Builder`	`ruleId(String ruleId)` The ID of the forwarding rule.
`DescribeRuleAttributeResponseBody.Builder`	`ruleName(String ruleName)` The name of the forwarding rule.
`DescribeRuleAttributeResponseBody.Builder`	`scheduler(String scheduler)` The scheduling algorithm.
`DescribeRuleAttributeResponseBody.Builder`	`stickySession(String stickySession)` Indicates whether session persistence is enabled.
`DescribeRuleAttributeResponseBody.Builder`	`stickySessionType(String stickySessionType)` The method that is used to handle a cookie.
`DescribeRuleAttributeResponseBody.Builder`	`unhealthyThreshold(Integer unhealthyThreshold)` The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy.
`DescribeRuleAttributeResponseBody.Builder`	`url(String url)` The URL that is configured in the forwarding rule.
`DescribeRuleAttributeResponseBody.Builder`	`vServerGroupId(String vServerGroupId)` The ID of the vServer group that is associated with the forwarding rule.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - Builder
```
public Builder()
```
- 方法详细资料
  - cookie
```
public DescribeRuleAttributeResponseBody.Builder cookie(String cookie)
```
    The cookie to be configured on the backend server.
    The cookie must be 1 to 200 characters in length and can contain ASCII letters and digits. It cannot contain commas (,), semicolons (;), or whitespace characters. It cannot start with a dollar sign ($). If you set the **StickySession** parameter to **on** and the **StickySessionType** parameter to **server**, this parameter is required.
  - cookieTimeout
```
public DescribeRuleAttributeResponseBody.Builder cookieTimeout(Integer cookieTimeout)
```
    The timeout period of a cookie.
    Valid values: **1 to 86400**. Unit: seconds. > If you set the **StickySession** parameter to **on** and the **StickySessionType** parameter to **insert**, this parameter is required.
  - domain
```
public DescribeRuleAttributeResponseBody.Builder domain(String domain)
```
    The domain name that is configured in the forwarding rule.
  - healthCheck
```
public DescribeRuleAttributeResponseBody.Builder healthCheck(String healthCheck)
```
    Specifies whether to enable health checks.
    Valid values: **on** and **off**. > If you set the **ListenerSync** parameter to **off**, this parameter is required. If you set the parameter to **on**, the configuration of the listener is used.
  - healthCheckConnectPort
```
public DescribeRuleAttributeResponseBody.Builder healthCheckConnectPort(Integer healthCheckConnectPort)
```
    The port of the backend server that is used for health checks.
    Valid values: **1** to **65535**. > If you set the **HealthCheck** parameter to **on**, this parameter is required. If you left this parameter empty and the **HealthCheck** parameter is set to **on**, the backend port configuration of the listener is used by default.
  - healthCheckDomain
```
public DescribeRuleAttributeResponseBody.Builder healthCheckDomain(String healthCheckDomain)
```
    The domain name that is used for health checks. Valid values:
    * **$\_ip**: The private IP address of the backend server. If the $\_ip parameter is set or the HealthCheckDomain parameter is not set, SLB uses the private IP addresses of backend servers as the domain names for health checks. * **domain**: The domain name must be 1 to 80 characters in length. It can contain only letters, digits, periods (.),and hyphens (-). > If you set the **HealthCheck** parameter to **on**, this parameter is required.
  - healthCheckHttpCode
```
public DescribeRuleAttributeResponseBody.Builder healthCheckHttpCode(String healthCheckHttpCode)
```
    The HTTP status code that indicates a successful health check. Separate multiple HTTP status codes with commas (,). Default value: **http\_2xx**.
    Valid values: **http\_2xx**, **http\_3xx**, **http\_4xx**, and **http\_5xx**. > If you set the **HealthCheck** parameter to **on**, this parameter is required.
  - healthCheckInterval
```
public DescribeRuleAttributeResponseBody.Builder healthCheckInterval(Integer healthCheckInterval)
```
    The time interval between two consecutive health checks.
    Valid values: **1** to **50**. Unit: seconds. > If you set the **HealthCheck** parameter to **on**, this parameter is required.
  - healthCheckTimeout
```
public DescribeRuleAttributeResponseBody.Builder healthCheckTimeout(Integer healthCheckTimeout)
```
    The timeout period of a health check response. If a backend ECS instance does not send an expected response within the specified period of time, the ECS instance is considered unhealthy.
    Valid values: **1** to **300**. Unit: seconds. > If the value of the **HealthCHeckTimeout** parameter is smaller than that of the **HealthCheckInterval** parameter, the value of the **HealthCHeckTimeout** parameter is ignored and the value of the **HealthCheckInterval** parameter is regarded as the waiting period. If you set the **HealthCheck** parameter to **on**, this parameter is required.
  - healthCheckURI
```
public DescribeRuleAttributeResponseBody.Builder healthCheckURI(String healthCheckURI)
```
    The URI that is used for health checks.
    > If you set the **HealthCheck** parameter to **on**, this parameter is required.
  - healthyThreshold
```
public DescribeRuleAttributeResponseBody.Builder healthyThreshold(Integer healthyThreshold)
```
    The number of consecutive successful health checks that must occur before an unhealthy backend server is declared healthy. In this case, the health check state is changed from **fail** to **success**.
    Valid values: **2** to **10**. > If you set the **HealthCheck** parameter to **on**, this parameter is required.
  - listenerPort
```
public DescribeRuleAttributeResponseBody.Builder listenerPort(String listenerPort)
```
    The listener port that is used by the SLB instance.
  - listenerSync
```
public DescribeRuleAttributeResponseBody.Builder listenerSync(String listenerSync)
```
    Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.
    Valid values: **on** and **off**. * **off**: does not use the configurations of the listener. You can customize health check and session persistence configurations for the forwarding rule. * **on**: uses the configurations of the listener.
  - loadBalancerId
```
public DescribeRuleAttributeResponseBody.Builder loadBalancerId(String loadBalancerId)
```
    The ID of the SLB instance.
  - requestId
```
public DescribeRuleAttributeResponseBody.Builder requestId(String requestId)
```
    The ID of the request.
  - ruleId
```
public DescribeRuleAttributeResponseBody.Builder ruleId(String ruleId)
```
    The ID of the forwarding rule.
  - ruleName
```
public DescribeRuleAttributeResponseBody.Builder ruleName(String ruleName)
```
    The name of the forwarding rule.
  - scheduler
```
public DescribeRuleAttributeResponseBody.Builder scheduler(String scheduler)
```
    The scheduling algorithm. Valid values:
    * **wrr** (default): Backend servers that have higher weights receive more requests than backend servers that have lower weights. * **rr**: Requests are distributed to backend servers in sequence. > If you set the **ListenerSync** parameter to **off**, this parameter is required. If you set the parameter to **on**, the configuration of the listener is used.
  - stickySession
```
public DescribeRuleAttributeResponseBody.Builder stickySession(String stickySession)
```
    Indicates whether session persistence is enabled.
    Valid values: **on** and **off**. > If you set the **ListenerSync** parameter to **off**, this parameter is required. If you set the parameter to **on**, the configuration of the listener is used.
  - stickySessionType
```
public DescribeRuleAttributeResponseBody.Builder stickySessionType(String stickySessionType)
```
    The method that is used to handle a cookie. Valid values:
    * **insert**: inserts a cookie into the response. SLB inserts a cookie (SERVERID) into the first HTTP or HTTPS response packet that is sent to a client. The next request from the client will contain this cookie, and the listener will distribute this request to the recorded backend server. * **server**: rewrites a cookie. When SLB detects a user-defined cookie, SLB overwrites the original cookie with the user-defined cookie. The next request from the client contains the user-defined cookie, and the listener distributes the request to the recorded backend server. > If you set the **StickySession** parameter to **on**, this parameter is required.
  - unhealthyThreshold
```
public DescribeRuleAttributeResponseBody.Builder unhealthyThreshold(Integer unhealthyThreshold)
```
    The number of consecutive failed health checks that must occur before a healthy backend server is declared unhealthy. In this case, the health check state is changed from **success** to **fail**.
    Valid values: **2** to **10**. > If you set the **HealthCheck** parameter to **on**, this parameter is required.
  - url
```
public DescribeRuleAttributeResponseBody.Builder url(String url)
```
    The URL that is configured in the forwarding rule.
  - vServerGroupId
```
public DescribeRuleAttributeResponseBody.Builder vServerGroupId(String vServerGroupId)
```
    The ID of the vServer group that is associated with the forwarding rule.
  - build
```
public DescribeRuleAttributeResponseBody build()
```

类 DescribeRuleAttributeResponseBody.Builder

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

Builder

方法详细资料

cookie

cookieTimeout

domain

healthCheck

healthCheckConnectPort

healthCheckDomain

healthCheckHttpCode

healthCheckInterval

healthCheckTimeout

healthCheckURI

healthyThreshold

listenerPort

listenerSync

loadBalancerId

requestId

ruleId

ruleName

scheduler

stickySession

stickySessionType

unhealthyThreshold

url

vServerGroupId

build