Class GetDatasetResponse

java.lang.Object
software.amazon.awssdk.core.SdkResponse
software.amazon.awssdk.awscore.AwsResponse
software.amazon.awssdk.services.bedrockagentcorecontrol.model.BedrockAgentCoreControlResponse
software.amazon.awssdk.services.bedrockagentcorecontrol.model.GetDatasetResponse
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetDatasetResponse.Builder,GetDatasetResponse>
@Generated("software.amazon.awssdk:codegen") public final class GetDatasetResponse extends BedrockAgentCoreControlResponse implements ToCopyableBuilder<GetDatasetResponse.Builder,GetDatasetResponse>

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

    • datasetVersion

      public final String datasetVersion()

      The resolved version: "DRAFT" (default) or the requested version number.

      Returns:
      The resolved version: "DRAFT" (default) or the requested version number.

    • 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. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.

      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. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.
      See Also:

    • draftStatusAsString

      public final String draftStatusAsString()

      Publish synchronization state. Only authoritative when status is ACTIVE. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.

      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. MODIFIED indicates DRAFT has unpublished changes. UNMODIFIED indicates DRAFT matches the latest published version.
      See Also:

    • failureReason

      public final String failureReason()

      Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.

      Returns:
      Populated when status is CREATE_FAILED, UPDATE_FAILED, or DELETE_FAILED. Describes the reason for the failure.

    • schemaType

      public final DatasetSchemaType schemaType()

      The schema type declared at create time. Immutable after creation.

      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 declared at create time. Immutable after creation.
      See Also:

    • schemaTypeAsString

      public final String schemaTypeAsString()

      The schema type declared at create time. Immutable after creation.

      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 declared at create time. Immutable after creation.
      See Also:

    • kmsKeyArn

      public final String kmsKeyArn()

      KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.

      Returns:
      KMS key ARN used for server-side encryption on service Amazon S3 writes, if configured.

    • exampleCount

      public final Long exampleCount()

      The number of examples in the DRAFT.

      Returns:
      The number of examples in the DRAFT.

    • downloadUrl

      public final String downloadUrl()

      Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.

      Returns:
      Presigned Amazon S3 URL to download the consolidated dataset file for the resolved version. Expires after 5 minutes. Omitted if the file does not yet exist.

    • downloadUrlExpiresAt

      public final Instant downloadUrlExpiresAt()

      Expiry timestamp for the download URL.

      Returns:
      Expiry timestamp for the download URL.

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

    • 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()

      The tags associated with the dataset.

      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:
      The tags associated with the dataset.

    • toBuilder

      public GetDatasetResponse.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<GetDatasetResponse.Builder,GetDatasetResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static GetDatasetResponse.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetDatasetResponse.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsResponse

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsResponse

    • 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)
      Description copied from class: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

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