Class S3JobManifestGenerator

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

The container for the service that will create the S3 manifest.

See Also:

  • Method Details

    • expectedBucketOwner

      public final String expectedBucketOwner()

      The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.

      Returns:
      The Amazon Web Services account ID that owns the bucket the generated manifest is written to. If provided the generated manifest bucket's owner Amazon Web Services account ID must match this value, else the job fails.

    • sourceBucket

      public final String sourceBucket()

      The ARN of the source bucket used by the ManifestGenerator.

      Directory buckets - Directory buckets aren't supported as the source buckets used by S3JobManifestGenerator to generate the job manifest.

      Returns:
      The ARN of the source bucket used by the ManifestGenerator.

      Directory buckets - Directory buckets aren't supported as the source buckets used by S3JobManifestGenerator to generate the job manifest.

    • manifestOutputLocation

      public final S3ManifestOutputLocation manifestOutputLocation()

      Specifies the location the generated manifest will be written to. Manifests can't be written to directory buckets. For more information, see Directory buckets.

      Returns:
      Specifies the location the generated manifest will be written to. Manifests can't be written to directory buckets. For more information, see Directory buckets.

    • filter

      public final JobManifestGeneratorFilter filter()

      Specifies rules the S3JobManifestGenerator should use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

      Returns:
      Specifies rules the S3JobManifestGenerator should use to decide whether an object in the source bucket should or should not be included in the generated job manifest.

    • enableManifestOutput

      public final Boolean enableManifestOutput()

      Determines whether or not to write the job's generated manifest to a bucket.

      Returns:
      Determines whether or not to write the job's generated manifest to a bucket.

    • toBuilder

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

    • builder

      public static S3JobManifestGenerator.Builder builder()

    • serializableBuilderClass

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