Class RedirectUri

An object that defines the redirect URI applied to the original request. The object property values compose the redirect URI.
NOTE: The Load Balancing service cannot automatically detect or avoid infinite redirects. Be sure to provide meaningful, complete, and correct field values. If any component field of this object has no value, the system retains the value from the incoming HTTP request URI.
For example, if you specify only the protocol field https, and the incoming request URI is http://example.com:8080, the resulting runtime redirect URI is https://example.com:8080. The system retains the host and port from the incoming URI and does not automatically change the port setting from 8080 to 443.
Be sure to configure valid percent-encoding (URL encoding) when needed.
In addition to static string values, you can use the following tokens to construct the redirect URI. These tokens extract values from the incoming HTTP request URI.

{protocol} : The protocol from the incoming HTTP request URI.
{host} : The domain name from the incoming HTTP request URI.
{port} : The port from the incoming HTTP request URI.
{path} : The path from the incoming HTTP request URI.
{query} : The query string from the incoming HTTP request URI.
The tokens are case sensitive. For example, {host} is a valid token, but {HOST} is not.
You can retain the literal characters of a token when you specify values for the path and query properties of the redirect URI. Use a backslash (\\) as the escape character for the \\, {, and } characters. For example, if the incoming HTTP request URI is /video, the path property value:
/example{path}123\\{path\\}
appears in the constructed redirect URI as:
/example/video123{path}

Inheritance

object

RedirectUri

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LoadbalancerService.Models

Assembly: OCI.DotNetSDK.Loadbalancer.dll

Syntax

public class RedirectUri

Properties

Host

Declaration

[JsonProperty(PropertyName = "host")]
public string Host { get; set; }

Property Value

Type Description

Type	Description
string	The valid domain name (hostname) or IP address to use in the redirect URI. When this value is null, not set, or set to `{host}`, the service preserves the original domain name from the incoming HTTP request URI. All RedirectUri tokens are valid for this property. You can use any token more than once. Curly braces are valid in this property only to surround tokens, such as `{host}` Examples: example.com appears as `example.com` in the redirect URI. in{host} appears as `inexample.com` in the redirect URI if `example.com` is the hostname in the incoming HTTP request URI. {port}{host} appears as `8081example.com` in the redirect URI if `example.com` is the hostname and the port is `8081` in the incoming HTTP request URI.

string

The valid domain name (hostname) or IP address to use in the redirect URI.
When this value is null, not set, or set to {host}, the service preserves the original domain name from the incoming HTTP request URI.
All RedirectUri tokens are valid for this property. You can use any token more than once.
Curly braces are valid in this property only to surround tokens, such as {host}
Examples:

example.com appears as example.com in the redirect URI.
in{host} appears as inexample.com in the redirect URI if example.com is the hostname in the incoming HTTP request URI.
{port}{host} appears as 8081example.com in the redirect URI if example.com is the hostname and the port is 8081 in the incoming HTTP request URI.

Path

Declaration

[JsonProperty(PropertyName = "path")]
public string Path { get; set; }

Property Value

Type Description

Type	Description
string	The HTTP URI path to use in the redirect URI. When this value is null, not set, or set to `{path}`, the service preserves the original path from the incoming HTTP request URI. To omit the path from the redirect URI, set this value to an empty string, "". All RedirectUri tokens are valid for this property. You can use any token more than once. The path string must begin with `/` if it does not begin with the `{path}` token. Examples: /example/video/123 appears as `/example/video/123` in the redirect URI. /example{path} appears as `/example/video/123` in the redirect URI if `/video/123` is the path in the incoming HTTP request URI. {path}/123 appears as `/example/video/123` in the redirect URI if `/example/video` is the path in the incoming HTTP request URI. {path}123 appears as `/example/video123` in the redirect URI if `/example/video` is the path in the incoming HTTP request URI. /{host}/123 appears as `/example.com/123` in the redirect URI if `example.com` is the hostname in the incoming HTTP request URI. /{host}/{port} appears as `/example.com/123` in the redirect URI if `example.com` is the hostname and `123` is the port in the incoming HTTP request URI. /{query} appears as `/lang=en` in the redirect URI if the query is `lang=en` in the incoming HTTP request URI.

string

The HTTP URI path to use in the redirect URI.
When this value is null, not set, or set to {path}, the service preserves the original path from the incoming HTTP request URI. To omit the path from the redirect URI, set this value to an empty string, "".
All RedirectUri tokens are valid for this property. You can use any token more than once.
The path string must begin with / if it does not begin with the {path} token.
Examples:

/example/video/123 appears as /example/video/123 in the redirect URI.
/example{path} appears as /example/video/123 in the redirect URI if /video/123 is the path in the incoming HTTP request URI.
{path}/123 appears as /example/video/123 in the redirect URI if /example/video is the path in the incoming HTTP request URI.
{path}123 appears as /example/video123 in the redirect URI if /example/video is the path in the incoming HTTP request URI.
/{host}/123 appears as /example.com/123 in the redirect URI if example.com is the hostname in the incoming HTTP request URI.
/{host}/{port} appears as /example.com/123 in the redirect URI if example.com is the hostname and 123 is the port in the incoming HTTP request URI.
/{query} appears as /lang=en in the redirect URI if the query is lang=en in the incoming HTTP request URI.

Port

Declaration

[JsonProperty(PropertyName = "port")]
public int? Port { get; set; }

Property Value

Type	Description
int?	The communication port to use in the redirect URI. Valid values include integers from 1 to 65535. When this value is null, the service preserves the original port from the incoming HTTP request URI. Example: 8081

Protocol

Declaration

[JsonProperty(PropertyName = "protocol")]
public string Protocol { get; set; }

Property Value

Type Description

Type	Description
string	The HTTP protocol to use in the redirect URI. When this value is null, not set, or set to `{protocol}`, the service preserves the original protocol from the incoming HTTP request URI. Allowed values are: HTTP HTTPS {protocol} `{protocol}` is the only valid token for this property. It can appear only once in the value string. Example: HTTPS

string

The HTTP protocol to use in the redirect URI.
When this value is null, not set, or set to {protocol}, the service preserves the original protocol from the incoming HTTP request URI. Allowed values are:

HTTP
HTTPS
{protocol}
{protocol} is the only valid token for this property. It can appear only once in the value string.
Example: HTTPS

Query

Declaration

[JsonProperty(PropertyName = "query")]
public string Query { get; set; }

Property Value

Type	Description
string