Class DataSource
- java.lang.Object
-
- software.amazon.awssdk.services.bedrockagent.model.DataSource
-
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<DataSource.Builder,DataSource>
@Generated("software.amazon.awssdk:codegen") public final class DataSource extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DataSource.Builder,DataSource>
Contains details about a data source.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interfaceDataSource.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static DataSource.Builderbuilder()InstantcreatedAt()The time at which the data source was created.DataDeletionPolicydataDeletionPolicy()The data deletion policy for the data source.StringdataDeletionPolicyAsString()The data deletion policy for the data source.DataSourceConfigurationdataSourceConfiguration()The connection configuration for the data source.StringdataSourceId()The unique identifier of the data source.Stringdescription()The description of the data source.booleanequals(Object obj)booleanequalsBySdkFields(Object obj)List<String>failureReasons()The detailed reasons on the failure to delete a data source.<T> Optional<T>getValueForField(String fieldName, Class<T> clazz)booleanhasFailureReasons()For responses, this returns true if the service returned a value for the FailureReasons property.inthashCode()StringknowledgeBaseId()The unique identifier of the knowledge base to which the data source belongs.Stringname()The name of the data source.List<SdkField<?>>sdkFields()static Class<? extends DataSource.Builder>serializableBuilderClass()ServerSideEncryptionConfigurationserverSideEncryptionConfiguration()Contains details about the configuration of the server-side encryption.DataSourceStatusstatus()The status of the data source.StringstatusAsString()The status of the data source.DataSource.BuildertoBuilder()StringtoString()Returns a string representation of this object.InstantupdatedAt()The time at which the data source was last updated.VectorIngestionConfigurationvectorIngestionConfiguration()Contains details about how to ingest the documents in the data source.-
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
-
createdAt
public final Instant createdAt()
The time at which the data source was created.
- Returns:
- The time at which the data source was created.
-
dataDeletionPolicy
public final DataDeletionPolicy dataDeletionPolicy()
The data deletion policy for the data source.
If the service returns an enum value that is not available in the current SDK version,
dataDeletionPolicywill returnDataDeletionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataDeletionPolicyAsString().- Returns:
- The data deletion policy for the data source.
- See Also:
DataDeletionPolicy
-
dataDeletionPolicyAsString
public final String dataDeletionPolicyAsString()
The data deletion policy for the data source.
If the service returns an enum value that is not available in the current SDK version,
dataDeletionPolicywill returnDataDeletionPolicy.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromdataDeletionPolicyAsString().- Returns:
- The data deletion policy for the data source.
- See Also:
DataDeletionPolicy
-
dataSourceConfiguration
public final DataSourceConfiguration dataSourceConfiguration()
The connection configuration for the data source.
- Returns:
- The connection configuration for the data source.
-
dataSourceId
public final String dataSourceId()
The unique identifier of the data source.
- Returns:
- The unique identifier of the data source.
-
description
public final String description()
The description of the data source.
- Returns:
- The description of the data source.
-
hasFailureReasons
public final boolean hasFailureReasons()
For responses, this returns true if the service returned a value for the FailureReasons property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()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.
-
failureReasons
public final List<String> failureReasons()
The detailed reasons on the failure to delete a data source.
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
hasFailureReasons()method.- Returns:
- The detailed reasons on the failure to delete a data source.
-
knowledgeBaseId
public final String knowledgeBaseId()
The unique identifier of the knowledge base to which the data source belongs.
- Returns:
- The unique identifier of the knowledge base to which the data source belongs.
-
name
public final String name()
The name of the data source.
- Returns:
- The name of the data source.
-
serverSideEncryptionConfiguration
public final ServerSideEncryptionConfiguration serverSideEncryptionConfiguration()
Contains details about the configuration of the server-side encryption.
- Returns:
- Contains details about the configuration of the server-side encryption.
-
status
public final DataSourceStatus status()
The status of the data source. The following statuses are possible:
-
Available – The data source has been created and is ready for ingestion into the knowledge base.
-
Deleting – The data source is being deleted.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnDataSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the data source. The following statuses are possible:
-
Available – The data source has been created and is ready for ingestion into the knowledge base.
-
Deleting – The data source is being deleted.
-
- See Also:
DataSourceStatus
-
-
statusAsString
public final String statusAsString()
The status of the data source. The following statuses are possible:
-
Available – The data source has been created and is ready for ingestion into the knowledge base.
-
Deleting – The data source is being deleted.
If the service returns an enum value that is not available in the current SDK version,
statuswill returnDataSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available fromstatusAsString().- Returns:
- The status of the data source. The following statuses are possible:
-
Available – The data source has been created and is ready for ingestion into the knowledge base.
-
Deleting – The data source is being deleted.
-
- See Also:
DataSourceStatus
-
-
updatedAt
public final Instant updatedAt()
The time at which the data source was last updated.
- Returns:
- The time at which the data source was last updated.
-
vectorIngestionConfiguration
public final VectorIngestionConfiguration vectorIngestionConfiguration()
Contains details about how to ingest the documents in the data source.
- Returns:
- Contains details about how to ingest the documents in the data source.
-
toBuilder
public DataSource.Builder toBuilder()
- Specified by:
toBuilderin interfaceToCopyableBuilder<DataSource.Builder,DataSource>
-
builder
public static DataSource.Builder builder()
-
serializableBuilderClass
public static Class<? extends DataSource.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFieldsin interfaceSdkPojo
-
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.
-
-