Class DataSource

    • 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.
      • dataSourceConfiguration

        public final DataSourceConfiguration dataSourceConfiguration()

        Contains details about how the data source is stored.

        Returns:
        Contains details about how the data source is stored.
      • 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 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.
      • 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, status will return DataSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        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, status will return DataSourceStatus.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().

        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.
      • hashCode

        public final int hashCode()
        Overrides:
        hashCode in class Object
      • equals

        public final boolean equals​(Object obj)
        Overrides:
        equals in class Object
      • 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)