Class DatasetGenerationSummary

java.lang.Object
software.amazon.awssdk.services.bedrockagentcore.model.DatasetGenerationSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DatasetGenerationSummary.Builder,DatasetGenerationSummary>

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

A summary of a dataset generation. To get its counts and the request it was started with, call GetDatasetGeneration.

See Also:
  • Method Details

    • generationId

      public final String generationId()

      The unique identifier of the dataset generation.

      Returns:
      The unique identifier of the dataset generation.
    • datasetId

      public final String datasetId()

      The unique identifier of the dataset.

      Returns:
      The unique identifier of the dataset.
    • name

      public final String name()

      The name of the dataset generation.

      Returns:
      The name of the dataset generation.
    • description

      public final String description()

      The description of the dataset generation.

      Returns:
      The description of the dataset generation.
    • scenarioType

      public final ScenarioType scenarioType()

      The type of scenario the generation produces.

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

      Returns:
      The type of scenario the generation produces.
      See Also:
    • scenarioTypeAsString

      public final String scenarioTypeAsString()

      The type of scenario the generation produces.

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

      Returns:
      The type of scenario the generation produces.
      See Also:
    • status

      public final DatasetGenerationStatus status()

      The status of the dataset generation.

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

      Returns:
      The status of the dataset generation.
      See Also:
    • statusAsString

      public final String statusAsString()

      The status of the dataset generation.

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

      Returns:
      The status of the dataset generation.
      See Also:
    • createdAt

      public final Instant createdAt()

      The time at which the dataset generation started.

      Returns:
      The time at which the dataset generation started.
    • completedAt

      public final Instant completedAt()

      The time at which the dataset generation finished. Present only when the generation has finished.

      Returns:
      The time at which the dataset generation finished. Present only when the generation has finished.
    • toBuilder

      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<DatasetGenerationSummary.Builder,DatasetGenerationSummary>
      Returns:
      a builder for type T
    • builder

      public static DatasetGenerationSummary.Builder builder()
    • serializableBuilderClass

      public static Class<? extends DatasetGenerationSummary.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)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.
    • 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
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.
    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.