Skip to content

OriginRuleProps

Properties for defining a OriginRule.

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

Initializer

import com.aliyun.ros.cdk.esa.OriginRuleProps;
OriginRuleProps.builder()
    .siteId(java.lang.Number)
    .siteId(IResolvable)
//  .dnsRecord(java.lang.String)
//  .dnsRecord(IResolvable)
//  .follow302Enable(java.lang.String)
//  .follow302Enable(IResolvable)
//  .follow302MaxTries(java.lang.Number)
//  .follow302MaxTries(IResolvable)
//  .follow302RetainArgs(java.lang.String)
//  .follow302RetainArgs(IResolvable)
//  .follow302RetainHeader(java.lang.String)
//  .follow302RetainHeader(IResolvable)
//  .follow302TargetHost(java.lang.String)
//  .follow302TargetHost(IResolvable)
//  .originHost(java.lang.String)
//  .originHost(IResolvable)
//  .originHttpPort(java.lang.Number)
//  .originHttpPort(IResolvable)
//  .originHttpsPort(java.lang.Number)
//  .originHttpsPort(IResolvable)
//  .originMtls(java.lang.String)
//  .originMtls(IResolvable)
//  .originReadTimeout(java.lang.Number)
//  .originReadTimeout(IResolvable)
//  .originScheme(java.lang.String)
//  .originScheme(IResolvable)
//  .originSni(java.lang.String)
//  .originSni(IResolvable)
//  .originVerify(java.lang.String)
//  .originVerify(IResolvable)
//  .range(java.lang.String)
//  .range(IResolvable)
//  .rangeChunkSize(java.lang.String)
//  .rangeChunkSize(IResolvable)
//  .rule(java.lang.String)
//  .rule(IResolvable)
//  .ruleEnable(java.lang.String)
//  .ruleEnable(IResolvable)
//  .ruleName(java.lang.String)
//  .ruleName(IResolvable)
//  .sequence(java.lang.Number)
//  .sequence(IResolvable)
//  .siteVersion(java.lang.Number)
//  .siteVersion(IResolvable)
    .build();

Properties

Name Type Description
siteId java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteId: The site ID.
dnsRecord java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property dnsRecord: Overwrite the DNS resolution record of the origin request.
follow302Enable java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property follow302Enable: Return Source 302 follow switch.
follow302MaxTries java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property follow302MaxTries: 302 follows the upper limit of the number of times, with a value range of [1-5].
follow302RetainArgs java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property follow302RetainArgs: Retain the original request parameter switch.
follow302RetainHeader java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property follow302RetainHeader: Retain the original request header switch.
follow302TargetHost java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property follow302TargetHost: Modify the source host after 302.
originHost java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property originHost: The HOST carried in the back-to-origin request.
originHttpPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property originHttpPort: The port of the origin station accessed when the HTTP protocol is used to return to the origin.
originHttpsPort java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property originHttpsPort: Port of the origin server when using the HTTPS protocol for origin requests.
originMtls java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property originMtls: The mtls switch.
originReadTimeout java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property originReadTimeout: Read timeout interval of the source station (s).
originScheme java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property originScheme: The protocol used by the back-to-origin request.
originSni java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property originSni: SNI carried in the back-to-origin request.
originVerify java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property originVerify: Source station certificate verification switch.
range java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property range: Use the range sharding method to download the file from the source.
rangeChunkSize java.lang.String OR com.aliyun.ros.cdk.core.IResolvable Property rangeChunkSize: range shard size.
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.
sequence java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property sequence: Order of rule execution.
siteVersion java.lang.Number OR com.aliyun.ros.cdk.core.IResolvable Property siteVersion: The version number of the site configuration.

siteIdRequired

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

Property siteId: The site ID.


dnsRecordOptional

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

Property dnsRecord: Overwrite the DNS resolution record of the origin request.


follow302EnableOptional

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

Property follow302Enable: Return Source 302 follow switch.

Value range:

  • on: ON.
  • off: closed.

follow302MaxTriesOptional

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

Property follow302MaxTries: 302 follows the upper limit of the number of times, with a value range of [1-5].


follow302RetainArgsOptional

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

Property follow302RetainArgs: Retain the original request parameter switch.

Value range:

  • on: ON.
  • off: closed.

follow302RetainHeaderOptional

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

Property follow302RetainHeader: Retain the original request header switch.

Value range:

  • on: ON.
  • off: closed.

follow302TargetHostOptional

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

Property follow302TargetHost: Modify the source host after 302.


originHostOptional

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

Property originHost: The HOST carried in the back-to-origin request.


originHttpPortOptional

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

Property originHttpPort: The port of the origin station accessed when the HTTP protocol is used to return to the origin.


originHttpsPortOptional

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

Property originHttpsPort: Port of the origin server when using the HTTPS protocol for origin requests.


originMtlsOptional

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

Property originMtls: The mtls switch.

Value range:

  • on: ON.
  • off: closed.

originReadTimeoutOptional

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

Property originReadTimeout: Read timeout interval of the source station (s).


originSchemeOptional

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

Property originScheme: The protocol used by the back-to-origin request.

Value range:

  • http: uses the http protocol to return to the source.
  • https: uses the https protocol to return to the source.
  • follow: follows the Client Protocol back to the source.

originSniOptional

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

Property originSni: SNI carried in the back-to-origin request.


originVerifyOptional

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

Property originVerify: Source station certificate verification switch.

Value range:

  • on: ON.
  • off: closed.

rangeOptional

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

Property range: Use the range sharding method to download the file from the source.

Value range:

  • on: Open.
  • off: off.
  • force: force.

rangeChunkSizeOptional

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

Property rangeChunkSize: range shard size.


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: open.
  • off: close.

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.


sequenceOptional

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

Property sequence: Order of rule execution.

The smaller the value, the higher the priority for execution.


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.