Package software.amazon.awssdk.services.elasticloadbalancingv2.model

Class HttpHeaderConditionConfig

java.lang.Object

software.amazon.awssdk.services.elasticloadbalancingv2.model.HttpHeaderConditionConfig

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<HttpHeaderConditionConfig.Builder,HttpHeaderConditionConfig>

@Generated("software.amazon.awssdk:codegen")
public final class HttpHeaderConditionConfig
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<HttpHeaderConditionConfig.Builder,HttpHeaderConditionConfig>

Information about an HTTP header condition.

There is a set of standard HTTP header fields. You can also define custom HTTP header fields.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HttpHeaderConditionConfig.Builder

Method Summary

Modifier and Type	Method	Description
static HttpHeaderConditionConfig.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasValues()	For responses, this returns true if the service returned a value for the Values property.
String	httpHeaderName()	The name of the HTTP header field.
List<SdkField<?>>	sdkFields()
static Class<? extends HttpHeaderConditionConfig.Builder>	serializableBuilderClass()
HttpHeaderConditionConfig.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
List<String>	values()	The strings to compare against the value of the HTTP header.

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

httpHeaderName

public final String httpHeaderName()

The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.

You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.

Returns:

The name of the HTTP header field. The maximum size is 40 characters. The header name is case insensitive. The allowed characters are specified by RFC 7230. Wildcards are not supported.

You can't use an HTTP header condition to specify the host header. Use HostHeaderConditionConfig to specify a host header condition.

hasValues

public final boolean hasValues()

For responses, this returns true if the service returned a value for the Values property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

values

public final List<String> values()

The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If the same header appears multiple times in the request, we search them in order until a match is found.

If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.

Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasValues() method.

Returns:

The strings to compare against the value of the HTTP header. The maximum size of each string is 128 characters. The comparison strings are case insensitive. The following wildcard characters are supported: * (matches 0 or more characters) and ? (matches exactly 1 character).

If the same header appears multiple times in the request, we search them in order until a match is found.

If you specify multiple strings, the condition is satisfied if one of the strings matches the value of the HTTP header. To require that all of the strings are a match, create one condition per string.

toBuilder

public HttpHeaderConditionConfig.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<HttpHeaderConditionConfig.Builder,HttpHeaderConditionConfig>

builder

public static HttpHeaderConditionConfig.Builder builder()

serializableBuilderClass

public static Class<? extends HttpHeaderConditionConfig.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo