Class Rule
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<Rule.Builder,
Rule>
Information about a rule.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionactions()
The actions.static Rule.Builder
builder()
final List
<RuleCondition> The conditions.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final boolean
For responses, this returns true if the service returned a value for the Actions property.final boolean
For responses, this returns true if the service returned a value for the Conditions property.final int
hashCode()
final Boolean
Indicates whether this is the default rule.final String
priority()
The priority.final String
ruleArn()
The Amazon Resource Name (ARN) of the rule.static Class
<? extends Rule.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
ruleArn
The Amazon Resource Name (ARN) of the rule.
- Returns:
- The Amazon Resource Name (ARN) of the rule.
-
priority
The priority.
- Returns:
- The priority.
-
hasConditions
public final boolean hasConditions()For responses, this returns true if the service returned a value for the Conditions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
conditions
The conditions. Each rule can include zero or one of the following conditions:
http-request-method
,host-header
,path-pattern
, andsource-ip
, and zero or more of the following conditions:http-header
andquery-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
hasConditions()
method.- Returns:
- The conditions. Each rule can include zero or one of the following conditions:
http-request-method
,host-header
,path-pattern
, andsource-ip
, and zero or more of the following conditions:http-header
andquery-string
.
-
hasActions
public final boolean hasActions()For responses, this returns true if the service returned a value for the Actions property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
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. -
actions
The actions. Each rule must include exactly one of the following types of actions:
forward
,redirect
, orfixed-response
, and it must be the last action to be performed.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
hasActions()
method.- Returns:
- The actions. Each rule must include exactly one of the following types of actions:
forward
,redirect
, orfixed-response
, and it must be the last action to be performed.
-
isDefault
Indicates whether this is the default rule.
- Returns:
- Indicates whether this is the default rule.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<Rule.Builder,
Rule> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-