Interface S3JsonSource.Builder
-
- All Superinterfaces:
Buildable
,CopyableBuilder<S3JsonSource.Builder,S3JsonSource>
,SdkBuilder<S3JsonSource.Builder,S3JsonSource>
,SdkPojo
- Enclosing class:
- S3JsonSource
public static interface S3JsonSource.Builder extends SdkPojo, CopyableBuilder<S3JsonSource.Builder,S3JsonSource>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description default S3JsonSource.Builder
additionalOptions(Consumer<S3DirectSourceAdditionalOptions.Builder> additionalOptions)
Specifies additional connection options.S3JsonSource.Builder
additionalOptions(S3DirectSourceAdditionalOptions additionalOptions)
Specifies additional connection options.S3JsonSource.Builder
compressionType(String compressionType)
Specifies how the data is compressed.S3JsonSource.Builder
compressionType(CompressionType compressionType)
Specifies how the data is compressed.S3JsonSource.Builder
exclusions(String... exclusions)
A string containing a JSON list of Unix-style glob patterns to exclude.S3JsonSource.Builder
exclusions(Collection<String> exclusions)
A string containing a JSON list of Unix-style glob patterns to exclude.S3JsonSource.Builder
groupFiles(String groupFiles)
Grouping files is turned on by default when the input contains more than 50,000 files.S3JsonSource.Builder
groupSize(String groupSize)
The target group size in bytes.S3JsonSource.Builder
jsonPath(String jsonPath)
A JsonPath string defining the JSON data.S3JsonSource.Builder
maxBand(Integer maxBand)
This option controls the duration in milliseconds after which the s3 listing is likely to be consistent.S3JsonSource.Builder
maxFilesInBand(Integer maxFilesInBand)
This option specifies the maximum number of files to save from the last maxBand seconds.S3JsonSource.Builder
multiline(Boolean multiline)
A Boolean value that specifies whether a single record can span multiple lines.S3JsonSource.Builder
name(String name)
The name of the data store.S3JsonSource.Builder
outputSchemas(Collection<GlueSchema> outputSchemas)
Specifies the data schema for the S3 JSON source.S3JsonSource.Builder
outputSchemas(Consumer<GlueSchema.Builder>... outputSchemas)
Specifies the data schema for the S3 JSON source.S3JsonSource.Builder
outputSchemas(GlueSchema... outputSchemas)
Specifies the data schema for the S3 JSON source.S3JsonSource.Builder
paths(String... paths)
A list of the Amazon S3 paths to read from.S3JsonSource.Builder
paths(Collection<String> paths)
A list of the Amazon S3 paths to read from.S3JsonSource.Builder
recurse(Boolean recurse)
If set to true, recursively reads files in all subdirectories under the specified paths.-
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 Detail
-
name
S3JsonSource.Builder name(String name)
The name of the data store.
- Parameters:
name
- The name of the data store.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
paths
S3JsonSource.Builder paths(Collection<String> paths)
A list of the Amazon S3 paths to read from.
- Parameters:
paths
- A list of the Amazon S3 paths to read from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
paths
S3JsonSource.Builder paths(String... paths)
A list of the Amazon S3 paths to read from.
- Parameters:
paths
- A list of the Amazon S3 paths to read from.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
compressionType
S3JsonSource.Builder compressionType(String compressionType)
Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
"gzip"
and"bzip"
).- Parameters:
compressionType
- Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are"gzip"
and"bzip"
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CompressionType
,CompressionType
-
compressionType
S3JsonSource.Builder compressionType(CompressionType compressionType)
Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are
"gzip"
and"bzip"
).- Parameters:
compressionType
- Specifies how the data is compressed. This is generally not necessary if the data has a standard file extension. Possible values are"gzip"
and"bzip"
).- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
CompressionType
,CompressionType
-
exclusions
S3JsonSource.Builder exclusions(Collection<String> exclusions)
A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
- Parameters:
exclusions
- A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
exclusions
S3JsonSource.Builder exclusions(String... exclusions)
A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.
- Parameters:
exclusions
- A string containing a JSON list of Unix-style glob patterns to exclude. For example, "[\"**.pdf\"]" excludes all PDF files.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupSize
S3JsonSource.Builder groupSize(String groupSize)
The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,
"groupFiles"
must be set to"inPartition"
for this to take effect.- Parameters:
groupSize
- The target group size in bytes. The default is computed based on the input data size and the size of your cluster. When there are fewer than 50,000 input files,"groupFiles"
must be set to"inPartition"
for this to take effect.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
groupFiles
S3JsonSource.Builder groupFiles(String groupFiles)
Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to
"none"
.- Parameters:
groupFiles
- Grouping files is turned on by default when the input contains more than 50,000 files. To turn on grouping with fewer than 50,000 files, set this parameter to "inPartition". To disable grouping when there are more than 50,000 files, set this parameter to"none"
.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
recurse
S3JsonSource.Builder recurse(Boolean recurse)
If set to true, recursively reads files in all subdirectories under the specified paths.
- Parameters:
recurse
- If set to true, recursively reads files in all subdirectories under the specified paths.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxBand
S3JsonSource.Builder maxBand(Integer maxBand)
This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.
- Parameters:
maxBand
- This option controls the duration in milliseconds after which the s3 listing is likely to be consistent. Files with modification timestamps falling within the last maxBand milliseconds are tracked specially when using JobBookmarks to account for Amazon S3 eventual consistency. Most users don't need to set this option. The default is 900000 milliseconds, or 15 minutes.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
maxFilesInBand
S3JsonSource.Builder maxFilesInBand(Integer maxFilesInBand)
This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.
- Parameters:
maxFilesInBand
- This option specifies the maximum number of files to save from the last maxBand seconds. If this number is exceeded, extra files are skipped and only processed in the next job run.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalOptions
S3JsonSource.Builder additionalOptions(S3DirectSourceAdditionalOptions additionalOptions)
Specifies additional connection options.
- Parameters:
additionalOptions
- Specifies additional connection options.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
additionalOptions
default S3JsonSource.Builder additionalOptions(Consumer<S3DirectSourceAdditionalOptions.Builder> additionalOptions)
Specifies additional connection options.
This is a convenience method that creates an instance of theS3DirectSourceAdditionalOptions.Builder
avoiding the need to create one manually viaS3DirectSourceAdditionalOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toadditionalOptions(S3DirectSourceAdditionalOptions)
.- Parameters:
additionalOptions
- a consumer that will call methods onS3DirectSourceAdditionalOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
additionalOptions(S3DirectSourceAdditionalOptions)
-
jsonPath
S3JsonSource.Builder jsonPath(String jsonPath)
A JsonPath string defining the JSON data.
- Parameters:
jsonPath
- A JsonPath string defining the JSON data.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
multiline
S3JsonSource.Builder multiline(Boolean multiline)
A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value is
False
, which allows for more aggressive file-splitting during parsing.- Parameters:
multiline
- A Boolean value that specifies whether a single record can span multiple lines. This can occur when a field contains a quoted new-line character. You must set this option to True if any record spans multiple lines. The default value isFalse
, which allows for more aggressive file-splitting during parsing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputSchemas
S3JsonSource.Builder outputSchemas(Collection<GlueSchema> outputSchemas)
Specifies the data schema for the S3 JSON source.
- Parameters:
outputSchemas
- Specifies the data schema for the S3 JSON source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputSchemas
S3JsonSource.Builder outputSchemas(GlueSchema... outputSchemas)
Specifies the data schema for the S3 JSON source.
- Parameters:
outputSchemas
- Specifies the data schema for the S3 JSON source.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
outputSchemas
S3JsonSource.Builder outputSchemas(Consumer<GlueSchema.Builder>... outputSchemas)
Specifies the data schema for the S3 JSON source.
This is a convenience method that creates an instance of theGlueSchema.Builder
avoiding the need to create one manually viaGlueSchema.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed to#outputSchemas(List
.) - Parameters:
outputSchemas
- a consumer that will call methods onGlueSchema.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
#outputSchemas(java.util.Collection
)
-
-