RuleCondition (AWS Java SDK :: Services :: Elastic Load Balancing V2 2.17.275 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.

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.

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()`
`boolean`	`hasValues()` For responses, this returns true if the service returned a value for the Values property.
`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 final 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
  - 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 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)
    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 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)
  - hostHeaderConfig
```
public final 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 final 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 final 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 final 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 final 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 final 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 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

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

hasValues

values

hostHeaderConfig

pathPatternConfig

httpHeaderConfig

queryStringConfig

httpRequestMethodConfig

sourceIpConfig

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields