com.amazonaws.services.elasticloadbalancingv2.model

Class RuleCondition

java.lang.Object

com.amazonaws.services.elasticloadbalancingv2.model.RuleCondition

All Implemented Interfaces:

Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class RuleCondition
extends Object
implements Serializable, Cloneable

Information about a condition for a rule.

Each rule can optionally include up to one of each of the following conditions: http-request-method, host-header, path-pattern, and source-ip. Each rule can also optionally include one or more of each of the following conditions: http-header and query-string. Note that the value for a condition cannot be empty.

For more information, see Quotas for your Application Load Balancers.

See Also:

AWS API Documentation, Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuleCondition()

Method Summary

Modifier and Type	Method and Description
RuleCondition	clone()
boolean	equals(Object obj)
String	getField() The field in the HTTP request.
HostHeaderConditionConfig	getHostHeaderConfig() Information for a host header condition.
HttpHeaderConditionConfig	getHttpHeaderConfig() Information for an HTTP header condition.
HttpRequestMethodConditionConfig	getHttpRequestMethodConfig() Information for an HTTP method condition.
PathPatternConditionConfig	getPathPatternConfig() Information for a path pattern condition.
QueryStringConditionConfig	getQueryStringConfig() Information for a query string condition.
SourceIpConditionConfig	getSourceIpConfig() Information for a source IP condition.
List<String>	getValues() The condition value.
int	hashCode()
void	setField(String field) The field in the HTTP request.
void	setHostHeaderConfig(HostHeaderConditionConfig hostHeaderConfig) Information for a host header condition.
void	setHttpHeaderConfig(HttpHeaderConditionConfig httpHeaderConfig) Information for an HTTP header condition.
void	setHttpRequestMethodConfig(HttpRequestMethodConditionConfig httpRequestMethodConfig) Information for an HTTP method condition.
void	setPathPatternConfig(PathPatternConditionConfig pathPatternConfig) Information for a path pattern condition.
void	setQueryStringConfig(QueryStringConditionConfig queryStringConfig) Information for a query string condition.
void	setSourceIpConfig(SourceIpConditionConfig sourceIpConfig) Information for a source IP condition.
void	setValues(Collection<String> values) The condition value.
String	toString() Returns a string representation of this object.
RuleCondition	withField(String field) The field in the HTTP request.
RuleCondition	withHostHeaderConfig(HostHeaderConditionConfig hostHeaderConfig) Information for a host header condition.
RuleCondition	withHttpHeaderConfig(HttpHeaderConditionConfig httpHeaderConfig) Information for an HTTP header condition.
RuleCondition	withHttpRequestMethodConfig(HttpRequestMethodConditionConfig httpRequestMethodConfig) Information for an HTTP method condition.
RuleCondition	withPathPatternConfig(PathPatternConditionConfig pathPatternConfig) Information for a path pattern condition.
RuleCondition	withQueryStringConfig(QueryStringConditionConfig queryStringConfig) Information for a query string condition.
RuleCondition	withSourceIpConfig(SourceIpConditionConfig sourceIpConfig) Information for a source IP condition.
RuleCondition	withValues(Collection<String> values) The condition value.
RuleCondition	withValues(String... values) The condition value.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

RuleCondition

public RuleCondition()

Method Detail

setField

public void setField(String field)

The field in the HTTP request. The following are the possible values:

• http-header

• http-request-method

• host-header

• path-pattern

• query-string

• source-ip

Parameters:

field - The field in the HTTP request. The following are the possible values:

• http-header

• http-request-method

• host-header

• path-pattern

• query-string

• source-ip

getField

public String getField()

The field in the HTTP request. The following are the possible values:

• http-header

• http-request-method

• host-header

• path-pattern

• query-string

• source-ip

Returns:

The field in the HTTP request. The following are the possible values:

• http-header

• http-request-method

• host-header

• path-pattern

• query-string

• source-ip

withField

public RuleCondition withField(String field)

The field in the HTTP request. The following are the possible values:

• http-header

• http-request-method

• host-header

• path-pattern

• query-string

• source-ip

Parameters:

field - The field in the HTTP request. The following are the possible values:

• http-header

• http-request-method

• host-header

• path-pattern

• query-string

• source-ip

Returns:

Returns a reference to this object so that method calls can be chained together.

getValues

public List<String> getValues()

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• - .

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• _ - . $ / ~ " ' @ : +

• & (using &)

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

Returns:

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• - .

• (matches 0 or more characters)

• ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• _ - . $ / ~ " ' @ : +

• & (using &)

• (matches 0 or more characters)

• ? (matches exactly 1 character)

setValues

public void setValues(Collection<String> values)

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• - .

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• _ - . $ / ~ " ' @ : +

• & (using &)

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

Parameters:

values - The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• - .

• (matches 0 or more characters)

• ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• _ - . $ / ~ " ' @ : +

• & (using &)

• (matches 0 or more characters)

• ? (matches exactly 1 character)

withValues

public RuleCondition withValues(String... values)

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• - .

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• _ - . $ / ~ " ' @ : +

• & (using &)

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

NOTE: This method appends the values to the existing list (if any). Use setValues(java.util.Collection) or withValues(java.util.Collection) if you want to override the existing values.

Parameters:

values - The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• - .

• (matches 0 or more characters)

• ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• _ - . $ / ~ " ' @ : +

• & (using &)

• (matches 0 or more characters)

• ? (matches exactly 1 character)

Returns:

Returns a reference to this object so that method calls can be chained together.

withValues

public RuleCondition withValues(Collection<String> values)

The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• - .

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• _ - . $ / ~ " ' @ : +

• & (using &)

• * (matches 0 or more characters)

• ? (matches exactly 1 character)

Parameters:

values - The condition value. Specify only when Field is host-header or path-pattern. Alternatively, to specify multiple host names or multiple path patterns, use HostHeaderConfig or PathPatternConfig.

If Field is host-header and you are not using HostHeaderConfig, you can specify a single host name (for example, my.example.com) in Values. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• - .

• (matches 0 or more characters)

• ? (matches exactly 1 character)

If Field is path-pattern and you are not using PathPatternConfig, you can specify a single path pattern (for example, /img/*) in Values. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.

• A-Z, a-z, 0-9

• _ - . $ / ~ " ' @ : +

• & (using &)

• (matches 0 or more characters)

• ? (matches exactly 1 character)

Returns:

Returns a reference to this object so that method calls can be chained together.

setHostHeaderConfig

public void setHostHeaderConfig(HostHeaderConditionConfig hostHeaderConfig)

Information for a host header condition. Specify only when Field is host-header.

Parameters:

hostHeaderConfig - Information for a host header condition. Specify only when Field is host-header.

getHostHeaderConfig

public HostHeaderConditionConfig getHostHeaderConfig()

Information for a host header condition. Specify only when Field is host-header.

Returns:

Information for a host header condition. Specify only when Field is host-header .

withHostHeaderConfig

public RuleCondition withHostHeaderConfig(HostHeaderConditionConfig hostHeaderConfig)

Information for a host header condition. Specify only when Field is host-header.

Parameters:

hostHeaderConfig - Information for a host header condition. Specify only when Field is host-header.

Returns:

Returns a reference to this object so that method calls can be chained together.

setPathPatternConfig

public void setPathPatternConfig(PathPatternConditionConfig pathPatternConfig)

Information for a path pattern condition. Specify only when Field is path-pattern.

Parameters:

pathPatternConfig - Information for a path pattern condition. Specify only when Field is path-pattern.

getPathPatternConfig

public PathPatternConditionConfig getPathPatternConfig()

Information for a path pattern condition. Specify only when Field is path-pattern.

Returns:

Information for a path pattern condition. Specify only when Field is path-pattern.

withPathPatternConfig

public RuleCondition withPathPatternConfig(PathPatternConditionConfig pathPatternConfig)

Information for a path pattern condition. Specify only when Field is path-pattern.

Parameters:

pathPatternConfig - Information for a path pattern condition. Specify only when Field is path-pattern.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHttpHeaderConfig

public void setHttpHeaderConfig(HttpHeaderConditionConfig httpHeaderConfig)

Information for an HTTP header condition. Specify only when Field is http-header.

Parameters:

httpHeaderConfig - Information for an HTTP header condition. Specify only when Field is http-header .

getHttpHeaderConfig

public HttpHeaderConditionConfig getHttpHeaderConfig()

Information for an HTTP header condition. Specify only when Field is http-header.

Returns:

Information for an HTTP header condition. Specify only when Field is http-header.

withHttpHeaderConfig

public RuleCondition withHttpHeaderConfig(HttpHeaderConditionConfig httpHeaderConfig)

Information for an HTTP header condition. Specify only when Field is http-header.

Parameters:

httpHeaderConfig - Information for an HTTP header condition. Specify only when Field is http-header .

Returns:

Returns a reference to this object so that method calls can be chained together.

setQueryStringConfig

public void setQueryStringConfig(QueryStringConditionConfig queryStringConfig)

Information for a query string condition. Specify only when Field is query-string.

Parameters:

queryStringConfig - Information for a query string condition. Specify only when Field is query-string.

getQueryStringConfig

public QueryStringConditionConfig getQueryStringConfig()

Information for a query string condition. Specify only when Field is query-string.

Returns:

Information for a query string condition. Specify only when Field is query-string.

withQueryStringConfig

public RuleCondition withQueryStringConfig(QueryStringConditionConfig queryStringConfig)

Information for a query string condition. Specify only when Field is query-string.

Parameters:

queryStringConfig - Information for a query string condition. Specify only when Field is query-string.

Returns:

Returns a reference to this object so that method calls can be chained together.

setHttpRequestMethodConfig

public void setHttpRequestMethodConfig(HttpRequestMethodConditionConfig httpRequestMethodConfig)

Information for an HTTP method condition. Specify only when Field is http-request-method.

Parameters:

httpRequestMethodConfig - Information for an HTTP method condition. Specify only when Field is http-request-method.

getHttpRequestMethodConfig

public HttpRequestMethodConditionConfig getHttpRequestMethodConfig()

Information for an HTTP method condition. Specify only when Field is http-request-method.

Returns:

Information for an HTTP method condition. Specify only when Field is http-request-method.

withHttpRequestMethodConfig

public RuleCondition withHttpRequestMethodConfig(HttpRequestMethodConditionConfig httpRequestMethodConfig)

Information for an HTTP method condition. Specify only when Field is http-request-method.

Parameters:

httpRequestMethodConfig - Information for an HTTP method condition. Specify only when Field is http-request-method.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSourceIpConfig

public void setSourceIpConfig(SourceIpConditionConfig sourceIpConfig)

Information for a source IP condition. Specify only when Field is source-ip.

Parameters:

sourceIpConfig - Information for a source IP condition. Specify only when Field is source-ip.

getSourceIpConfig

public SourceIpConditionConfig getSourceIpConfig()

Information for a source IP condition. Specify only when Field is source-ip.

Returns:

Information for a source IP condition. Specify only when Field is source-ip.

withSourceIpConfig

public RuleCondition withSourceIpConfig(SourceIpConditionConfig sourceIpConfig)

Information for a source IP condition. Specify only when Field is source-ip.

Parameters:

sourceIpConfig - Information for a source IP condition. Specify only when Field is source-ip.

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public 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

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public RuleCondition clone()

Overrides:

clone in class Object