#[non_exhaustive]pub struct JobBuilder { /* private fields */ }
Expand description
A builder for Job
.
Implementations§
Source§impl JobBuilder
impl JobBuilder
Sourcepub fn name(self, input: impl Into<String>) -> Self
pub fn name(self, input: impl Into<String>) -> Self
The name you assign to this job definition.
Sourcepub fn set_name(self, input: Option<String>) -> Self
pub fn set_name(self, input: Option<String>) -> Self
The name you assign to this job definition.
Sourcepub fn job_mode(self, input: JobMode) -> Self
pub fn job_mode(self, input: JobMode) -> Self
A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
Sourcepub fn set_job_mode(self, input: Option<JobMode>) -> Self
pub fn set_job_mode(self, input: Option<JobMode>) -> Self
A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
Sourcepub fn get_job_mode(&self) -> &Option<JobMode>
pub fn get_job_mode(&self) -> &Option<JobMode>
A mode that describes how a job was created. Valid values are:
-
SCRIPT
- The job was created using the Glue Studio script editor. -
VISUAL
- The job was created using the Glue Studio visual editor. -
NOTEBOOK
- The job was created using an interactive sessions notebook.
When the JobMode
field is missing or null, SCRIPT
is assigned as the default value.
Sourcepub fn job_run_queuing_enabled(self, input: bool) -> Self
pub fn job_run_queuing_enabled(self, input: bool) -> Self
Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Sourcepub fn set_job_run_queuing_enabled(self, input: Option<bool>) -> Self
pub fn set_job_run_queuing_enabled(self, input: Option<bool>) -> Self
Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Sourcepub fn get_job_run_queuing_enabled(&self) -> &Option<bool>
pub fn get_job_run_queuing_enabled(&self) -> &Option<bool>
Specifies whether job run queuing is enabled for the job runs for this job.
A value of true means job run queuing is enabled for the job runs. If false or not populated, the job runs will not be considered for queueing.
If this field does not match the value set in the job run, then the value from the job run field will be used.
Sourcepub fn description(self, input: impl Into<String>) -> Self
pub fn description(self, input: impl Into<String>) -> Self
A description of the job.
Sourcepub fn set_description(self, input: Option<String>) -> Self
pub fn set_description(self, input: Option<String>) -> Self
A description of the job.
Sourcepub fn get_description(&self) -> &Option<String>
pub fn get_description(&self) -> &Option<String>
A description of the job.
Sourcepub fn set_log_uri(self, input: Option<String>) -> Self
pub fn set_log_uri(self, input: Option<String>) -> Self
This field is reserved for future use.
Sourcepub fn get_log_uri(&self) -> &Option<String>
pub fn get_log_uri(&self) -> &Option<String>
This field is reserved for future use.
Sourcepub fn role(self, input: impl Into<String>) -> Self
pub fn role(self, input: impl Into<String>) -> Self
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
Sourcepub fn set_role(self, input: Option<String>) -> Self
pub fn set_role(self, input: Option<String>) -> Self
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
Sourcepub fn get_role(&self) -> &Option<String>
pub fn get_role(&self) -> &Option<String>
The name or Amazon Resource Name (ARN) of the IAM role associated with this job.
Sourcepub fn created_on(self, input: DateTime) -> Self
pub fn created_on(self, input: DateTime) -> Self
The time and date that this job definition was created.
Sourcepub fn set_created_on(self, input: Option<DateTime>) -> Self
pub fn set_created_on(self, input: Option<DateTime>) -> Self
The time and date that this job definition was created.
Sourcepub fn get_created_on(&self) -> &Option<DateTime>
pub fn get_created_on(&self) -> &Option<DateTime>
The time and date that this job definition was created.
Sourcepub fn last_modified_on(self, input: DateTime) -> Self
pub fn last_modified_on(self, input: DateTime) -> Self
The last point in time when this job definition was modified.
Sourcepub fn set_last_modified_on(self, input: Option<DateTime>) -> Self
pub fn set_last_modified_on(self, input: Option<DateTime>) -> Self
The last point in time when this job definition was modified.
Sourcepub fn get_last_modified_on(&self) -> &Option<DateTime>
pub fn get_last_modified_on(&self) -> &Option<DateTime>
The last point in time when this job definition was modified.
Sourcepub fn execution_property(self, input: ExecutionProperty) -> Self
pub fn execution_property(self, input: ExecutionProperty) -> Self
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
Sourcepub fn set_execution_property(self, input: Option<ExecutionProperty>) -> Self
pub fn set_execution_property(self, input: Option<ExecutionProperty>) -> Self
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
Sourcepub fn get_execution_property(&self) -> &Option<ExecutionProperty>
pub fn get_execution_property(&self) -> &Option<ExecutionProperty>
An ExecutionProperty
specifying the maximum number of concurrent runs allowed for this job.
Sourcepub fn command(self, input: JobCommand) -> Self
pub fn command(self, input: JobCommand) -> Self
The JobCommand
that runs this job.
Sourcepub fn set_command(self, input: Option<JobCommand>) -> Self
pub fn set_command(self, input: Option<JobCommand>) -> Self
The JobCommand
that runs this job.
Sourcepub fn get_command(&self) -> &Option<JobCommand>
pub fn get_command(&self) -> &Option<JobCommand>
The JobCommand
that runs this job.
Sourcepub fn default_arguments(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn default_arguments( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to default_arguments
.
To override the contents of this collection use set_default_arguments
.
The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
Sourcepub fn set_default_arguments(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_default_arguments( self, input: Option<HashMap<String, String>>, ) -> Self
The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
Sourcepub fn get_default_arguments(&self) -> &Option<HashMap<String, String>>
pub fn get_default_arguments(&self) -> &Option<HashMap<String, String>>
The default arguments for every run of this job, specified as name-value pairs.
You can specify arguments here that your own job-execution script consumes, as well as arguments that Glue itself consumes.
Job arguments may be logged. Do not pass plaintext secrets as arguments. Retrieve secrets from a Glue Connection, Secrets Manager or other secret management mechanism if you intend to keep them within the Job.
For information about how to specify and consume your own Job arguments, see the Calling Glue APIs in Python topic in the developer guide.
For information about the arguments you can provide to this field when configuring Spark jobs, see the Special Parameters Used by Glue topic in the developer guide.
For information about the arguments you can provide to this field when configuring Ray jobs, see Using job parameters in Ray jobs in the developer guide.
Sourcepub fn non_overridable_arguments(
self,
k: impl Into<String>,
v: impl Into<String>,
) -> Self
pub fn non_overridable_arguments( self, k: impl Into<String>, v: impl Into<String>, ) -> Self
Adds a key-value pair to non_overridable_arguments
.
To override the contents of this collection use set_non_overridable_arguments
.
Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
Sourcepub fn set_non_overridable_arguments(
self,
input: Option<HashMap<String, String>>,
) -> Self
pub fn set_non_overridable_arguments( self, input: Option<HashMap<String, String>>, ) -> Self
Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
Sourcepub fn get_non_overridable_arguments(&self) -> &Option<HashMap<String, String>>
pub fn get_non_overridable_arguments(&self) -> &Option<HashMap<String, String>>
Arguments for this job that are not overridden when providing job arguments in a job run, specified as name-value pairs.
Sourcepub fn connections(self, input: ConnectionsList) -> Self
pub fn connections(self, input: ConnectionsList) -> Self
The connections used for this job.
Sourcepub fn set_connections(self, input: Option<ConnectionsList>) -> Self
pub fn set_connections(self, input: Option<ConnectionsList>) -> Self
The connections used for this job.
Sourcepub fn get_connections(&self) -> &Option<ConnectionsList>
pub fn get_connections(&self) -> &Option<ConnectionsList>
The connections used for this job.
Sourcepub fn max_retries(self, input: i32) -> Self
pub fn max_retries(self, input: i32) -> Self
The maximum number of times to retry this job after a JobRun fails.
Sourcepub fn set_max_retries(self, input: Option<i32>) -> Self
pub fn set_max_retries(self, input: Option<i32>) -> Self
The maximum number of times to retry this job after a JobRun fails.
Sourcepub fn get_max_retries(&self) -> &Option<i32>
pub fn get_max_retries(&self) -> &Option<i32>
The maximum number of times to retry this job after a JobRun fails.
Sourcepub fn allocated_capacity(self, input: i32) -> Self
👎Deprecated: This property is deprecated, use MaxCapacity instead.
pub fn allocated_capacity(self, input: i32) -> Self
This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Sourcepub fn set_allocated_capacity(self, input: Option<i32>) -> Self
👎Deprecated: This property is deprecated, use MaxCapacity instead.
pub fn set_allocated_capacity(self, input: Option<i32>) -> Self
This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Sourcepub fn get_allocated_capacity(&self) -> &Option<i32>
👎Deprecated: This property is deprecated, use MaxCapacity instead.
pub fn get_allocated_capacity(&self) -> &Option<i32>
This field is deprecated. Use MaxCapacity
instead.
The number of Glue data processing units (DPUs) allocated to runs of this job. You can allocate a minimum of 2 DPUs; the default is 10. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
Sourcepub fn timeout(self, input: i32) -> Self
pub fn timeout(self, input: i32) -> Self
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status.
Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.
When the value is left blank, the timeout is defaulted to 2880 minutes.
Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.
Sourcepub fn set_timeout(self, input: Option<i32>) -> Self
pub fn set_timeout(self, input: Option<i32>) -> Self
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status.
Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.
When the value is left blank, the timeout is defaulted to 2880 minutes.
Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.
Sourcepub fn get_timeout(&self) -> &Option<i32>
pub fn get_timeout(&self) -> &Option<i32>
The job timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters TIMEOUT
status.
Jobs must have timeout values less than 7 days or 10080 minutes. Otherwise, the jobs will throw an exception.
When the value is left blank, the timeout is defaulted to 2880 minutes.
Any existing Glue jobs that had a timeout value greater than 7 days will be defaulted to 7 days. For instance if you have specified a timeout of 20 days for a batch job, it will be stopped on the 7th day.
For streaming jobs, if you have set up a maintenance window, it will be restarted during the maintenance window after 7 days.
Sourcepub fn max_capacity(self, input: f64) -> Self
pub fn max_capacity(self, input: f64) -> Self
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
-
When you specify a Python shell job (
JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. -
When you specify an Apache Spark ETL job (
JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
Sourcepub fn set_max_capacity(self, input: Option<f64>) -> Self
pub fn set_max_capacity(self, input: Option<f64>) -> Self
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
-
When you specify a Python shell job (
JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. -
When you specify an Apache Spark ETL job (
JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
Sourcepub fn get_max_capacity(&self) -> &Option<f64>
pub fn get_max_capacity(&self) -> &Option<f64>
For Glue version 1.0 or earlier jobs, using the standard worker type, the number of Glue data processing units (DPUs) that can be allocated when this job runs. A DPU is a relative measure of processing power that consists of 4 vCPUs of compute capacity and 16 GB of memory. For more information, see the Glue pricing page.
For Glue version 2.0 or later jobs, you cannot specify a Maximum capacity
. Instead, you should specify a Worker type
and the Number of workers
.
Do not set MaxCapacity
if using WorkerType
and NumberOfWorkers
.
The value that can be allocated for MaxCapacity
depends on whether you are running a Python shell job, an Apache Spark ETL job, or an Apache Spark streaming ETL job:
-
When you specify a Python shell job (
JobCommand.Name
="pythonshell"), you can allocate either 0.0625 or 1 DPU. The default is 0.0625 DPU. -
When you specify an Apache Spark ETL job (
JobCommand.Name
="glueetl") or Apache Spark streaming ETL job (JobCommand.Name
="gluestreaming"), you can allocate from 2 to 100 DPUs. The default is 10 DPUs. This job type cannot have a fractional DPU allocation.
Sourcepub fn worker_type(self, input: WorkerType) -> Self
pub fn worker_type(self, input: WorkerType) -> Self
The type of predefined worker that is allocated when a job runs.
Glue provides multiple worker types to accommodate different workload requirements:
G Worker Types (General-purpose compute workers):
-
G.1X: 1 DPU (4 vCPUs, 16 GB memory, 94GB disk)
-
G.2X: 2 DPU (8 vCPUs, 32 GB memory, 138GB disk)
-
G.4X: 4 DPU (16 vCPUs, 64 GB memory, 256GB disk)
-
G.8X: 8 DPU (32 vCPUs, 128 GB memory, 512GB disk)
-
G.12X: 12 DPU (48 vCPUs, 192 GB memory, 768GB disk)
-
G.16X: 16 DPU (64 vCPUs, 256 GB memory, 1024GB disk)
R Worker Types (Memory-optimized workers):
-
R.1X: 1 M-DPU (4 vCPUs, 32 GB memory)
-
R.2X: 2 M-DPU (8 vCPUs, 64 GB memory)
-
R.4X: 4 M-DPU (16 vCPUs, 128 GB memory)
-
R.8X: 8 M-DPU (32 vCPUs, 256 GB memory)
Sourcepub fn set_worker_type(self, input: Option<WorkerType>) -> Self
pub fn set_worker_type(self, input: Option<WorkerType>) -> Self
The type of predefined worker that is allocated when a job runs.
Glue provides multiple worker types to accommodate different workload requirements:
G Worker Types (General-purpose compute workers):
-
G.1X: 1 DPU (4 vCPUs, 16 GB memory, 94GB disk)
-
G.2X: 2 DPU (8 vCPUs, 32 GB memory, 138GB disk)
-
G.4X: 4 DPU (16 vCPUs, 64 GB memory, 256GB disk)
-
G.8X: 8 DPU (32 vCPUs, 128 GB memory, 512GB disk)
-
G.12X: 12 DPU (48 vCPUs, 192 GB memory, 768GB disk)
-
G.16X: 16 DPU (64 vCPUs, 256 GB memory, 1024GB disk)
R Worker Types (Memory-optimized workers):
-
R.1X: 1 M-DPU (4 vCPUs, 32 GB memory)
-
R.2X: 2 M-DPU (8 vCPUs, 64 GB memory)
-
R.4X: 4 M-DPU (16 vCPUs, 128 GB memory)
-
R.8X: 8 M-DPU (32 vCPUs, 256 GB memory)
Sourcepub fn get_worker_type(&self) -> &Option<WorkerType>
pub fn get_worker_type(&self) -> &Option<WorkerType>
The type of predefined worker that is allocated when a job runs.
Glue provides multiple worker types to accommodate different workload requirements:
G Worker Types (General-purpose compute workers):
-
G.1X: 1 DPU (4 vCPUs, 16 GB memory, 94GB disk)
-
G.2X: 2 DPU (8 vCPUs, 32 GB memory, 138GB disk)
-
G.4X: 4 DPU (16 vCPUs, 64 GB memory, 256GB disk)
-
G.8X: 8 DPU (32 vCPUs, 128 GB memory, 512GB disk)
-
G.12X: 12 DPU (48 vCPUs, 192 GB memory, 768GB disk)
-
G.16X: 16 DPU (64 vCPUs, 256 GB memory, 1024GB disk)
R Worker Types (Memory-optimized workers):
-
R.1X: 1 M-DPU (4 vCPUs, 32 GB memory)
-
R.2X: 2 M-DPU (8 vCPUs, 64 GB memory)
-
R.4X: 4 M-DPU (16 vCPUs, 128 GB memory)
-
R.8X: 8 M-DPU (32 vCPUs, 256 GB memory)
Sourcepub fn number_of_workers(self, input: i32) -> Self
pub fn number_of_workers(self, input: i32) -> Self
The number of workers of a defined workerType
that are allocated when a job runs.
Sourcepub fn set_number_of_workers(self, input: Option<i32>) -> Self
pub fn set_number_of_workers(self, input: Option<i32>) -> Self
The number of workers of a defined workerType
that are allocated when a job runs.
Sourcepub fn get_number_of_workers(&self) -> &Option<i32>
pub fn get_number_of_workers(&self) -> &Option<i32>
The number of workers of a defined workerType
that are allocated when a job runs.
Sourcepub fn security_configuration(self, input: impl Into<String>) -> Self
pub fn security_configuration(self, input: impl Into<String>) -> Self
The name of the SecurityConfiguration
structure to be used with this job.
Sourcepub fn set_security_configuration(self, input: Option<String>) -> Self
pub fn set_security_configuration(self, input: Option<String>) -> Self
The name of the SecurityConfiguration
structure to be used with this job.
Sourcepub fn get_security_configuration(&self) -> &Option<String>
pub fn get_security_configuration(&self) -> &Option<String>
The name of the SecurityConfiguration
structure to be used with this job.
Sourcepub fn notification_property(self, input: NotificationProperty) -> Self
pub fn notification_property(self, input: NotificationProperty) -> Self
Specifies configuration properties of a job notification.
Sourcepub fn set_notification_property(
self,
input: Option<NotificationProperty>,
) -> Self
pub fn set_notification_property( self, input: Option<NotificationProperty>, ) -> Self
Specifies configuration properties of a job notification.
Sourcepub fn get_notification_property(&self) -> &Option<NotificationProperty>
pub fn get_notification_property(&self) -> &Option<NotificationProperty>
Specifies configuration properties of a job notification.
Sourcepub fn glue_version(self, input: impl Into<String>) -> Self
pub fn glue_version(self, input: impl Into<String>) -> Self
In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
Sourcepub fn set_glue_version(self, input: Option<String>) -> Self
pub fn set_glue_version(self, input: Option<String>) -> Self
In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
Sourcepub fn get_glue_version(&self) -> &Option<String>
pub fn get_glue_version(&self) -> &Option<String>
In Spark jobs, GlueVersion
determines the versions of Apache Spark and Python that Glue available in a job. The Python version indicates the version supported for jobs of type Spark.
Ray jobs should set GlueVersion
to 4.0
or greater. However, the versions of Ray, Python and additional libraries available in your Ray job are determined by the Runtime
parameter of the Job command.
For more information about the available Glue versions and corresponding Spark and Python versions, see Glue version in the developer guide.
Jobs that are created without specifying a Glue version default to Glue 0.9.
Sourcepub fn code_gen_configuration_nodes(
self,
k: impl Into<String>,
v: CodeGenConfigurationNode,
) -> Self
pub fn code_gen_configuration_nodes( self, k: impl Into<String>, v: CodeGenConfigurationNode, ) -> Self
Adds a key-value pair to code_gen_configuration_nodes
.
To override the contents of this collection use set_code_gen_configuration_nodes
.
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
Sourcepub fn set_code_gen_configuration_nodes(
self,
input: Option<HashMap<String, CodeGenConfigurationNode>>,
) -> Self
pub fn set_code_gen_configuration_nodes( self, input: Option<HashMap<String, CodeGenConfigurationNode>>, ) -> Self
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
Sourcepub fn get_code_gen_configuration_nodes(
&self,
) -> &Option<HashMap<String, CodeGenConfigurationNode>>
pub fn get_code_gen_configuration_nodes( &self, ) -> &Option<HashMap<String, CodeGenConfigurationNode>>
The representation of a directed acyclic graph on which both the Glue Studio visual component and Glue Studio code generation is based.
Sourcepub fn execution_class(self, input: ExecutionClass) -> Self
pub fn execution_class(self, input: ExecutionClass) -> Self
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Sourcepub fn set_execution_class(self, input: Option<ExecutionClass>) -> Self
pub fn set_execution_class(self, input: Option<ExecutionClass>) -> Self
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Sourcepub fn get_execution_class(&self) -> &Option<ExecutionClass>
pub fn get_execution_class(&self) -> &Option<ExecutionClass>
Indicates whether the job is run with a standard or flexible execution class. The standard execution class is ideal for time-sensitive workloads that require fast job startup and dedicated resources.
The flexible execution class is appropriate for time-insensitive jobs whose start and completion times may vary.
Only jobs with Glue version 3.0 and above and command type glueetl
will be allowed to set ExecutionClass
to FLEX
. The flexible execution class is available for Spark jobs.
Sourcepub fn source_control_details(self, input: SourceControlDetails) -> Self
pub fn source_control_details(self, input: SourceControlDetails) -> Self
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Sourcepub fn set_source_control_details(
self,
input: Option<SourceControlDetails>,
) -> Self
pub fn set_source_control_details( self, input: Option<SourceControlDetails>, ) -> Self
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Sourcepub fn get_source_control_details(&self) -> &Option<SourceControlDetails>
pub fn get_source_control_details(&self) -> &Option<SourceControlDetails>
The details for a source control configuration for a job, allowing synchronization of job artifacts to or from a remote repository.
Sourcepub fn maintenance_window(self, input: impl Into<String>) -> Self
pub fn maintenance_window(self, input: impl Into<String>) -> Self
This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
Sourcepub fn set_maintenance_window(self, input: Option<String>) -> Self
pub fn set_maintenance_window(self, input: Option<String>) -> Self
This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
Sourcepub fn get_maintenance_window(&self) -> &Option<String>
pub fn get_maintenance_window(&self) -> &Option<String>
This field specifies a day of the week and hour for a maintenance window for streaming jobs. Glue periodically performs maintenance activities. During these maintenance windows, Glue will need to restart your streaming jobs.
Glue will restart the job within 3 hours of the specified maintenance window. For instance, if you set up the maintenance window for Monday at 10:00AM GMT, your jobs will be restarted between 10:00AM GMT to 1:00PM GMT.
Sourcepub fn profile_name(self, input: impl Into<String>) -> Self
pub fn profile_name(self, input: impl Into<String>) -> Self
The name of an Glue usage profile associated with the job.
Sourcepub fn set_profile_name(self, input: Option<String>) -> Self
pub fn set_profile_name(self, input: Option<String>) -> Self
The name of an Glue usage profile associated with the job.
Sourcepub fn get_profile_name(&self) -> &Option<String>
pub fn get_profile_name(&self) -> &Option<String>
The name of an Glue usage profile associated with the job.
Trait Implementations§
Source§impl Clone for JobBuilder
impl Clone for JobBuilder
Source§fn clone(&self) -> JobBuilder
fn clone(&self) -> JobBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for JobBuilder
impl Debug for JobBuilder
Source§impl Default for JobBuilder
impl Default for JobBuilder
Source§fn default() -> JobBuilder
fn default() -> JobBuilder
Source§impl PartialEq for JobBuilder
impl PartialEq for JobBuilder
impl StructuralPartialEq for JobBuilder
Auto Trait Implementations§
impl Freeze for JobBuilder
impl RefUnwindSafe for JobBuilder
impl Send for JobBuilder
impl Sync for JobBuilder
impl Unpin for JobBuilder
impl UnwindSafe for JobBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);