Airflow Documentation, Release 1.10.

N poke() (airflow.contrib.sensors.weekday_sensor.DayOfWeekSensor
NamedHivePartitionSensor (class in air- method), 357
flow.sensors.named_hive_partition_sensor), poke() (airflow.sensors.base_sensor_operator.BaseSensorOperator
303 method), 292
next_retry_datetime() (air- poke() (airflow.sensors.external_task_sensor.ExternalTaskSensor
flow.models.TaskInstance method), 374 method), 301
normalize_schedule() (airflow.models.DAG poke() (airflow.sensors.hive_partition_sensor.HivePartitionSensor
method), 367 method), 302
NullFernet (class in airflow.models), 371 poke() (airflow.sensors.http_sensor.HttpSensor
method), 302
O poke() (airflow.sensors.metastore_partition_sensor.MetastorePartitionSen
method), 303
on_kill() (airflow.contrib.operators.aws_athena_operator.AWSAthenaOperator
method), 305 poke() (airflow.sensors.named_hive_partition_sensor.NamedHivePartition
on_kill() (airflow.models.BaseOperator method), method), 303
291, 362 poke() (airflow.sensors.s3_key_sensor.S3KeySensor
open_slots() (airflow.models.Pool method), 371 method), 303
OpenFaasHook (class in air- poke() (airflow.sensors.s3_prefix_sensor.S3PrefixSensor
flow.contrib.hooks.openfaas_hook), 404 method), 304
poke() (airflow.sensors.sql_sensor.SqlSensor method),
P 304
patch_instance_group_manager() (air- poke() (airflow.sensors.time_delta_sensor.TimeDeltaSensor
flow.contrib.hooks.gcp_compute_hook.GceHook method), 304
method), 180 poke() (airflow.sensors.time_sensor.TimeSensor
PigCliHook (class in airflow.hooks.pig_hook), 383 method), 304
PigOperator (class in air- poke() (airflow.sensors.web_hdfs_sensor.WebHdfsSensor
flow.operators.pig_operator), 297 method), 305
poll_operation_until_done()
poke() (airflow.contrib.sensors.aws_athena_sensor.AthenaSensor (air-
method), 351 flow.contrib.hooks.datastore_hook.DatastoreHook
method), 199, 392
poke() (airflow.contrib.sensors.aws_glue_catalog_partition_sensor.AwsGlueCatalogPartitionSensor
method), 351 poll_query_status() (air-
flow.contrib.hooks.aws_athena_hook.AWSAthenaHook
poke() (airflow.contrib.sensors.aws_redshift_cluster_sensor.AwsRedshiftClusterSensor
method), 143, 351 method), 387
poke() (airflow.contrib.sensors.bash_sensor.BashSensor Pool (class in airflow.models), 371
method), 352 pool_full() (airflow.models.TaskInstance method),
poke() (airflow.contrib.sensors.bigquery_sensor.BigQueryTableSensor374
method), 352 Popen() (airflow.contrib.hooks.sqoop_hook.SqoopHook
poke() (airflow.contrib.sensors.emr_base_sensor.EmrBaseSensor method), 415
method), 352 post_execute() (airflow.models.BaseOperator
poke() (airflow.contrib.sensors.file_sensor.FileSensor method), 291, 362
method), 353 pre_execute() (airflow.models.BaseOperator
poke() (airflow.contrib.sensors.ftp_sensor.FTPSensor method), 291, 362
method), 353 prepare_request() (air-
flow.contrib.operators.hipchat_operator.HipChatAPIOperator
poke() (airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectSensor
method), 354 method), 335
prepare_request()
poke() (airflow.contrib.sensors.gcs_sensor.GoogleCloudStorageObjectUpdatedSensor (air-
method), 354 flow.contrib.operators.hipchat_operator.HipChatAPISendRoomNo
method), 335
poke() (airflow.contrib.sensors.gcs_sensor.GoogleCloudStoragePrefixSensor
method), 354 prepare_template() (air-
poke() (airflow.contrib.sensors.pubsub_sensor.PubSubPullSensor flow.models.BaseOperator method), 291,
method), 355 362
previous_schedule()
poke() (airflow.contrib.sensors.python_sensor.PythonSensor (airflow.models.DAG
method), 355 method), 367
previous_ti (airflow.models.TaskInstance attribute),
poke() (airflow.contrib.sensors.sagemaker_base_sensor.SageMakerBaseSensor
method), 355 374

432 Index
 Airflow Documentation, Release 1.10.2

process_file() (airflow.models.DagBag method), render_template_from_field() (air-

369 flow.models.BaseOperator method), 291,
publish() (airflow.contrib.hooks.gcp_pubsub_hook.PubSubHook 363
method), 399 restore_from_cluster_snapshot() (air-
PubSubHook (class in air- flow.contrib.hooks.redshift_hook.RedshiftHook
flow.contrib.hooks.gcp_pubsub_hook), 397 method), 144, 405
PubSubPublishOperator (class in air- retrieve_file() (air-
flow.contrib.operators.pubsub_operator), flow.contrib.hooks.ftp_hook.FTPHook method),
341 395
PubSubPullSensor (class in air- retrieve_mail_attachments() (air-
flow.contrib.sensors.pubsub_sensor), 354 flow.contrib.hooks.imap_hook.ImapHook
PubSubSubscriptionCreateOperator (class method), 404
in airflow.contrib.operators.pubsub_operator), rewrite() (airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook
340 method), 214, 402
PubSubSubscriptionDeleteOperator (class rollback() (airflow.contrib.hooks.datastore_hook.DatastoreHook
in airflow.contrib.operators.pubsub_operator), method), 199, 392
340 run() (airflow.hooks.dbapi_hook.DbApiHook method),
PubSubTopicCreateOperator (class in air- 377
flow.contrib.operators.pubsub_operator), run() (airflow.hooks.http_hook.HttpHook method), 382
339 run() (airflow.models.BaseOperator method), 291, 363
PubSubTopicDeleteOperator (class in air- run() (airflow.models.DAG method), 367
flow.contrib.operators.pubsub_operator), run_and_check() (air-
339 flow.hooks.http_hook.HttpHook method),
pull() (airflow.contrib.hooks.gcp_pubsub_hook.PubSubHook 382
method), 399 run_cli() (airflow.hooks.hive_hooks.HiveCliHook
put_records() (air- method), 379
flow.contrib.hooks.aws_firehose_hook.AwsFirehoseHook
run_cli() (airflow.hooks.pig_hook.PigCliHook
method), 388 method), 383
PythonOperator (class in air- run_now() (airflow.contrib.hooks.databricks_hook.DatabricksHook
flow.operators.python_operator), 297 method), 391
PythonSensor (class in air- run_query() (airflow.contrib.hooks.aws_athena_hook.AWSAthenaHook
flow.contrib.sensors.python_sensor), 355 method), 388
PythonVirtualenvOperator (class in air- run_query() (airflow.contrib.hooks.datastore_hook.DatastoreHook
flow.operators.python_operator), 297 method), 199, 393
run_query() (airflow.contrib.hooks.spark_sql_hook.SparkSqlHook
Q method), 413
queued_slots() (airflow.models.Pool method), 371 run_with_advanced_retry() (air-
flow.hooks.http_hook.HttpHook method),
R 382
random() (in module airflow.macros), 359
read_key() (airflow.hooks.S3_hook.S3Hook method),
S
138, 386 S3FileTransformOperator (class in air-
ready_for_retry() (airflow.models.TaskInstance flow.operators.s3_file_transform_operator),
method), 374 139, 298
RedshiftHook (class in air- S3Hook (class in airflow.hooks.S3_hook), 135, 383
flow.contrib.hooks.redshift_hook), 143, 404 S3KeySensor (class in airflow.sensors.s3_key_sensor),
refresh_from_db() (airflow.models.DagRun 303
method), 370 S3ListOperator (class in air-
refresh_from_db() (airflow.models.TaskInstance flow.contrib.operators.s3_list_operator),
method), 374 139, 341
rename() (airflow.contrib.hooks.ftp_hook.FTPHook S3PrefixSensor (class in air-
method), 395 flow.sensors.s3_prefix_sensor), 303
render_template() (airflow.models.BaseOperator S3ToGoogleCloudStorageOperator (class in
method), 291, 362 airflow.contrib.operators.s3_to_gcs_operator),

Index 433
Airflow Documentation, Release 1.10.2

140, 342 flow.executors.sequential_executor), 417

S3ToGoogleCloudStorageTransferOperator set() (airflow.models.XCom class method), 375
(class in air- set_autocommit() (air-
flow.contrib.operators.s3_to_gcs_transfer_operator), flow.hooks.dbapi_hook.DbApiHook method),
343 378
S3ToHiveTransfer (class in air- set_autocommit() (air-
flow.operators.s3_to_hive_operator), 141, flow.hooks.mssql_hook.MsSqlHook method),
299 383
SageMakerBaseOperator (class in air- set_default_version() (air-
flow.contrib.operators.sagemaker_base_operator), flow.contrib.hooks.gcp_mlengine_hook.MLEngineHook
343 method), 204, 397
SageMakerBaseSensor (class in air- set_dependency() (airflow.models.DAG method),
flow.contrib.sensors.sagemaker_base_sensor), 368
355 set_dirty() (airflow.models.DagStat static method),
SageMakerEndpointConfigOperator 371
(class in air- set_downstream() (airflow.models.BaseOperator
flow.contrib.operators.sagemaker_endpoint_config_operator), method), 291, 363
151, 159, 344 set_machine_type() (air-
SageMakerEndpointOperator (class in air- flow.contrib.hooks.gcp_compute_hook.GceHook
flow.contrib.operators.sagemaker_endpoint_operator), method), 180
152, 160, 344 set_upstream() (airflow.models.BaseOperator
SageMakerEndpointSensor (class in air- method), 291, 363
flow.contrib.sensors.sagemaker_endpoint_sensor),setdefault() (airflow.models.Variable class
355 method), 375
SageMakerHook (class in air- ShortCircuitOperator (class in air-
flow.contrib.hooks.sagemaker_hook), 145, flow.operators.python_operator), 300
153, 405 SimpleHttpOperator (class in air-
SageMakerModelOperator (class in air- flow.operators.http_operator), 300
flow.contrib.operators.sagemaker_model_operator), size() (airflow.models.DagBag method), 369
150, 158, 345 SlackWebhookHook (class in air-
SageMakerTrainingOperator (class in air- flow.contrib.hooks.slack_webhook_hook),
flow.contrib.operators.sagemaker_training_operator), 410
149, 157, 345 SlackWebhookOperator (class in air-
SageMakerTrainingSensor (class in air- flow.contrib.operators.slack_webhook_operator),
flow.contrib.sensors.sagemaker_training_sensor), 346
355 SlaMiss (class in airflow.models), 371
SageMakerTransformOperator (class in air- SparkJDBCHook (class in air-
flow.contrib.operators.sagemaker_transform_operator), flow.contrib.hooks.spark_jdbc_hook), 410
151, 159, 345 SparkJDBCOperator (class in air-
SageMakerTransformSensor (class in air- flow.contrib.operators.spark_jdbc_operator),
flow.contrib.sensors.sagemaker_transform_sensor), 347
356 SparkSqlHook (class in air-
SageMakerTuningOperator (class in air- flow.contrib.hooks.spark_sql_hook), 412
flow.contrib.operators.sagemaker_tuning_operator), SparkSqlOperator (class in air-
150, 158, 346 flow.contrib.operators.spark_sql_operator),
SageMakerTuningSensor (class in air- 348
flow.contrib.sensors.sagemaker_tuning_sensor), SparkSubmitHook (class in air-
356 flow.contrib.hooks.spark_submit_hook), 413
schedule_interval (airflow.models.BaseOperator SparkSubmitOperator (class in air-
attribute), 291, 363 flow.contrib.operators.spark_submit_operator),
Secret (class in airflow.contrib.kubernetes.secret), 219 349
select_key() (airflow.hooks.S3_hook.S3Hook SqliteHook (class in airflow.hooks.sqlite_hook), 387
method), 138, 386 SqliteOperator (class in air-
SequentialExecutor (class in air- flow.operators.sqlite_operator), 300

434 Index
 Airflow Documentation, Release 1.10.2

SqlSensor (class in airflow.sensors.sql_sensor), 304 test_hql() (airflow.hooks.hive_hooks.HiveCliHook

SqoopHook (class in air- method), 379
flow.contrib.hooks.sqoop_hook), 415 TimeDeltaSensor (class in air-
SqoopOperator (class in air- flow.sensors.time_delta_sensor), 304
flow.contrib.operators.sqoop_operator), TimeSensor (class in airflow.sensors.time_sensor),
350 304
start() (airflow.contrib.executors.mesos_executor.MesosExecutor
to_csv() (airflow.hooks.hive_hooks.HiveServer2Hook
method), 418 method), 381
start() (airflow.executors.local_executor.LocalExecutor topological_sort() (airflow.models.DAG
method), 417 method), 368
start_instance() (air- tree_view() (airflow.models.DAG method), 368
flow.contrib.hooks.gcp_compute_hook.GceHook TriggerDagRunOperator (class in air-
method), 181 flow.operators.dagrun_operator), 300
stop_instance() (air- try_number (airflow.models.TaskInstance attribute),
flow.contrib.hooks.gcp_compute_hook.GceHook 374
method), 181
U
stop_query() (airflow.contrib.hooks.aws_athena_hook.AWSAthenaHook
method), 388 update() (airflow.models.DagStat static method), 371
store_file() (airflow.contrib.hooks.ftp_hook.FTPHookupdate_endpoint() (air-
method), 395 flow.contrib.hooks.sagemaker_hook.SageMakerHook
sub_dag() (airflow.models.DAG method), 368 method), 149, 157, 409
SubDagOperator (class in air- update_function() (air-
flow.operators.subdag_operator), 300 flow.contrib.hooks.gcp_function_hook.GcfHook
subdags (airflow.models.DAG attribute), 368 method), 183
submit() (airflow.contrib.hooks.spark_submit_hook.SparkSubmitHook
update_state() (airflow.models.DagRun method),
method), 415 370
submit_run() (airflow.contrib.hooks.databricks_hook.DatabricksHook
upload() (airflow.contrib.hooks.gcs_hook.GoogleCloudStorageHook
method), 391 method), 214, 403
sync() (airflow.contrib.executors.mesos_executor.MesosExecutor
upload_function_zip() (air-
method), 418 flow.contrib.hooks.gcp_function_hook.GcfHook
sync() (airflow.executors.local_executor.LocalExecutor method), 183
method), 417 upstream_list (airflow.models.BaseOperator
sync() (airflow.executors.sequential_executor.SequentialExecutor attribute), 291, 363
method), 418 used_slots() (airflow.models.Pool method), 371
sync_to_db() (airflow.models.DAG method), 368 User (class in airflow.models), 375

T V
table_exists() (air- ValueCheckOperator (class in air-
flow.contrib.hooks.bigquery_hook.BigQueryHook flow.operators.check_operator), 301
method), 173, 391 Variable (class in airflow.models), 375
table_exists() (air- verify_integrity() (airflow.models.DagRun
flow.hooks.hive_hooks.HiveMetastoreHook method), 370
method), 381 VerticaHook (class in air-
tar_and_s3_upload() (air- flow.contrib.hooks.vertica_hook), 417
flow.contrib.hooks.sagemaker_hook.SageMakerHook VerticaOperator (class in air-
method), 149, 157, 409 flow.contrib.operators.vertica_operator),
TaskFail (class in airflow.models), 372 350
TaskInstance (class in airflow.models), 372 VerticaToHiveTransfer (class in air-
TaskReschedule (class in airflow.models), 375 flow.contrib.operators.vertica_to_hive), 350
template_fields (air-
flow.contrib.sensors.ftp_sensor.FTPSensor W
attribute), 353 wait() (airflow.contrib.hooks.gcp_dataproc_hook.DataProcHook
test_cycle() (airflow.models.DAG method), 368 method), 396

Index 435
Airflow Documentation, Release 1.10.2

WebHdfsSensor (class in air-

flow.sensors.web_hdfs_sensor), 304
write_batch_data() (air-
flow.contrib.hooks.aws_dynamodb_hook.AwsDynamoDBHook
method), 388

X
XCom (class in airflow.models), 375
xcom_pull() (airflow.models.BaseOperator method),
291, 363
xcom_pull() (airflow.models.TaskInstance method),
374
xcom_push() (airflow.models.BaseOperator method),
291, 363
xcom_push() (airflow.models.TaskInstance method),
374

436 Index