com.oracle.bmc.loadbalancer.model

Class ExtendHttpRequestHeaderValueRule

java.lang.Object

com.oracle.bmc.http.internal.ExplicitlySetBmcModel

com.oracle.bmc.loadbalancer.model.Rule

com.oracle.bmc.loadbalancer.model.ExtendHttpRequestHeaderValueRule

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

An object that represents the action of modifying a request header value. This rule applies only to HTTP listeners.

This rule adds a prefix, a suffix, or both to the header value.

NOTES:**

This rule requires a value for a prefix, suffix, or both.

The system does not support this rule for headers with multiple values.

The system does not distinquish between underscore and dash characters in headers. That is, it treats example_header_name and example-header-name as identical. If two such headers appear in a request, the system applies the action to the first header it finds. The affected header cannot be determined in advance. Oracle recommends that you do not rely on underscore or dash characters to uniquely distinguish header names.
Note: Objects should always be created or deserialized using the ExtendHttpRequestHeaderValueRule.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 ExtendHttpRequestHeaderValueRule.Builder, which maintain a set of all explicitly set fields called ExplicitlySetBmcModel.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take ExplicitlySetBmcModel.__explicitlySet__ into account. The constructor, on the other hand, does not set ExplicitlySetBmcModel.__explicitlySet__ (since the constructor cannot distinguish explicit null from unset null).

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ExtendHttpRequestHeaderValueRule.Builder

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

Rule.Action

Constructor Summary

Constructors

Constructor and Description
ExtendHttpRequestHeaderValueRule(String header, String prefix, String suffix) Deprecated.

Method Summary

Modifier and Type	Method and Description
static ExtendHttpRequestHeaderValueRule.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getHeader() A header name that conforms to RFC 7230.
String	getPrefix() A string to prepend to the header value.
String	getSuffix() A string to append to the header value.
int	hashCode()
ExtendHttpRequestHeaderValueRule.Builder	toBuilder()
String	toString()
String	toString(boolean includeByteArrayContents) Return a string representation of the object.

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

markPropertyAsExplicitlySet, wasPropertyExplicitlySet

Methods inherited from class java.lang.Object

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

Constructor Detail

ExtendHttpRequestHeaderValueRule

@Deprecated
public ExtendHttpRequestHeaderValueRule(String header,
                                                    String prefix,
                                                    String suffix)

Deprecated.

Method Detail

builder

public static ExtendHttpRequestHeaderValueRule.Builder builder()

Create a new builder.

toBuilder

public ExtendHttpRequestHeaderValueRule.Builder toBuilder()

getHeader

public String getHeader()

A header name that conforms to RFC 7230.

Example: example_header_name

Returns:

the value

getPrefix

public String getPrefix()

A string to prepend to the header value. The resulting header value must conform to RFC 7230. With the following exceptions:

• value cannot contain $
• value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.

Example: example_prefix_value

Returns:

the value

getSuffix

public String getSuffix()

A string to append to the header value. The resulting header value must conform to RFC 7230. With the following exceptions:

• value cannot contain $
• value cannot contain patterns like {variable_name}. They are reserved for future extensions. Currently, such values are invalid.

Example: example_suffix_value

Returns:

the value

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