RuleCondition (AWS Java SDK :: Services :: Elastic Load Balancing V2 2.9.26 API)

java.lang.Object
- software.amazon.awssdk.services.elasticloadbalancingv2.model.RuleCondition

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<RuleCondition.Builder,RuleCondition>

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

Information about a condition for a rule.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RuleCondition.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RuleCondition.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static RuleCondition.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`field()` The field in the HTTP request.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`HostHeaderConditionConfig`	`hostHeaderConfig()` Information for a host header condition.
`HttpHeaderConditionConfig`	`httpHeaderConfig()` Information for an HTTP header condition.
`HttpRequestMethodConditionConfig`	`httpRequestMethodConfig()` Information for an HTTP method condition.
`PathPatternConditionConfig`	`pathPatternConfig()` Information for a path pattern condition.
`QueryStringConditionConfig`	`queryStringConfig()` Information for a query string condition.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RuleCondition.Builder>`	`serializableBuilderClass()`
`SourceIpConditionConfig`	`sourceIpConfig()` Information for a source IP condition.
`RuleCondition.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`List<String>`	`values()` The condition value.

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
  - field
```
public 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
    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
  - values
```
public List<String> values()
```
    The condition value. You can use Values if the rule contains only host-header and path-pattern conditions. Otherwise, you can use HostHeaderConfig for host-header conditions and PathPatternConfig for path-pattern conditions.
    
    If Field is host-header, you can specify a single host name (for example, my.example.com). 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, you can specify a single path pattern (for example, /img/*). 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)
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    Returns:
    The condition value. You can use Values if the rule contains only host-header and path-pattern conditions. Otherwise, you can use HostHeaderConfig for host-header conditions and PathPatternConfig for path-pattern conditions.
    
    If Field is host-header, you can specify a single host name (for example, my.example.com). 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, you can specify a single path pattern (for example, /img/*). 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)
  - hostHeaderConfig
```
public HostHeaderConditionConfig hostHeaderConfig()
```
    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 .
  - pathPatternConfig
```
public PathPatternConditionConfig pathPatternConfig()
```
    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.
  - httpHeaderConfig
```
public HttpHeaderConditionConfig httpHeaderConfig()
```
    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.
  - queryStringConfig
```
public QueryStringConditionConfig queryStringConfig()
```
    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.
  - httpRequestMethodConfig
```
public HttpRequestMethodConditionConfig httpRequestMethodConfig()
```
    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.
  - sourceIpConfig
```
public SourceIpConditionConfig sourceIpConfig()
```
    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.
  - toBuilder
```
public RuleCondition.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RuleCondition.Builder,RuleCondition>
  - builder
```
public static RuleCondition.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RuleCondition.Builder> serializableBuilderClass()
```
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - equalsBySdkFields
```
public boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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
  - getValueForField
```
public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)
```
  - sdkFields
```
public List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RuleCondition

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

field

values

hostHeaderConfig

pathPatternConfig

httpHeaderConfig

queryStringConfig

httpRequestMethodConfig

sourceIpConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields