Interface S3JobManifestGenerator.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<S3JobManifestGenerator.Builder,
,S3JobManifestGenerator> SdkBuilder<S3JobManifestGenerator.Builder,
,S3JobManifestGenerator> SdkPojo
- Enclosing class:
S3JobManifestGenerator
-
Method Summary
Modifier and TypeMethodDescriptionenableManifestOutput
(Boolean enableManifestOutput) Determines whether or not to write the job's generated manifest to a bucket.expectedBucketOwner
(String expectedBucketOwner) The Amazon Web Services account ID that owns the bucket the generated manifest is written to.default S3JobManifestGenerator.Builder
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.filter
(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.default S3JobManifestGenerator.Builder
manifestOutputLocation
(Consumer<S3ManifestOutputLocation.Builder> manifestOutputLocation) Specifies the location the generated manifest will be written to.manifestOutputLocation
(S3ManifestOutputLocation manifestOutputLocation) Specifies the location the generated manifest will be written to.sourceBucket
(String sourceBucket) The source bucket used by the ManifestGenerator.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
sourceBucket
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.- Parameters:
sourceBucket
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
manifestOutputLocation
S3JobManifestGenerator.Builder manifestOutputLocation(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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
manifestOutputLocation
default S3JobManifestGenerator.Builder manifestOutputLocation(Consumer<S3ManifestOutputLocation.Builder> 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.
This is a convenience method that creates an instance of theS3ManifestOutputLocation.Builder
avoiding the need to create one manually viaS3ManifestOutputLocation.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tomanifestOutputLocation(S3ManifestOutputLocation)
.- Parameters:
manifestOutputLocation
- a consumer that will call methods onS3ManifestOutputLocation.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
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.
This is a convenience method that creates an instance of theJobManifestGeneratorFilter.Builder
avoiding the need to create one manually viaJobManifestGeneratorFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilter(JobManifestGeneratorFilter)
.- Parameters:
filter
- a consumer that will call methods onJobManifestGeneratorFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
enableManifestOutput
Determines whether or not to write the job's generated manifest to a bucket.
- Parameters:
enableManifestOutput
- Determines whether or not to write the job's generated manifest to a bucket.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-