Class Dataset

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

Represents a dataset that can be processed by DataBrew.

See Also:

  • Method Details

    • accountId

      public final String accountId()

      The ID of the Amazon Web Services account that owns the dataset.

      Returns:
      The ID of the Amazon Web Services account that owns the dataset.

    • createdBy

      public final String createdBy()

      The Amazon Resource Name (ARN) of the user who created the dataset.

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

    • createDate

      public final Instant createDate()

      The date and time that the dataset was created.

      Returns:
      The date and time that the dataset was created.

    • name

      public final String name()

      The unique name of the dataset.

      Returns:
      The unique name of the dataset.

    • format

      public final InputFormat format()

      The file format of a dataset that is created from an Amazon S3 file or folder.

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

      Returns:
      The file format of a dataset that is created from an Amazon S3 file or folder.
      See Also:

    • formatAsString

      public final String formatAsString()

      The file format of a dataset that is created from an Amazon S3 file or folder.

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

      Returns:
      The file format of a dataset that is created from an Amazon S3 file or folder.
      See Also:

    • formatOptions

      public final FormatOptions formatOptions()

      A set of options that define how DataBrew interprets the data in the dataset.

      Returns:
      A set of options that define how DataBrew interprets the data in the dataset.

    • input

      public final Input input()

      Information on how DataBrew can find the dataset, in either the Glue Data Catalog or Amazon S3.

      Returns:
      Information on how DataBrew can find the dataset, in either the Glue Data Catalog or Amazon S3.

    • lastModifiedDate

      public final Instant lastModifiedDate()

      The last modification date and time of the dataset.

      Returns:
      The last modification date and time of the dataset.

    • lastModifiedBy

      public final String lastModifiedBy()

      The Amazon Resource Name (ARN) of the user who last modified the dataset.

      Returns:
      The Amazon Resource Name (ARN) of the user who last modified the dataset.

    • source

      public final Source source()

      The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.

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

      Returns:
      The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.
      See Also:

    • sourceAsString

      public final String sourceAsString()

      The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.

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

      Returns:
      The location of the data for the dataset, either Amazon S3 or the Glue Data Catalog.
      See Also:

    • pathOptions

      public final PathOptions pathOptions()

      A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

      Returns:
      A set of options that defines how DataBrew interprets an Amazon S3 path of the dataset.

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

      Metadata tags that have been applied to 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:
      Metadata tags that have been applied to the dataset.

    • resourceArn

      public final String resourceArn()

      The unique Amazon Resource Name (ARN) for the dataset.

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

    • toBuilder

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

    • builder

      public static Dataset.Builder builder()

    • serializableBuilderClass

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