Class Output

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

Represents options that specify how and where in Amazon S3 DataBrew writes the output generated by recipe jobs or profile jobs.

See Also:

  • Method Details

    • compressionFormat

      public final CompressionFormat compressionFormat()

      The compression algorithm used to compress the output text of the job.

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

      Returns:
      The compression algorithm used to compress the output text of the job.
      See Also:

    • compressionFormatAsString

      public final String compressionFormatAsString()

      The compression algorithm used to compress the output text of the job.

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

      Returns:
      The compression algorithm used to compress the output text of the job.
      See Also:

    • format

      public final OutputFormat format()

      The data format of the output of the job.

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

      Returns:
      The data format of the output of the job.
      See Also:

    • formatAsString

      public final String formatAsString()

      The data format of the output of the job.

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

      Returns:
      The data format of the output of the job.
      See Also:

    • hasPartitionColumns

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

    • partitionColumns

      public final List<String> partitionColumns()

      The names of one or more partition columns for the output of the job.

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

      Returns:
      The names of one or more partition columns for the output of the job.

    • location

      public final S3Location location()

      The location in Amazon S3 where the job writes its output.

      Returns:
      The location in Amazon S3 where the job writes its output.

    • overwrite

      public final Boolean overwrite()

      A value that, if true, means that any data in the location specified for output is overwritten with new output.

      Returns:
      A value that, if true, means that any data in the location specified for output is overwritten with new output.

    • formatOptions

      public final OutputFormatOptions formatOptions()

      Represents options that define how DataBrew formats job output files.

      Returns:
      Represents options that define how DataBrew formats job output files.

    • maxOutputFiles

      public final Integer maxOutputFiles()

      Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.

      Returns:
      Maximum number of files to be generated by the job and written to the output folder. For output partitioned by column(s), the MaxOutputFiles value is the maximum number of files per partition.

    • toBuilder

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

    • builder

      public static Output.Builder builder()

    • serializableBuilderClass

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