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

Class DocumentIdentifier

java.lang.Object

software.amazon.awssdk.services.bedrockagent.model.DocumentIdentifier

All Implemented Interfaces:

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

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

Contains information that identifies the document.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	DocumentIdentifier.Builder

Method Summary

Modifier and Type	Method	Description
static DocumentIdentifier.Builder	builder()
final CustomDocumentIdentifier	custom()	Contains information that identifies the document in a custom data source.
final ContentDataSourceType	dataSourceType()	The type of data source connected to the knowledge base that contains the document.
final String	dataSourceTypeAsString()	The type of data source connected to the knowledge base that contains the document.
final boolean	equals(Object obj)
final boolean	equalsBySdkFields(Object obj)
final <T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
final int	hashCode()
final S3Location	s3()	Contains information that identifies the document in an S3 data source.
final Map<String,SdkField<?>>	sdkFieldNameToField()
final List<SdkField<?>>	sdkFields()
static Class<? extends DocumentIdentifier.Builder>	serializableBuilderClass()
DocumentIdentifier.Builder	toBuilder()
final String	toString()	Returns a string representation of this object.

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 Details

dataSourceType

public final ContentDataSourceType dataSourceType()

The type of data source connected to the knowledge base that contains the document.

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

Returns:

The type of data source connected to the knowledge base that contains the document.

See Also:

• ContentDataSourceType

dataSourceTypeAsString

public final String dataSourceTypeAsString()

The type of data source connected to the knowledge base that contains the document.

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

Returns:

The type of data source connected to the knowledge base that contains the document.

See Also:

• ContentDataSourceType

s3

public final S3Location s3()

Contains information that identifies the document in an S3 data source.

Returns:

Contains information that identifies the document in an S3 data source.

custom

public final CustomDocumentIdentifier custom()

Contains information that identifies the document in a custom data source.

Returns:

Contains information that identifies the document in a custom data source.

toBuilder

public DocumentIdentifier.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<DocumentIdentifier.Builder,DocumentIdentifier>

builder

public static DocumentIdentifier.Builder builder()

serializableBuilderClass

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