DescribeRulesResponseBody.Rule.Builder (alibabacloud-slb20140515 1.0.11 API)

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

封闭类:: DescribeRulesResponseBody.Rule

public static final class DescribeRulesResponseBody.Rule.Builder
extends Object

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`DescribeRulesResponseBody.Rule`	`build()`
`DescribeRulesResponseBody.Rule.Builder`	`cookie(String cookie)` The cookie that is configured on the backend server.
`DescribeRulesResponseBody.Rule.Builder`	`cookieTimeout(Integer cookieTimeout)` The timeout period of a cookie.
`DescribeRulesResponseBody.Rule.Builder`	`domain(String domain)` The requested domain name specified in the forwarding rule.
`DescribeRulesResponseBody.Rule.Builder`	`healthCheck(String healthCheck)` Indicates whether health checks are enabled.
`DescribeRulesResponseBody.Rule.Builder`	`healthCheckConnectPort(Integer healthCheckConnectPort)` The backend port that is used for health checks.
`DescribeRulesResponseBody.Rule.Builder`	`healthCheckDomain(String healthCheckDomain)` The domain name that is used for health checks.
`DescribeRulesResponseBody.Rule.Builder`	`healthCheckHttpCode(String healthCheckHttpCode)` The HTTP status code that indicates a successful health check.
`DescribeRulesResponseBody.Rule.Builder`	`healthCheckInterval(Integer healthCheckInterval)` The time interval between two consecutive health checks.
`DescribeRulesResponseBody.Rule.Builder`	`healthCheckTimeout(Integer healthCheckTimeout)` The timeout period of a health check response.
`DescribeRulesResponseBody.Rule.Builder`	`healthCheckURI(String healthCheckURI)` The URI that is used for health checks.
`DescribeRulesResponseBody.Rule.Builder`	`healthyThreshold(Integer healthyThreshold)` Specifies the number of successful health checks that must be consecutively performed before a backend server can be declared healthy (from fail to success).
`DescribeRulesResponseBody.Rule.Builder`	`listenerSync(String listenerSync)` Indicates whether the forwarding rule uses the scheduling algorithm, session persistence, and health check configurations of the listener.
`DescribeRulesResponseBody.Rule.Builder`	`ruleId(String ruleId)` The ID of the forwarding rule.
`DescribeRulesResponseBody.Rule.Builder`	`ruleName(String ruleName)` The name of the forwarding rule.
`DescribeRulesResponseBody.Rule.Builder`	`scheduler(String scheduler)` The scheduling algorithm.
`DescribeRulesResponseBody.Rule.Builder`	`stickySession(String stickySession)` Specifies whether to enable session persistence.
`DescribeRulesResponseBody.Rule.Builder`	`stickySessionType(String stickySessionType)` The method that is used to handle a cookie.
`DescribeRulesResponseBody.Rule.Builder`	`unhealthyThreshold(Integer unhealthyThreshold)` Specifies the number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail).
`DescribeRulesResponseBody.Rule.Builder`	`url(String url)` The requested path specified in the forwarding rule.
`DescribeRulesResponseBody.Rule.Builder`	`vServerGroupId(String vServerGroupId)` The ID of the destination vServer group specified in the forwarding rule.

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

- 方法详细资料
  - cookie
```
public DescribeRulesResponseBody.Rule.Builder cookie(String cookie)
```
    The cookie that is configured on the backend server.
    
    The value must be 1 to 200 characters in length, and can contain only ASCII letters and digits. It cannot contain commas (,), semicolons (;), or spaces. 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.
    
    example:
    23
  - cookieTimeout
```
public DescribeRulesResponseBody.Rule.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.
    
    example:
    56
  - domain
```
public DescribeRulesResponseBody.Rule.Builder domain(String domain)
```
    The requested domain name specified in the forwarding rule.
    example:
    test.com
  - healthCheck
```
public DescribeRulesResponseBody.Rule.Builder healthCheck(String healthCheck)
```
    Indicates whether health checks are 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.
    
    example:
    off
  - healthCheckConnectPort
```
public DescribeRulesResponseBody.Rule.Builder healthCheckConnectPort(Integer healthCheckConnectPort)
```
    The backend port that is used for health checks.
    
    Valid values: 1 to 65535.
    
    If you set the HealthCheck parameter to on, this parameter is required. If this parameter is empty but HealthCheck is set to on, the listener port is used for health checks.
    
    example:
    45
  - healthCheckDomain
```
public DescribeRulesResponseBody.Rule.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 you do not set this parameter or set the parameter to $_ip, the SLB instance uses the private IP address of each backend server as the domain name for health checks.
    - domain: The domain name must be 1 to 80 characters in length. The domain name can contain only letters, digits, periods (.),and hyphens (-).
    If you set the HealthCheck parameter to on, this parameter is required.
    
    example:
    www.domain.com
  - healthCheckHttpCode
```
public DescribeRulesResponseBody.Rule.Builder healthCheckHttpCode(String healthCheckHttpCode)
```
    The HTTP status code that indicates a successful health check. Multiple HTTP status codes are separated by 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.
    
    example:
    http_3xx
  - healthCheckInterval
```
public DescribeRulesResponseBody.Rule.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.
    
    example:
    5
  - healthCheckTimeout
```
public DescribeRulesResponseBody.Rule.Builder healthCheckTimeout(Integer healthCheckTimeout)
```
    The timeout period of a health check response. If a backend ECS instance does not respond within the specified timeout period, the ECS instance fails the health check. Unit: seconds
    
    Valid values: 1 to 300.
    
    When you set the HealthCheck parameter to on, this parameter takes effect.
    
    example:
    34
  - healthCheckURI
```
public DescribeRulesResponseBody.Rule.Builder healthCheckURI(String healthCheckURI)
```
    The URI that is used for health checks.
    
    If you set the HealthCheck parameter to on, this parameter is required.
    
    example:
    /example
  - healthyThreshold
```
public DescribeRulesResponseBody.Rule.Builder healthyThreshold(Integer healthyThreshold)
```
    Specifies the number of successful health checks that must be consecutively performed before a backend server can be declared healthy (from fail to success).
    
    Valid values: 2 to 10.
    
    If you set the HealthCheck parameter to on, this parameter is required.
    
    example:
    5
  - listenerSync
```
public DescribeRulesResponseBody.Rule.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.
    example:
    off
  - ruleId
```
public DescribeRulesResponseBody.Rule.Builder ruleId(String ruleId)
```
    The ID of the forwarding rule.
    example:
    rule-tybqi6****
  - ruleName
```
public DescribeRulesResponseBody.Rule.Builder ruleName(String ruleName)
```
    The name of the forwarding rule. The name must be 1 to 80 characters in length, and can contain only letters, digits, hyphens (-), forward slashes (/), periods (.),and underscores (_).
    
    The name of each forwarding rule must be unique within a listener.
    
    example:
    Rule2
  - scheduler
```
public DescribeRulesResponseBody.Rule.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.
    
    example:
    wrr
  - stickySession
```
public DescribeRulesResponseBody.Rule.Builder stickySession(String stickySession)
```
    Specifies whether to enable session persistence.
    
    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.
    
    example:
    off
  - stickySessionType
```
public DescribeRulesResponseBody.Rule.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.
    
    example:
    insert
  - unhealthyThreshold
```
public DescribeRulesResponseBody.Rule.Builder unhealthyThreshold(Integer unhealthyThreshold)
```
    Specifies the number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy (from success to fail).
    
    Valid values: 2 to 10
    
    If you set the HealthCheck parameter to on, this parameter is required.
    
    example:
    2
  - url
```
public DescribeRulesResponseBody.Rule.Builder url(String url)
```
    The requested path specified in the forwarding rule.
    example:
    /cache
  - vServerGroupId
```
public DescribeRulesResponseBody.Rule.Builder vServerGroupId(String vServerGroupId)
```
    The ID of the destination vServer group specified in the forwarding rule.
    example:
    rsp-6cejjzl****
  - build
```
public DescribeRulesResponseBody.Rule build()
```

类 DescribeRulesResponseBody.Rule.Builder

方法概要

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

方法详细资料

cookie

cookieTimeout

domain

healthCheck

healthCheckConnectPort

healthCheckDomain

healthCheckHttpCode

healthCheckInterval

healthCheckTimeout

healthCheckURI

healthyThreshold

listenerSync

ruleId

ruleName

scheduler

stickySession

stickySessionType

unhealthyThreshold

url

vServerGroupId

build