Class RequestMetadataFilters
- java.lang.Object
-
- software.amazon.awssdk.services.bedrock.model.RequestMetadataFilters
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<RequestMetadataFilters.Builder,RequestMetadataFilters>
@Generated("software.amazon.awssdk:codegen") public final class RequestMetadataFilters extends Object implements SdkPojo, Serializable, ToCopyableBuilder<RequestMetadataFilters.Builder,RequestMetadataFilters>
Rules for filtering invocation logs. A filter can be a mapping of a metadata key to a value that it should or should not equal (a base filter), or a list of base filters that are all applied with
ANDorORlogical operators- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceRequestMetadataFilters.Builderstatic classRequestMetadataFilters.Type
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description List<RequestMetadataBaseFilters>andAll()Include results where all of the based filters match.static RequestMetadataFilters.Builderbuilder()booleanequals(Object obj)booleanequalsBySdkFields(Object obj)Map<String,String>equalsValue()Include results where the key equals the value.static RequestMetadataFiltersfromAndAll(List<RequestMetadataBaseFilters> andAll)Create an instance of this class withandAll()initialized to the given value.static RequestMetadataFiltersfromEqualsValue(Map<String,String> equalsValue)Create an instance of this class withequalsValue()initialized to the given value.static RequestMetadataFiltersfromNotEquals(Map<String,String> notEquals)Create an instance of this class withnotEquals()initialized to the given value.static RequestMetadataFiltersfromOrAll(List<RequestMetadataBaseFilters> orAll)Create an instance of this class withorAll()initialized to the given value.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasAndAll()For responses, this returns true if the service returned a value for the AndAll property.booleanhasEqualsValue()For responses, this returns true if the service returned a value for the Equals property.inthashCode()booleanhasNotEquals()For responses, this returns true if the service returned a value for the NotEquals property.booleanhasOrAll()For responses, this returns true if the service returned a value for the OrAll property.Map<String,String>notEquals()Include results where the key does not equal the value.List<RequestMetadataBaseFilters>orAll()Include results where any of the base filters match.Map<String,SdkField<?>>sdkFieldNameToField()List<SdkField<?>>sdkFields()static Class<? extends RequestMetadataFilters.Builder>serializableBuilderClass()RequestMetadataFilters.BuildertoBuilder()StringtoString()Returns a string representation of this object.RequestMetadataFilters.Typetype()Retrieve an enum value representing which member of this object is populated.-
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
-
hasEqualsValue
public final boolean hasEqualsValue()
For responses, this returns true if the service returned a value for the Equals 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.
-
equalsValue
public final Map<String,String> equalsValue()
Include results where the key equals the value.
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
hasEqualsValue()method.- Returns:
- Include results where the key equals the value.
-
hasNotEquals
public final boolean hasNotEquals()
For responses, this returns true if the service returned a value for the NotEquals 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.
-
notEquals
public final Map<String,String> notEquals()
Include results where the key does not equal the value.
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
hasNotEquals()method.- Returns:
- Include results where the key does not equal the value.
-
hasAndAll
public final boolean hasAndAll()
For responses, this returns true if the service returned a value for the AndAll 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.
-
andAll
public final List<RequestMetadataBaseFilters> andAll()
Include results where all of the based filters match.
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
hasAndAll()method.- Returns:
- Include results where all of the based filters match.
-
hasOrAll
public final boolean hasOrAll()
For responses, this returns true if the service returned a value for the OrAll 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.
-
orAll
public final List<RequestMetadataBaseFilters> orAll()
Include results where any of the base filters match.
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
hasOrAll()method.- Returns:
- Include results where any of the base filters match.
-
toBuilder
public RequestMetadataFilters.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<RequestMetadataFilters.Builder,RequestMetadataFilters>
-
builder
public static RequestMetadataFilters.Builder builder()
-
serializableBuilderClass
public static Class<? extends RequestMetadataFilters.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
fromEqualsValue
public static RequestMetadataFilters fromEqualsValue(Map<String,String> equalsValue)
Create an instance of this class withequalsValue()initialized to the given value.Include results where the key equals the value.
- Parameters:
equalsValue- Include results where the key equals the value.
-
fromNotEquals
public static RequestMetadataFilters fromNotEquals(Map<String,String> notEquals)
Create an instance of this class withnotEquals()initialized to the given value.Include results where the key does not equal the value.
- Parameters:
notEquals- Include results where the key does not equal the value.
-
fromAndAll
public static RequestMetadataFilters fromAndAll(List<RequestMetadataBaseFilters> andAll)
Create an instance of this class withandAll()initialized to the given value.Include results where all of the based filters match.
- Parameters:
andAll- Include results where all of the based filters match.
-
fromOrAll
public static RequestMetadataFilters fromOrAll(List<RequestMetadataBaseFilters> orAll)
Create an instance of this class withorAll()initialized to the given value.Include results where any of the base filters match.
- Parameters:
orAll- Include results where any of the base filters match.
-
type
public RequestMetadataFilters.Type type()
Retrieve an enum value representing which member of this object is populated. When this class is returned in a service response, this will beRequestMetadataFilters.Type.UNKNOWN_TO_SDK_VERSIONif the service returned a member that is only known to a newer SDK version. When this class is created directly in your code, this will beRequestMetadataFilters.Type.UNKNOWN_TO_SDK_VERSIONif zero members are set, andnullif more than one member is set.
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo
-
-