Package software.amazon.awssdk.services.bedrockagent.model

Class PatternObjectFilter

java.lang.Object
software.amazon.awssdk.services.bedrockagent.model.PatternObjectFilter
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<PatternObjectFilter.Builder,PatternObjectFilter>
@Generated("software.amazon.awssdk:codegen") public final class PatternObjectFilter extends Object implements SdkPojo, Serializable, ToCopyableBuilder<PatternObjectFilter.Builder,PatternObjectFilter>

The specific filters applied to your data source content. You can filter out or include certain content.

See Also:

  • Method Details

    • objectType

      public final String objectType()

      The supported object type or content type of the data source.

      Returns:
      The supported object type or content type of the data source.

    • hasInclusionFilters

      public final boolean hasInclusionFilters()
      For responses, this returns true if the service returned a value for the InclusionFilters 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.

    • inclusionFilters

      public final List<String> inclusionFilters()

      A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

      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 hasInclusionFilters() method.

      Returns:
      A list of one or more inclusion regular expression patterns to include certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

    • hasExclusionFilters

      public final boolean hasExclusionFilters()
      For responses, this returns true if the service returned a value for the ExclusionFilters 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.

    • exclusionFilters

      public final List<String> exclusionFilters()

      A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

      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 hasExclusionFilters() method.

      Returns:
      A list of one or more exclusion regular expression patterns to exclude certain object types that adhere to the pattern. If you specify an inclusion and exclusion filter/pattern and both match a document, the exclusion filter takes precedence and the document isn’t crawled.

    • toBuilder

      public PatternObjectFilter.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<PatternObjectFilter.Builder,PatternObjectFilter>

    • builder

      public static PatternObjectFilter.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PatternObjectFilter.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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo