Class HeaderMatchPattern
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HeaderMatchPattern.Builder,
HeaderMatchPattern>
The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either All
, IncludedHeaders
, or
ExcludedHeaders
.
Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal All
all()
Inspect all headers.static HeaderMatchPattern.Builder
builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.Inspect only the headers whose keys don't match any of the strings specified here.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 ExcludedHeaders property.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the IncludedHeaders property.Inspect only the headers that have a key that matches one of the strings specified here.static Class
<? extends HeaderMatchPattern.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
-
all
Inspect all headers.
- Returns:
- Inspect all headers.
-
hasIncludedHeaders
public final boolean hasIncludedHeaders()For responses, this returns true if the service returned a value for the IncludedHeaders 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. -
includedHeaders
Inspect only the headers that have a key that matches one of the strings specified here.
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
hasIncludedHeaders()
method.- Returns:
- Inspect only the headers that have a key that matches one of the strings specified here.
-
hasExcludedHeaders
public final boolean hasExcludedHeaders()For responses, this returns true if the service returned a value for the ExcludedHeaders 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. -
excludedHeaders
Inspect only the headers whose keys don't match any of the strings specified here.
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
hasExcludedHeaders()
method.- Returns:
- Inspect only the headers whose keys don't match any of the strings specified here.
-
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<HeaderMatchPattern.Builder,
HeaderMatchPattern> - 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
-