Package com.oracle.bmc.loadbalancer.model

Class RedirectRule

java.lang.Object

com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

com.oracle.bmc.loadbalancer.model.Rule

com.oracle.bmc.loadbalancer.model.RedirectRule

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20170115")
public final class RedirectRule
extends Rule

An object that represents the action of returning a specified response code and a redirect URI.

Each RedirectRule object is configured for a particular listener and a designated path.

The default response code is 302 Found.

*NOTES:** * This rule applies only to HTTP listeners. * You can specify this rule only with the ruleCondition type PATH. * A listener can have only one RedirectRule object for a given original path. The pathMatchCondition attributeValue specifies the original path.
Note: Objects should always be created or deserialized using the RedirectRule.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the RedirectRule.Builder, which maintain a set of all explicitly set fields called RedirectRule.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RedirectRule.Builder

Nested classes/interfaces inherited from class com.oracle.bmc.loadbalancer.model.Rule

Rule.Action

Field Summary

Fields inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME

Constructor Summary

Constructors

Constructor	Description
RedirectRule(Integer responseCode, List<RuleCondition> conditions, RedirectUri redirectUri)	Deprecated.

Method Summary

Modifier and Type	Method	Description
static RedirectRule.Builder	builder()	Create a new builder.
boolean	equals(Object o)
List<RuleCondition>	getConditions()
RedirectUri	getRedirectUri()
Integer	getResponseCode()	The HTTP status code to return when the incoming request is redirected.
int	hashCode()
RedirectRule.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents)	Return a string representation of the object.

Methods inherited from class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RedirectRule

@Deprecated
public RedirectRule(Integer responseCode,
                    List<RuleCondition> conditions,
                    RedirectUri redirectUri)

Deprecated.

Method Detail

builder

public static RedirectRule.Builder builder()

Create a new builder.

toBuilder

public RedirectRule.Builder toBuilder()

getResponseCode

public Integer getResponseCode()

The HTTP status code to return when the incoming request is redirected.

The status line returned with the code is mapped from the standard HTTP specification. Valid response codes for redirection are:

301 * 302 * 303 * 307 * 308

The default value is 302 (Found).

Example: 301

Returns:

the value

getConditions

public List<RuleCondition> getConditions()

getRedirectUri

public RedirectUri getRedirectUri()

toString

public String toString()

Overrides:

toString in class Rule

toString

public String toString(boolean includeByteArrayContents)

Return a string representation of the object.

Overrides:

toString in class Rule

Parameters:

includeByteArrayContents - true to include the full contents of byte arrays

Returns:

string representation

equals

public boolean equals(Object o)

Overrides:

equals in class Rule

hashCode

public int hashCode()

Overrides:

hashCode in class Rule