software.amazon.awscdk.services.glue

Interface JobExecutableConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

JobExecutableConfig.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-11T19:24:31.537Z")
 @Stability(value=Experimental)
public interface JobExecutableConfig
extends software.amazon.jsii.JsiiSerializable

(experimental) Result of binding a `JobExecutable` into a `Job`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Code code;
 GlueVersion glueVersion;
 JobType jobType;
 JobExecutableConfig jobExecutableConfig = JobExecutableConfig.builder()
         .glueVersion(glueVersion)
         .language(JobLanguage.SCALA)
         .script(code)
         .type(jobType)
         // the properties below are optional
         .className("className")
         .extraFiles(List.of(code))
         .extraJars(List.of(code))
         .extraJarsFirst(false)
         .extraPythonFiles(List.of(code))
         .pythonVersion(PythonVersion.TWO)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	JobExecutableConfig.Builder A builder for JobExecutableConfig
static class	JobExecutableConfig.Jsii$Proxy An implementation for JobExecutableConfig

Method Summary

Modifier and Type	Method and Description
static JobExecutableConfig.Builder	builder()
default String	getClassName() (experimental) The Scala class that serves as the entry point for the job.
default List<Code>	getExtraFiles() (experimental) Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it.
default List<Code>	getExtraJars() (experimental) Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script.
default Boolean	getExtraJarsFirst() (experimental) Setting this value to true prioritizes the customer's extra JAR files in the classpath.
default List<Code>	getExtraPythonFiles() (experimental) Additional Python files that AWS Glue adds to the Python path before executing your script.
GlueVersion	getGlueVersion() (experimental) Glue version.
JobLanguage	getLanguage() (experimental) The language of the job (Scala or Python).
default PythonVersion	getPythonVersion() (experimental) The Python version to use.
Code	getScript() (experimental) The script that is executed by a job.
JobType	getType() (experimental) Specify the type of the job whether it's an Apache Spark ETL or streaming one or if it's a Python shell job.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getGlueVersion

@Stability(value=Experimental)
 @NotNull
GlueVersion getGlueVersion()

(experimental) Glue version.

See Also:

https://docs.aws.amazon.com/glue/latest/dg/release-notes.html

getLanguage

@Stability(value=Experimental)
 @NotNull
JobLanguage getLanguage()

(experimental) The language of the job (Scala or Python).

See Also:

in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

getScript

@Stability(value=Experimental)
 @NotNull
Code getScript()

(experimental) The script that is executed by a job.

getType

@Stability(value=Experimental)
 @NotNull
JobType getType()

(experimental) Specify the type of the job whether it's an Apache Spark ETL or streaming one or if it's a Python shell job.

getClassName

@Stability(value=Experimental)
 @Nullable
default String getClassName()

(experimental) The Scala class that serves as the entry point for the job.

This applies only if your the job langauage is Scala.

Default: - no scala className specified

See Also:

in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

getExtraFiles

@Stability(value=Experimental)
 @Nullable
default List<Code> getExtraFiles()

(experimental) Additional files, such as configuration files that AWS Glue copies to the working directory of your script before executing it.

Default: - no extra files specified.

See Also:

in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

getExtraJars

@Stability(value=Experimental)
 @Nullable
default List<Code> getExtraJars()

(experimental) Additional Java .jar files that AWS Glue adds to the Java classpath before executing your script.

Default: - no extra jars specified.

See Also:

in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

getExtraJarsFirst

@Stability(value=Experimental)
 @Nullable
default Boolean getExtraJarsFirst()

(experimental) Setting this value to true prioritizes the customer's extra JAR files in the classpath.

Default: - extra jars are not prioritized.

See Also:

in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

getExtraPythonFiles

@Stability(value=Experimental)
 @Nullable
default List<Code> getExtraPythonFiles()

(experimental) Additional Python files that AWS Glue adds to the Python path before executing your script.

Default: - no extra python files specified.

See Also:

in https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html

getPythonVersion

@Stability(value=Experimental)
 @Nullable
default PythonVersion getPythonVersion()

(experimental) The Python version to use.

Default: - no python version specified

builder

@Stability(value=Experimental)
static JobExecutableConfig.Builder builder()

Returns:

a JobExecutableConfig.Builder of JobExecutableConfig