Package com.oracle.bmc.loadbalancer.model

Class ExtendHttpResponseHeaderValueRule

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20170115")
public final class ExtendHttpResponseHeaderValueRule
extends Rule
    An object that represents the action of modifying a response 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 ExtendHttpResponseHeaderValueRule.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 ExtendHttpResponseHeaderValueRule.Builder, which maintain a set of all explicitly set fields called ExtendHttpResponseHeaderValueRule.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).

    • Constructor Detail

      • ExtendHttpResponseHeaderValueRule

        @Deprecated
public ExtendHttpResponseHeaderValueRule​(String header,
                                         String prefix,
                                         String suffix)
        Deprecated.

    • Method Detail

      • 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 still 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 still 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​(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