java.lang.Object
- software.amazon.awssdk.services.bedrockagentruntime.model.RerankingMetadataSelectiveModeConfiguration

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<RerankingMetadataSelectiveModeConfiguration.Builder,RerankingMetadataSelectiveModeConfiguration>
```
@Generated("software.amazon.awssdk:codegen")
public final class RerankingMetadataSelectiveModeConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<RerankingMetadataSelectiveModeConfiguration.Builder,RerankingMetadataSelectiveModeConfiguration>
```
Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static interface`	`RerankingMetadataSelectiveModeConfiguration.Builder`
`static class`	`RerankingMetadataSelectiveModeConfiguration.Type`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static RerankingMetadataSelectiveModeConfiguration.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`List<FieldForReranking>`	`fieldsToExclude()`	An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
`List<FieldForReranking>`	`fieldsToInclude()`	An array of objects, each of which specifies a metadata field to include in consideration when reranking.
`static RerankingMetadataSelectiveModeConfiguration`	`fromFieldsToExclude(List<FieldForReranking> fieldsToExclude)`	Create an instance of this class with `fieldsToExclude()` initialized to the given value.
`static RerankingMetadataSelectiveModeConfiguration`	`fromFieldsToInclude(List<FieldForReranking> fieldsToInclude)`	Create an instance of this class with `fieldsToInclude()` initialized to the given value.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasFieldsToExclude()`	For responses, this returns true if the service returned a value for the FieldsToExclude property.
`boolean`	`hasFieldsToInclude()`	For responses, this returns true if the service returned a value for the FieldsToInclude property.
`int`	`hashCode()`
`Map<String,SdkField<?>>`	`sdkFieldNameToField()`
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RerankingMetadataSelectiveModeConfiguration.Builder>`	`serializableBuilderClass()`
`RerankingMetadataSelectiveModeConfiguration.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`RerankingMetadataSelectiveModeConfiguration.Type`	`type()`	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
  - hasFieldsToExclude
```
public final boolean hasFieldsToExclude()
```
    For responses, this returns true if the service returned a value for the FieldsToExclude 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.
  - fieldsToExclude
```
public final List<FieldForReranking> fieldsToExclude()
```
    An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
    
    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 hasFieldsToExclude() method.
    
    Returns:
    
    An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
  - hasFieldsToInclude
```
public final boolean hasFieldsToInclude()
```
    For responses, this returns true if the service returned a value for the FieldsToInclude 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.
  - fieldsToInclude
```
public final List<FieldForReranking> fieldsToInclude()
```
    An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
    
    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 hasFieldsToInclude() method.
    
    Returns:
    
    An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
  - toBuilder
```
public RerankingMetadataSelectiveModeConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RerankingMetadataSelectiveModeConfiguration.Builder,RerankingMetadataSelectiveModeConfiguration>
  - builder
```
public static RerankingMetadataSelectiveModeConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RerankingMetadataSelectiveModeConfiguration.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)
```
  - fromFieldsToExclude
```
public static RerankingMetadataSelectiveModeConfiguration fromFieldsToExclude(List<FieldForReranking> fieldsToExclude)
```
    Create an instance of this class with fieldsToExclude() initialized to the given value.
    An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
    
    Parameters:
    
    fieldsToExclude - An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.
  - fromFieldsToInclude
```
public static RerankingMetadataSelectiveModeConfiguration fromFieldsToInclude(List<FieldForReranking> fieldsToInclude)
```
    Create an instance of this class with fieldsToInclude() initialized to the given value.
    An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
    
    Parameters:
    
    fieldsToInclude - An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.
  - type
```
public RerankingMetadataSelectiveModeConfiguration.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 be RerankingMetadataSelectiveModeConfiguration.Type.UNKNOWN_TO_SDK_VERSION if 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 be RerankingMetadataSelectiveModeConfiguration.Type.UNKNOWN_TO_SDK_VERSION if zero members are set, and null if more than one member is set.
  - 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

Class RerankingMetadataSelectiveModeConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

hasFieldsToExclude

fieldsToExclude

hasFieldsToInclude

fieldsToInclude

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

fromFieldsToExclude

fromFieldsToInclude

type

sdkFields

sdkFieldNameToField