WaitingRoomProps

Properties for defining a WaitingRoom.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-esa-waitingroom

Initializer

import com.aliyun.ros.cdk.esa.WaitingRoomProps;
WaitingRoomProps.builder()
    .cookieName(java.lang.String)
    .cookieName(IResolvable)
    .hostNameAndPath(IResolvable)
    .hostNameAndPath(java.util.List<IResolvable)
    .hostNameAndPath(HostNameAndPathProperty>)
    .newUsersPerMinute(java.lang.Number)
    .newUsersPerMinute(IResolvable)
    .queuingMethod(java.lang.String)
    .queuingMethod(IResolvable)
    .queuingStatusCode(java.lang.Number)
    .queuingStatusCode(IResolvable)
    .sessionDuration(java.lang.Number)
    .sessionDuration(IResolvable)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
    .status(java.lang.String)
    .status(IResolvable)
    .totalActiveUsers(java.lang.String)
    .totalActiveUsers(IResolvable)
    .waitingRoomName(java.lang.String)
    .waitingRoomName(IResolvable)
    .waitingRoomType(java.lang.String)
    .waitingRoomType(IResolvable)
//  .customPageHtml(java.lang.String)
//  .customPageHtml(IResolvable)
//  .description(java.lang.String)
//  .description(IResolvable)
//  .disableSessionRenewalEnable(java.lang.String)
//  .disableSessionRenewalEnable(IResolvable)
//  .jsonResponseEnable(java.lang.String)
//  .jsonResponseEnable(IResolvable)
//  .language(java.lang.String)
//  .language(IResolvable)
//  .queueAllEnable(java.lang.String)
//  .queueAllEnable(IResolvable)
    .build();

Properties

cookieName^Required

public java.lang.Object getCookieName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property cookieName: The name of the custom cookie.

hostNameAndPath^Required

public java.lang.Object getHostNameAndPath();

• Type: com.aliyun.ros.cdk.core.IResolvable OR java.util.ListHostNameAndPathProperty>

Property hostNameAndPath: The hostname and path.

newUsersPerMinute^Required

public java.lang.Object getNewUsersPerMinute();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property newUsersPerMinute: The maximum number of new users per minute.

queuingMethod^Required

public java.lang.Object getQueuingMethod();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queuingMethod: The queuing method.

Value:

• random: Users gain access to the origin randomly, regardless of the arrival time.
• fifo: Users gain access to the origin in order of arrival.
• Passthrough: Users pass through the waiting room and go straight to the origin.
• Reject-all: Users are blocked from reaching the origin.

queuingStatusCode^Required

public java.lang.Object getQueuingStatusCode();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property queuingStatusCode: Waiting room status code.

Value:

• 200
• 202
• 429.

sessionDuration^Required

public java.lang.Object getSessionDuration();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property sessionDuration: The maximum duration for which a session remains valid after a user leaves the origin.

Unit: minutes.

siteId^Required

public java.lang.Object getSiteId();

• Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property siteId: The site ID.

status^Required

public java.lang.Object getStatus();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property status: Waiting room enabled status.

Value:

• 'on': Enable waiting room
• 'off': Disabled waiting room

totalActiveUsers^Required

public java.lang.Object getTotalActiveUsers();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property totalActiveUsers: The maximum number of active users.

waitingRoomName^Required

public java.lang.Object getWaitingRoomName();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property waitingRoomName: The name of the waiting room.

waitingRoomType^Required

public java.lang.Object getWaitingRoomType();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property waitingRoomType: The type of the waiting room, support: - default: Indicates the default type.

• custom: indicates a custom type.

customPageHtml^Optional

public java.lang.Object getCustomPageHtml();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property customPageHtml: User-defined waiting room page content, when the waiting room type is custom type, you need to enter.

The incoming content needs to be base64 encoded.

description^Optional

public java.lang.Object getDescription();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property description: Waiting room description.

disableSessionRenewalEnable^Optional

public java.lang.Object getDisableSessionRenewalEnable();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property disableSessionRenewalEnable: Specifies whether to disable session renewal.

Value:

• on: open.
• off: closed.

jsonResponseEnable^Optional

public java.lang.Object getJsonResponseEnable();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property jsonResponseEnable: The JSON response.

If the accept request header contains "application/json", JSON data is returned. Value:

• on: open.
• off: closed.

language^Optional

public java.lang.Object getLanguage();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property language: The language of the waiting room page.

When the waiting room type is the default type, it needs to be passed in. The following types are supported:

• enus: English.
• zhcn: Simplified Chinese.
• zhhk: Traditional Chinese.

queueAllEnable^Optional

public java.lang.Object getQueueAllEnable();

• Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property queueAllEnable: Specifies whether to queue all requests.

Value:

• on: open.
• off: closed.