software.amazon.awscdk.services.glue

Interface IJob

All Superinterfaces:

IConstruct, IDependable, IGrantable, IResource

All Known Subinterfaces:

IJob.Jsii$Default

All Known Implementing Classes:

IJob.Jsii$Proxy, Job

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:45.659Z")
public interface IJob
extends IResource, IGrantable

(experimental) Interface representing a created or an imported Job.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IJob.Jsii$Default Internal default implementation for IJob.
static class	IJob.Jsii$Proxy A proxy class which represents a concrete javascript instance of this type.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getJobArn() (experimental) The ARN of the job.
java.lang.String	getJobName() (experimental) The name of the job.
Metric	metric(java.lang.String metricName, MetricType type) (experimental) Create a CloudWatch metric.
Metric	metric(java.lang.String metricName, MetricType type, MetricOptions props) (experimental) Create a CloudWatch metric.
Metric	metricFailure() (experimental) Create a CloudWatch Metric indicating job failure.
Metric	metricFailure(MetricOptions props) (experimental) Create a CloudWatch Metric indicating job failure.
Metric	metricSuccess() (experimental) Create a CloudWatch Metric indicating job success.
Metric	metricSuccess(MetricOptions props) (experimental) Create a CloudWatch Metric indicating job success.
Metric	metricTimeout() (experimental) Create a CloudWatch Metric indicating job timeout.
Metric	metricTimeout(MetricOptions props) (experimental) Create a CloudWatch Metric indicating job timeout.
Rule	onEvent(java.lang.String id) (experimental) Defines a CloudWatch event rule triggered when something happens with this job.
Rule	onEvent(java.lang.String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule triggered when something happens with this job.
Rule	onFailure(java.lang.String id) (experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.
Rule	onFailure(java.lang.String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.
Rule	onStateChange(java.lang.String id, JobState jobState) (experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.
Rule	onStateChange(java.lang.String id, JobState jobState, OnEventOptions options) (experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.
Rule	onSuccess(java.lang.String id) (experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.
Rule	onSuccess(java.lang.String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.
Rule	onTimeout(java.lang.String id) (experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.
Rule	onTimeout(java.lang.String id, OnEventOptions options) (experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

Methods inherited from interface software.amazon.awscdk.core.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.awscdk.core.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.services.iam.IGrantable

getGrantPrincipal

Method Detail

getJobArn

java.lang.String getJobArn()

(experimental) The ARN of the job.

getJobName

java.lang.String getJobName()

(experimental) The name of the job.

metric

Metric metric(java.lang.String metricName,
              MetricType type,
              MetricOptions props)

(experimental) Create a CloudWatch metric.

Parameters:

metricName - name of the metric typically prefixed with `glue.driver.`, `glue..` or `glue.ALL.`. This parameter is required.

type - the metric type. This parameter is required.

props - metric options.

See Also:

https://docs.aws.amazon.com/glue/latest/dg/monitoring-awsglue-with-cloudwatch-metrics.html

metric

Metric metric(java.lang.String metricName,
              MetricType type)

(experimental) Create a CloudWatch metric.

Parameters:

metricName - name of the metric typically prefixed with `glue.driver.`, `glue..` or `glue.ALL.`. This parameter is required.

type - the metric type. This parameter is required.

See Also:

https://docs.aws.amazon.com/glue/latest/dg/monitoring-awsglue-with-cloudwatch-metrics.html

metricFailure

Metric metricFailure(MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job failure.

Parameters:

props -

metricFailure

Metric metricFailure()

(experimental) Create a CloudWatch Metric indicating job failure.

metricSuccess

Metric metricSuccess(MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job success.

Parameters:

props -

metricSuccess

Metric metricSuccess()

(experimental) Create a CloudWatch Metric indicating job success.

metricTimeout

Metric metricTimeout(MetricOptions props)

(experimental) Create a CloudWatch Metric indicating job timeout.

Parameters:

props -

metricTimeout

Metric metricTimeout()

(experimental) Create a CloudWatch Metric indicating job timeout.

onEvent

Rule onEvent(java.lang.String id,
             OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when something happens with this job.

Parameters:

id - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onEvent

Rule onEvent(java.lang.String id)

(experimental) Defines a CloudWatch event rule triggered when something happens with this job.

Parameters:

id - This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onFailure

Rule onFailure(java.lang.String id,
               OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.

Parameters:

id - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onFailure

Rule onFailure(java.lang.String id)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the FAILED state.

Parameters:

id - This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onStateChange

Rule onStateChange(java.lang.String id,
                   JobState jobState,
                   OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.

Parameters:

id - This parameter is required.

jobState - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onStateChange

Rule onStateChange(java.lang.String id,
                   JobState jobState)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the input jobState.

Parameters:

id - This parameter is required.

jobState - This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onSuccess

Rule onSuccess(java.lang.String id,
               OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.

Parameters:

id - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onSuccess

Rule onSuccess(java.lang.String id)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the SUCCEEDED state.

Parameters:

id - This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onTimeout

Rule onTimeout(java.lang.String id,
               OnEventOptions options)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

Parameters:

id - This parameter is required.

options -

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types

onTimeout

Rule onTimeout(java.lang.String id)

(experimental) Defines a CloudWatch event rule triggered when this job moves to the TIMEOUT state.

Parameters:

id - This parameter is required.

See Also:

https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/EventTypes.html#glue-event-types