SetRuleRequest.Builder (alibabacloud-slb20140515 1.0.11 API)

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

所有已实现的接口:

darabonba.core.RequestModel.Builder<SetRuleRequest,SetRuleRequest.Builder>

封闭类:

SetRuleRequest
```
public static final class SetRuleRequest.Builder
extends Object
```

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`SetRuleRequest`	`build()`
`SetRuleRequest.Builder`	`cookie(String cookie)` The cookie that is configured on the server.
`SetRuleRequest.Builder`	`cookieTimeout(Integer cookieTimeout)` The timeout period of a cookie.
`SetRuleRequest.Builder`	`dryRun(Boolean dryRun)` DryRun.
`SetRuleRequest.Builder`	`healthCheck(String healthCheck)` Specifies whether to enable the health check feature.
`SetRuleRequest.Builder`	`healthCheckConnectPort(Integer healthCheckConnectPort)` The port that is used for health checks.
`SetRuleRequest.Builder`	`healthCheckDomain(String healthCheckDomain)` The domain name that is used for health checks.
`SetRuleRequest.Builder`	`healthCheckHttpCode(String healthCheckHttpCode)` The HTTP status code for a successful health check.
`SetRuleRequest.Builder`	`healthCheckInterval(Integer healthCheckInterval)` The interval between two consecutive health checks.
`SetRuleRequest.Builder`	`healthCheckTimeout(Integer healthCheckTimeout)` The timeout period of a health check response.
`SetRuleRequest.Builder`	`healthCheckURI(String healthCheckURI)` The URI that is used for health checks.
`SetRuleRequest.Builder`	`healthyThreshold(Integer healthyThreshold)` The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy.
`SetRuleRequest.Builder`	`listenerSync(String listenerSync)` Specifies whether to use the scheduling algorithm, session persistence, and health check configurations of the listener.
`SetRuleRequest.Builder`	`ownerAccount(String ownerAccount)` OwnerAccount.
`SetRuleRequest.Builder`	`ownerId(Long ownerId)` OwnerId.
`SetRuleRequest.Builder`	`regionId(String regionId)` The ID of the region where the Classic Load Balancer (CLB) instance is deployed.
`SetRuleRequest.Builder`	`resourceOwnerAccount(String resourceOwnerAccount)` ResourceOwnerAccount.
`SetRuleRequest.Builder`	`resourceOwnerId(Long resourceOwnerId)` ResourceOwnerId.
`SetRuleRequest.Builder`	`ruleId(String ruleId)` The ID of the forwarding rule.
`SetRuleRequest.Builder`	`ruleName(String ruleName)` The name of the forwarding rule.
`SetRuleRequest.Builder`	`scheduler(String scheduler)` The scheduling algorithm.
`SetRuleRequest.Builder`	`stickySession(String stickySession)` Specifies whether to enable session persistence.
`SetRuleRequest.Builder`	`stickySessionType(String stickySessionType)` The method that is used to handle a cookie.
`SetRuleRequest.Builder`	`unhealthyThreshold(Integer unhealthyThreshold)` The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy.
`SetRuleRequest.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

- 方法详细资料
  - cookie
```
public SetRuleRequest.Builder cookie(String cookie)
```
    The cookie that is configured on the server.
    
    The cookie must be 1 to 200 characters in length and can contain only ASCII characters and digits. It cannot contain commas (,), semicolons (;), or space characters. It cannot start with a dollar sign ($).
    
    This parameter is required and takes effect if StickySession is set to on and StickySessionType is set to server.
    
    example:
    23ffsa
  - cookieTimeout
```
public SetRuleRequest.Builder cookieTimeout(Integer cookieTimeout)
```
    The timeout period of a cookie. Unit: seconds. Valid values: 1 to 86400.
    
    This parameter is required and takes effect if StickySession is set to on and StickySessionType is set to insert.
    
    example:
    123
  - dryRun
```
public SetRuleRequest.Builder dryRun(Boolean dryRun)
```
    DryRun.
  - healthCheck
```
public SetRuleRequest.Builder healthCheck(String healthCheck)
```
    Specifies whether to enable the health check feature. Valid values:
    - on: yes
    - off: no
    This parameter is required and takes effect if the ListenerSync parameter is set to off.
    
    example:
    off
  - healthCheckConnectPort
```
public SetRuleRequest.Builder healthCheckConnectPort(Integer healthCheckConnectPort)
```
    The port that is used for health checks. Valid values: 1 to 65535.
    
    This parameter takes effect when the HealthCheck parameter is set to on.
    
    example:
    80
  - healthCheckDomain
```
public SetRuleRequest.Builder healthCheckDomain(String healthCheckDomain)
```
    The domain name that is used for health checks. Valid values:
    - $_ip: the private IP address of a 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 for health checks.
    - domain: The domain name must be 1 to 80 characters in length, and can contain letters, digits, periods (.), and hyphens (-).
    This parameter takes effect if the HealthCheck parameter is set to on.
    
    example:
    $_ip
  - healthCheckHttpCode
```
public SetRuleRequest.Builder healthCheckHttpCode(String healthCheckHttpCode)
```
    The HTTP status code for a successful health check. Multiple HTTP status codes are separated by commas (,).
    
    Valid values: http_2xx, http_3xx, http_4xx, and http_5xx.
    
    This parameter is required and takes effect if the HealthCheck parameter is set to on.
    
    example:
    http_2xx
  - healthCheckInterval
```
public SetRuleRequest.Builder healthCheckInterval(Integer healthCheckInterval)
```
    The interval between two consecutive health checks. Unit: seconds. Valid values: 1 to 50.
    
    This parameter is required and takes effect if the HealthCheck parameter is set to on.
    
    example:
    20
  - healthCheckTimeout
```
public SetRuleRequest.Builder healthCheckTimeout(Integer healthCheckTimeout)
```
    The timeout period of a health check response. If a backend server, such as an Elastic Compute Service (ECS) instance, does not return a health check response within the specified timeout period, the server fails the health check. Unit: seconds. Valid values: 1 to 300.
    
    This parameter is required and takes effect if the HealthCheck parameter is set to on.
    
    example:
    20
  - healthCheckURI
```
public SetRuleRequest.Builder healthCheckURI(String healthCheckURI)
```
    The URI that is used for health checks.
    
    This parameter is required and takes effect if the HealthCheck parameter is set to on.
    
    example:
    /example
  - healthyThreshold
```
public SetRuleRequest.Builder healthyThreshold(Integer healthyThreshold)
```
    The number of times that an unhealthy backend server must consecutively pass health checks before it is declared healthy. In this case, the health status is changed from fail to success.
    
    Valid values: 2 to 10.
    
    This parameter is required and takes effect if the HealthCheck parameter is set to on.
    
    example:
    4
  - listenerSync
```
public SetRuleRequest.Builder listenerSync(String listenerSync)
```
    Specifies whether to use the scheduling algorithm, session persistence, and health check configurations of the listener. Valid values:
    - on: uses the configurations of the listener.
    - off: does not use the configurations of the listener. You can customize the health check and session persistence configurations for the forwarding rule.
    example:
    off
  - ownerAccount
```
public SetRuleRequest.Builder ownerAccount(String ownerAccount)
```
    OwnerAccount.
  - ownerId
```
public SetRuleRequest.Builder ownerId(Long ownerId)
```
    OwnerId.
  - regionId
```
public SetRuleRequest.Builder regionId(String regionId)
```
    The ID of the region where the Classic Load Balancer (CLB) instance is deployed.
    
    You can call the DescribeRegions operation to query the most recent region list.
    
    This parameter is required.
    example:
    cn-hangzhou
  - resourceOwnerAccount
```
public SetRuleRequest.Builder resourceOwnerAccount(String resourceOwnerAccount)
```
    ResourceOwnerAccount.
  - resourceOwnerId
```
public SetRuleRequest.Builder resourceOwnerId(Long resourceOwnerId)
```
    ResourceOwnerId.
  - ruleId
```
public SetRuleRequest.Builder ruleId(String ruleId)
```
    The ID of the forwarding rule.
    
    This parameter is required.
    example:
    rule-3ejhkt****
  - ruleName
```
public SetRuleRequest.Builder ruleName(String ruleName)
```
    The name of the forwarding rule. The name must be 1 to 40 characters in length, and can contain letters, digits, hyphens (-), forward slashes (/), periods (.), and underscores (_).
    
    On the same listener, the forwarding rule names must be unique.
    
    example:
    doctest
  - scheduler
```
public SetRuleRequest.Builder scheduler(String scheduler)
```
    The scheduling algorithm. Valid values:
    - wrr: Backend servers with higher weights receive more requests than those with lower weights.
    - rr: Requests are distributed to backend servers in sequence.
    This parameter is required and takes effect if the ListenerSync parameter is set to off.
    
    example:
    wrr
  - stickySession
```
public SetRuleRequest.Builder stickySession(String stickySession)
```
    Specifies whether to enable session persistence. Valid values:
    - on: yes
    - off: no
    This parameter is required and takes effect if the ListenerSync parameter is set to off.
    example:
    off
  - stickySessionType
```
public SetRuleRequest.Builder stickySessionType(String stickySessionType)
```
    The method that is used to handle a cookie. Valid values:
    - insert: inserts a cookie.
      
      CLB inserts the backend server ID as a cookie into the first HTTP or HTTPS response 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 CLB detects a user-defined cookie, it overwrites the original cookie with the user-defined cookie. The next request from the client will contain the user-defined cookie, and the listener will distribute this request to the recorded backend server.
    This parameter is required and takes effect if the StickySession parameter is set to on.
    
    example:
    insert
  - unhealthyThreshold
```
public SetRuleRequest.Builder unhealthyThreshold(Integer unhealthyThreshold)
```
    The number of times that a healthy backend server must consecutively fail health checks before it is declared unhealthy. In this case, the health status is changed from success to fail.
    
    Valid values: 2 to 10.
    
    This parameter is required and takes effect if the HealthCheck parameter is set to on.
    
    example:
    4
  - vServerGroupId
```
public SetRuleRequest.Builder vServerGroupId(String vServerGroupId)
```
    The ID of the vServer group that is associated with the forwarding rule.
    example:
    rsp-cige6****
  - build
```
public SetRuleRequest build()
```

类 SetRuleRequest.Builder

方法概要

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

方法详细资料

cookie

cookieTimeout

dryRun

healthCheck

healthCheckConnectPort

healthCheckDomain

healthCheckHttpCode

healthCheckInterval

healthCheckTimeout

healthCheckURI

healthyThreshold

listenerSync

ownerAccount

ownerId

regionId

resourceOwnerAccount

resourceOwnerId

ruleId

ruleName

scheduler

stickySession

stickySessionType

unhealthyThreshold

vServerGroupId

build