Package software.amazon.awssdk.services.databrew.model

Class JobSample

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

A sample configuration for profile jobs only, which determines the number of rows on which the profile job is run. If a JobSample value isn't provided, the default is used. The default value is CUSTOM_ROWS for the mode parameter and 20,000 for the size parameter.

See Also:

  • Method Details

    • mode

      public final SampleMode mode()

      A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

      • FULL_DATASET - The profile job is run on the entire dataset.

      • CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

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

      Returns:
      A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

      • FULL_DATASET - The profile job is run on the entire dataset.

      • CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

      See Also:

    • modeAsString

      public final String modeAsString()

      A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

      • FULL_DATASET - The profile job is run on the entire dataset.

      • CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

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

      Returns:
      A value that determines whether the profile job is run on the entire dataset or a specified number of rows. This value must be one of the following:

      • FULL_DATASET - The profile job is run on the entire dataset.

      • CUSTOM_ROWS - The profile job is run on the number of rows specified in the Size parameter.

      See Also:

    • size

      public final Long size()

      The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

      Long.MAX_VALUE = 9223372036854775807

      Returns:
      The Size parameter is only required when the mode is CUSTOM_ROWS. The profile job is run on the specified number of rows. The maximum value for size is Long.MAX_VALUE.

      Long.MAX_VALUE = 9223372036854775807

    • toBuilder

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

    • builder

      public static JobSample.Builder builder()

    • serializableBuilderClass

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