Skip to content

RedirectRuleProps

Properties for defining a RedirectRule.

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

Initializer

import com.aliyun.ros.cdk.esa.RedirectRuleProps;
RedirectRuleProps.builder()
    .reserveQueryString(java.lang.String)
    .reserveQueryString(IResolvable)
    .siteId(java.lang.Number)
    .siteId(IResolvable)
    .statusCode(java.lang.Number)
    .statusCode(IResolvable)
    .targetUrl(java.lang.String)
    .targetUrl(IResolvable)
    .type(java.lang.String)
    .type(IResolvable)
//  .rule(java.lang.String)
//  .rule(IResolvable)
//  .ruleEnable(java.lang.String)
//  .ruleEnable(IResolvable)
//  .ruleName(java.lang.String)
//  .ruleName(IResolvable)
//  .siteVersion(java.lang.Number)
//  .siteVersion(IResolvable)
    .build();

Properties

Name Type Description
reserveQueryString java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property reserveQueryString: Indicates whether the feature of retaining the query string is enabled.
siteId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteId: The website ID.
statusCode java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property statusCode: The response code that you want to use to indicate URL redirection.
targetUrl java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property targetUrl: The destination URL to which requests are redirected.
type java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property type: The redirect type.
rule java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property rule: Rule content, using conditional expressions to match user requests.
ruleEnable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleEnable: Rule switch.
ruleName java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property ruleName: Rule name.
siteVersion java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteVersion: The version number of the site configuration.

reserveQueryStringRequired

public java.lang.Object getReserveQueryString();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property reserveQueryString: Indicates whether the feature of retaining the query string is enabled.

Valid values: on off.


siteIdRequired

public java.lang.Object getSiteId();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property siteId: The website ID.


statusCodeRequired

public java.lang.Object getStatusCode();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property statusCode: The response code that you want to use to indicate URL redirection.

Valid values:

  • 301
  • 302
  • 303
  • 307
  • 1.

targetUrlRequired

public java.lang.Object getTargetUrl();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property targetUrl: The destination URL to which requests are redirected.


typeRequired

public java.lang.Object getType();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property type: The redirect type.

Valid value:

  • static.

ruleOptional

public java.lang.Object getRule();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property rule: Rule content, using conditional expressions to match user requests.

When adding global configuration, this parameter does not need to be set. There are two usage scenarios: Match all incoming requests: value set to true Match specified request: Set the value to a custom expression, for example: (http.host eq "video.example.com").


ruleEnableOptional

public java.lang.Object getRuleEnable();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ruleEnable: Rule switch.

When adding global configuration, this parameter does not need to be set. Value range: on off.


ruleNameOptional

public java.lang.Object getRuleName();
  • Type: java.lang.String OR com.aliyun.ros.cdk.core.IResolvable

Property ruleName: Rule name.

When adding global configuration, this parameter does not need to be set.


siteVersionOptional

public java.lang.Object getSiteVersion();
  • Type: java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable

Property siteVersion: The version number of the site configuration.

For sites that have enabled configuration version management, this parameter can be used to specify the effective version of the configuration site, which defaults to version 0.