Class AutomatedReasoningPolicyGenerateFidelityReportContent

java.lang.Object

software.amazon.awssdk.services.bedrock.model.AutomatedReasoningPolicyGenerateFidelityReportContent

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AutomatedReasoningPolicyGenerateFidelityReportContent.Builder,AutomatedReasoningPolicyGenerateFidelityReportContent>

@Generated("software.amazon.awssdk:codegen")
public final class AutomatedReasoningPolicyGenerateFidelityReportContent
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AutomatedReasoningPolicyGenerateFidelityReportContent.Builder,AutomatedReasoningPolicyGenerateFidelityReportContent>

Configuration for generating a fidelity report, which can either analyze new documents or update an existing fidelity report with a new policy definition.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AutomatedReasoningPolicyGenerateFidelityReportContent.Builder
static enum	AutomatedReasoningPolicyGenerateFidelityReportContent.Type

Method Summary

Modifier and Type	Method	Description
static AutomatedReasoningPolicyGenerateFidelityReportContent.Builder	builder()
final List<AutomatedReasoningPolicyBuildWorkflowDocument>	documents()	Source documents to analyze for generating a new fidelity report.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)	Indicates whether some other object is "equal to" this one by SDK fields.
static AutomatedReasoningPolicyGenerateFidelityReportContent	fromDocuments(List<AutomatedReasoningPolicyBuildWorkflowDocument> documents)	Create an instance of this class with documents() initialized to the given value.
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final boolean	hasDocuments()	For responses, this returns true if the service returned a value for the Documents property.
final int	hashCode()
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends AutomatedReasoningPolicyGenerateFidelityReportContent.Builder>	serializableBuilderClass()
AutomatedReasoningPolicyGenerateFidelityReportContent.Builder	toBuilder()	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.
AutomatedReasoningPolicyGenerateFidelityReportContent.Type	type()	Retrieve an enum value representing which member of this object is populated.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Details

hasDocuments

public final boolean hasDocuments()

For responses, this returns true if the service returned a value for the Documents 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.

documents

public final List<AutomatedReasoningPolicyBuildWorkflowDocument> documents()

Source documents to analyze for generating a new fidelity report. The documents will be processed to create atomic statements and grounding information.

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

Returns:

Source documents to analyze for generating a new fidelity report. The documents will be processed to create atomic statements and grounding information.

toBuilder

public AutomatedReasoningPolicyGenerateFidelityReportContent.Builder 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 interface ToCopyableBuilder<AutomatedReasoningPolicyGenerateFidelityReportContent.Builder,AutomatedReasoningPolicyGenerateFidelityReportContent>

Returns:

a builder for type T

builder

public static AutomatedReasoningPolicyGenerateFidelityReportContent.Builder builder()

serializableBuilderClass

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

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 an SdkPojo class, and is generated based on a service model.

If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

Specified by:

equalsBySdkFields in interface SdkPojo

Parameters:

obj - the object to be compared with

Returns:

true if the other object equals to this object by sdk fields, false otherwise.

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)

fromDocuments

public static AutomatedReasoningPolicyGenerateFidelityReportContent fromDocuments(List<AutomatedReasoningPolicyBuildWorkflowDocument> documents)

Create an instance of this class with documents() initialized to the given value.

Source documents to analyze for generating a new fidelity report. The documents will be processed to create atomic statements and grounding information.

Parameters:

documents - Source documents to analyze for generating a new fidelity report. The documents will be processed to create atomic statements and grounding information.

type

public AutomatedReasoningPolicyGenerateFidelityReportContent.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 AutomatedReasoningPolicyGenerateFidelityReportContent.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 AutomatedReasoningPolicyGenerateFidelityReportContent.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

Returns:

List of SdkField in this POJO. May be empty list but should never be null.

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo

Returns:

The mapping between the field name and its corresponding field.