Class GetAdapterVersionResponse

    • Method Detail

      • adapterId

        public final String adapterId()

        A string containing a unique ID for the adapter version being retrieved.

        Returns:
        A string containing a unique ID for the adapter version being retrieved.
      • adapterVersion

        public final String adapterVersion()

        A string containing the adapter version that has been retrieved.

        Returns:
        A string containing the adapter version that has been retrieved.
      • creationTime

        public final Instant creationTime()

        The time that the adapter version was created.

        Returns:
        The time that the adapter version was created.
      • featureTypes

        public final List<FeatureType> featureTypes()

        List of the targeted feature types for the requested adapter version.

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

        Returns:
        List of the targeted feature types for the requested adapter version.
      • hasFeatureTypes

        public final boolean hasFeatureTypes()
        For responses, this returns true if the service returned a value for the FeatureTypes 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.
      • featureTypesAsStrings

        public final List<String> featureTypesAsStrings()

        List of the targeted feature types for the requested adapter version.

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

        Returns:
        List of the targeted feature types for the requested adapter version.
      • statusMessage

        public final String statusMessage()

        A message that describes the status of the requested adapter version.

        Returns:
        A message that describes the status of the requested adapter version.
      • datasetConfig

        public final AdapterVersionDatasetConfig datasetConfig()

        Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.

        Returns:
        Specifies a dataset used to train a new adapter version. Takes a ManifestS3Objec as the value.
      • kmsKeyId

        public final String kmsKeyId()

        The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.

        Returns:
        The identifier for your AWS Key Management Service key (AWS KMS key). Used to encrypt your documents.
      • outputConfig

        public final OutputConfig outputConfig()
        Returns the value of the OutputConfig property for this object.
        Returns:
        The value of the OutputConfig property for this object.
      • hasEvaluationMetrics

        public final boolean hasEvaluationMetrics()
        For responses, this returns true if the service returned a value for the EvaluationMetrics 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.
      • evaluationMetrics

        public final List<AdapterVersionEvaluationMetric> evaluationMetrics()

        The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.

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

        Returns:
        The evaluation metrics (F1 score, Precision, and Recall) for the requested version, grouped by baseline metrics and adapter version.
      • hasTags

        public final boolean hasTags()
        For responses, this returns true if the service returned a value for the Tags 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.
      • tags

        public final Map<String,​String> tags()

        A set of tags (key-value pairs) that are associated with the adapter version.

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

        Returns:
        A set of tags (key-value pairs) that are associated with the adapter version.
      • 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