Class DatasetSummary

java.lang.Object
software.amazon.awssdk.services.bedrockagentcorecontrol.model.DatasetSummary
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<DatasetSummary.Builder,DatasetSummary>
@Generated("software.amazon.awssdk:codegen") public final class DatasetSummary extends Object implements SdkPojo, Serializable, ToCopyableBuilder<DatasetSummary.Builder,DatasetSummary>

Summary information about a dataset.

See Also:

  • Method Details

    • datasetArn

      public final String datasetArn()

      The Amazon Resource Name (ARN) of the dataset.

      Returns:
      The Amazon Resource Name (ARN) of the dataset.

    • datasetId

      public final String datasetId()

      The unique identifier of the dataset.

      Returns:
      The unique identifier of the dataset.

    • datasetName

      public final String datasetName()

      The name of the dataset.

      Returns:
      The name of the dataset.

    • description

      public final String description()

      The description of the dataset.

      Returns:
      The description of the dataset.

    • status

      public final DatasetStatus status()

      The current status of the dataset.

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

      Returns:
      The current status of the dataset.
      See Also:

    • statusAsString

      public final String statusAsString()

      The current status of the dataset.

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

      Returns:
      The current status of the dataset.
      See Also:

    • draftStatus

      public final DraftStatus draftStatus()

      Publish synchronization state. Only authoritative when status is ACTIVE.

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

      Returns:
      Publish synchronization state. Only authoritative when status is ACTIVE.
      See Also:

    • draftStatusAsString

      public final String draftStatusAsString()

      Publish synchronization state. Only authoritative when status is ACTIVE.

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

      Returns:
      Publish synchronization state. Only authoritative when status is ACTIVE.
      See Also:

    • schemaType

      public final DatasetSchemaType schemaType()

      The schema type of the dataset.

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

      Returns:
      The schema type of the dataset.
      See Also:

    • schemaTypeAsString

      public final String schemaTypeAsString()

      The schema type of the dataset.

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

      Returns:
      The schema type of the dataset.
      See Also:

    • exampleCount

      public final Long exampleCount()

      The number of examples in the dataset.

      Returns:
      The number of examples in the dataset.

    • createdAt

      public final Instant createdAt()

      The timestamp when the dataset was created.

      Returns:
      The timestamp when the dataset was created.

    • updatedAt

      public final Instant updatedAt()

      The timestamp when the dataset was last updated.

      Returns:
      The timestamp when the dataset was last updated.

    • toBuilder

      public DatasetSummary.Builder 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<DatasetSummary.Builder,DatasetSummary>
      Returns:
      a builder for type T

    • builder

      public static DatasetSummary.Builder builder()

    • serializableBuilderClass

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