com.oracle.bmc.loadbalancer.model

Class AddHttpRequestHeaderRule

java.lang.Object

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

com.oracle.bmc.loadbalancer.model.Rule

com.oracle.bmc.loadbalancer.model.AddHttpRequestHeaderRule

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

An object that represents the action of adding a header to a request. This rule applies only to HTTP listeners. NOTES:

If a matching header already exists in the request, the system removes all of its occurrences, and then adds the new header.

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. 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 AddHttpRequestHeaderRule.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 AddHttpRequestHeaderRule.Builder, which maintain a set of all explicitly set fields called AddHttpRequestHeaderRule.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 and Description
static class	AddHttpRequestHeaderRule.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 and Description
AddHttpRequestHeaderRule(String header, String value) Deprecated.

Method Summary

Modifier and Type	Method and Description
static AddHttpRequestHeaderRule.Builder	builder() Create a new builder.
boolean	equals(Object o)
String	getHeader() A header name that conforms to RFC 7230.
String	getValue() A header value that conforms to RFC 7230.
int	hashCode()
AddHttpRequestHeaderRule.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

AddHttpRequestHeaderRule

@Deprecated
public AddHttpRequestHeaderRule(String header,
                                            String value)

Deprecated.

Method Detail

builder

public static AddHttpRequestHeaderRule.Builder builder()

Create a new builder.

toBuilder

public AddHttpRequestHeaderRule.Builder toBuilder()

getHeader

public String getHeader()

A header name that conforms to RFC 7230.

Example: example_header_name

Returns:

the value

getValue

public String getValue()

A header value that conforms 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_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