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

Class DocumentMetadata

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.DocumentMetadata

All Implemented Interfaces:

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

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

Contains information about the metadata associate with the content to ingest into a knowledge base. Choose a type and include the field that corresponds to it.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentMetadata.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentMetadata.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
boolean	hasInlineAttributes()	For responses, this returns true if the service returned a value for the InlineAttributes property.
List<MetadataAttribute>	inlineAttributes()	An array of objects, each of which defines a metadata attribute to associate with the content to ingest.
CustomS3Location	s3Location()	The Amazon S3 location of the file containing metadata to associate with the content to ingest.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends DocumentMetadata.Builder>	serializableBuilderClass()
DocumentMetadata.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
MetadataSourceType	type()	The type of the source source from which to add metadata.
String	typeAsString()	The type of the source source from which to add metadata.

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

type

public final MetadataSourceType type()

The type of the source source from which to add metadata.

If the service returns an enum value that is not available in the current SDK version, type will return MetadataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the source source from which to add metadata.

See Also:

MetadataSourceType

typeAsString

public final String typeAsString()

The type of the source source from which to add metadata.

If the service returns an enum value that is not available in the current SDK version, type will return MetadataSourceType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().

Returns:

The type of the source source from which to add metadata.

See Also:

MetadataSourceType

hasInlineAttributes

public final boolean hasInlineAttributes()

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

inlineAttributes

public final List<MetadataAttribute> inlineAttributes()

An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.

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

Returns:

An array of objects, each of which defines a metadata attribute to associate with the content to ingest. You define the attributes inline.

s3Location

public final CustomS3Location s3Location()

The Amazon S3 location of the file containing metadata to associate with the content to ingest.

Returns:

The Amazon S3 location of the file containing metadata to associate with the content to ingest.

toBuilder

public DocumentMetadata.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentMetadata.Builder,DocumentMetadata>

builder

public static DocumentMetadata.Builder builder()

serializableBuilderClass

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