Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance. Project price only 1 $
You can buy this project and download/modify it how often you want.
// Code generated by smithy-kotlin-codegen. DO NOT EDIT!
package aws.sdk.kotlin.services.glue.model
import aws.smithy.kotlin.runtime.SdkDsl
public class StartJobRunRequest private constructor(builder: Builder) {
/**
* This field is deprecated. Use `MaxCapacity` instead.
*
* The number of Glue data processing units (DPUs) to allocate to this JobRun. 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](https://aws.amazon.com/glue/pricing/).
*/
@Deprecated("This property is deprecated, use MaxCapacity instead.")
public val allocatedCapacity: kotlin.Int? = builder.allocatedCapacity
/**
* The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
*
* 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](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 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](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 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](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) in the developer guide.
*/
public val arguments: Map? = builder.arguments
/**
* 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.
*/
public val executionClass: aws.sdk.kotlin.services.glue.model.ExecutionClass? = builder.executionClass
/**
* The name of the job definition to use.
*/
public val jobName: kotlin.String? = builder.jobName
/**
* The ID of a previous `JobRun` to retry.
*/
public val jobRunId: kotlin.String? = builder.jobRunId
/**
* Specifies whether job run queuing is enabled for the job run.
*
* A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
*/
public val jobRunQueuingEnabled: kotlin.Boolean? = builder.jobRunQueuingEnabled
/**
* 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](https://aws.amazon.com/glue/pricing/).
*
* For Glue version 2.0+ 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.
*/
public val maxCapacity: kotlin.Double? = builder.maxCapacity
/**
* Specifies configuration properties of a job run notification.
*/
public val notificationProperty: aws.sdk.kotlin.services.glue.model.NotificationProperty? = builder.notificationProperty
/**
* The number of workers of a defined `workerType` that are allocated when a job runs.
*/
public val numberOfWorkers: kotlin.Int? = builder.numberOfWorkers
/**
* The name of the `SecurityConfiguration` structure to be used with this job run.
*/
public val securityConfiguration: kotlin.String? = builder.securityConfiguration
/**
* The `JobRun` timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters `TIMEOUT` status. This value overrides the timeout value set in the parent job.
*
* Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
*/
public val timeout: kotlin.Int? = builder.timeout
/**
* The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
* + For the `G.1X` worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
* + For the `G.2X` worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
* + For the `G.4X` worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
* + For the `G.8X` worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the `G.4X` worker type.
* + For the `G.025X` worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
* + For the `Z.2X` worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
*/
public val workerType: aws.sdk.kotlin.services.glue.model.WorkerType? = builder.workerType
public companion object {
public operator fun invoke(block: Builder.() -> kotlin.Unit): aws.sdk.kotlin.services.glue.model.StartJobRunRequest = Builder().apply(block).build()
}
override fun toString(): kotlin.String = buildString {
append("StartJobRunRequest(")
append("allocatedCapacity=$allocatedCapacity,")
append("arguments=$arguments,")
append("executionClass=$executionClass,")
append("jobName=$jobName,")
append("jobRunId=$jobRunId,")
append("jobRunQueuingEnabled=$jobRunQueuingEnabled,")
append("maxCapacity=$maxCapacity,")
append("notificationProperty=$notificationProperty,")
append("numberOfWorkers=$numberOfWorkers,")
append("securityConfiguration=$securityConfiguration,")
append("timeout=$timeout,")
append("workerType=$workerType")
append(")")
}
override fun hashCode(): kotlin.Int {
var result = allocatedCapacity ?: 0
result = 31 * result + (arguments?.hashCode() ?: 0)
result = 31 * result + (executionClass?.hashCode() ?: 0)
result = 31 * result + (jobName?.hashCode() ?: 0)
result = 31 * result + (jobRunId?.hashCode() ?: 0)
result = 31 * result + (jobRunQueuingEnabled?.hashCode() ?: 0)
result = 31 * result + (maxCapacity?.hashCode() ?: 0)
result = 31 * result + (notificationProperty?.hashCode() ?: 0)
result = 31 * result + (numberOfWorkers ?: 0)
result = 31 * result + (securityConfiguration?.hashCode() ?: 0)
result = 31 * result + (timeout ?: 0)
result = 31 * result + (workerType?.hashCode() ?: 0)
return result
}
override fun equals(other: kotlin.Any?): kotlin.Boolean {
if (this === other) return true
if (other == null || this::class != other::class) return false
other as StartJobRunRequest
if (allocatedCapacity != other.allocatedCapacity) return false
if (arguments != other.arguments) return false
if (executionClass != other.executionClass) return false
if (jobName != other.jobName) return false
if (jobRunId != other.jobRunId) return false
if (jobRunQueuingEnabled != other.jobRunQueuingEnabled) return false
if (!(maxCapacity?.equals(other.maxCapacity) ?: (other.maxCapacity == null))) return false
if (notificationProperty != other.notificationProperty) return false
if (numberOfWorkers != other.numberOfWorkers) return false
if (securityConfiguration != other.securityConfiguration) return false
if (timeout != other.timeout) return false
if (workerType != other.workerType) return false
return true
}
public inline fun copy(block: Builder.() -> kotlin.Unit = {}): aws.sdk.kotlin.services.glue.model.StartJobRunRequest = Builder(this).apply(block).build()
@SdkDsl
public class Builder {
/**
* This field is deprecated. Use `MaxCapacity` instead.
*
* The number of Glue data processing units (DPUs) to allocate to this JobRun. 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](https://aws.amazon.com/glue/pricing/).
*/
@Deprecated("This property is deprecated, use MaxCapacity instead.")
public var allocatedCapacity: kotlin.Int? = null
/**
* The job arguments associated with this run. For this job run, they replace the default arguments set in the job definition itself.
*
* 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](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-python-calling.html) 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](https://docs.aws.amazon.com/glue/latest/dg/aws-glue-programming-etl-glue-arguments.html) 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](https://docs.aws.amazon.com/glue/latest/dg/author-job-ray-job-parameters.html) in the developer guide.
*/
public var arguments: Map? = null
/**
* 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.
*/
public var executionClass: aws.sdk.kotlin.services.glue.model.ExecutionClass? = null
/**
* The name of the job definition to use.
*/
public var jobName: kotlin.String? = null
/**
* The ID of a previous `JobRun` to retry.
*/
public var jobRunId: kotlin.String? = null
/**
* Specifies whether job run queuing is enabled for the job run.
*
* A value of true means job run queuing is enabled for the job run. If false or not populated, the job run will not be considered for queueing.
*/
public var jobRunQueuingEnabled: kotlin.Boolean? = null
/**
* 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](https://aws.amazon.com/glue/pricing/).
*
* For Glue version 2.0+ 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.
*/
public var maxCapacity: kotlin.Double? = null
/**
* Specifies configuration properties of a job run notification.
*/
public var notificationProperty: aws.sdk.kotlin.services.glue.model.NotificationProperty? = null
/**
* The number of workers of a defined `workerType` that are allocated when a job runs.
*/
public var numberOfWorkers: kotlin.Int? = null
/**
* The name of the `SecurityConfiguration` structure to be used with this job run.
*/
public var securityConfiguration: kotlin.String? = null
/**
* The `JobRun` timeout in minutes. This is the maximum time that a job run can consume resources before it is terminated and enters `TIMEOUT` status. This value overrides the timeout value set in the parent job.
*
* Streaming jobs must have timeout values less than 7 days or 10080 minutes. When the value is left blank, the job will be restarted after 7 days based if you have not setup a maintenance window. If you have setup maintenance window, it will be restarted during the maintenance window after 7 days.
*/
public var timeout: kotlin.Int? = null
/**
* The type of predefined worker that is allocated when a job runs. Accepts a value of G.1X, G.2X, G.4X, G.8X or G.025X for Spark jobs. Accepts the value Z.2X for Ray jobs.
* + For the `G.1X` worker type, each worker maps to 1 DPU (4 vCPUs, 16 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
* + For the `G.2X` worker type, each worker maps to 2 DPU (8 vCPUs, 32 GB of memory) with 128GB disk (approximately 77GB free), and provides 1 executor per worker. We recommend this worker type for workloads such as data transforms, joins, and queries, to offers a scalable and cost effective way to run most jobs.
* + For the `G.4X` worker type, each worker maps to 4 DPU (16 vCPUs, 64 GB of memory) with 256GB disk (approximately 235GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs in the following Amazon Web Services Regions: US East (Ohio), US East (N. Virginia), US West (Oregon), Asia Pacific (Singapore), Asia Pacific (Sydney), Asia Pacific (Tokyo), Canada (Central), Europe (Frankfurt), Europe (Ireland), and Europe (Stockholm).
* + For the `G.8X` worker type, each worker maps to 8 DPU (32 vCPUs, 128 GB of memory) with 512GB disk (approximately 487GB free), and provides 1 executor per worker. We recommend this worker type for jobs whose workloads contain your most demanding transforms, aggregations, joins, and queries. This worker type is available only for Glue version 3.0 or later Spark ETL jobs, in the same Amazon Web Services Regions as supported for the `G.4X` worker type.
* + For the `G.025X` worker type, each worker maps to 0.25 DPU (2 vCPUs, 4 GB of memory) with 84GB disk (approximately 34GB free), and provides 1 executor per worker. We recommend this worker type for low volume streaming jobs. This worker type is only available for Glue version 3.0 streaming jobs.
* + For the `Z.2X` worker type, each worker maps to 2 M-DPU (8vCPUs, 64 GB of memory) with 128 GB disk (approximately 120GB free), and provides up to 8 Ray workers based on the autoscaler.
*/
public var workerType: aws.sdk.kotlin.services.glue.model.WorkerType? = null
@PublishedApi
internal constructor()
@PublishedApi
internal constructor(x: aws.sdk.kotlin.services.glue.model.StartJobRunRequest) : this() {
this.allocatedCapacity = x.allocatedCapacity
this.arguments = x.arguments
this.executionClass = x.executionClass
this.jobName = x.jobName
this.jobRunId = x.jobRunId
this.jobRunQueuingEnabled = x.jobRunQueuingEnabled
this.maxCapacity = x.maxCapacity
this.notificationProperty = x.notificationProperty
this.numberOfWorkers = x.numberOfWorkers
this.securityConfiguration = x.securityConfiguration
this.timeout = x.timeout
this.workerType = x.workerType
}
@PublishedApi
internal fun build(): aws.sdk.kotlin.services.glue.model.StartJobRunRequest = StartJobRunRequest(this)
/**
* construct an [aws.sdk.kotlin.services.glue.model.NotificationProperty] inside the given [block]
*/
public fun notificationProperty(block: aws.sdk.kotlin.services.glue.model.NotificationProperty.Builder.() -> kotlin.Unit) {
this.notificationProperty = aws.sdk.kotlin.services.glue.model.NotificationProperty.invoke(block)
}
internal fun correctErrors(): Builder {
return this
}
}
}
