Package org.openmetadata.service.clients.pipeline.airflow

Class AirflowRESTClient

java.lang.Object

org.openmetadata.sdk.PipelineServiceClient

org.openmetadata.service.clients.pipeline.airflow.AirflowRESTClient

public class AirflowRESTClient
extends PipelineServiceClient

Field Summary

Fields

Modifier and Type	Field	Description
protected final HttpClient	client
protected final String	password
protected final URL	serviceURL
protected final String	username

Fields inherited from class org.openmetadata.sdk.PipelineServiceClient

APP_TRIGGER, APP_VALIDATE, AUTH_HEADER, CONTENT_HEADER, CONTENT_TYPE, DEPLOYMENT_ERROR, HEALTHY_STATUS, hostIp, ingestionIpInfoEnabled, pipelineServiceClientEnabled, SERVER_VERSION, STATUS_KEY, TRIGGER_ERROR, TYPE_TO_TASK, UNHEALTHY_STATUS

Constructor Summary

Constructors

Constructor	Description
AirflowRESTClient(PipelineServiceClientConfiguration config)

Method Summary

Modifier and Type	Method	Description
org.apache.http.client.utils.URIBuilder	buildURI(String path)
PipelineServiceClientResponse	deletePipeline(IngestionPipeline ingestionPipeline)
PipelineServiceClientResponse	deployPipeline(IngestionPipeline ingestionPipeline, ServiceEntityInterface service)
Map<String,String>	getLastIngestionLogs(IngestionPipeline ingestionPipeline, String after)
List<PipelineStatus>	getQueuedPipelineStatusInternal(IngestionPipeline ingestionPipeline)
PipelineServiceClientResponse	getServiceStatusInternal()	Scenarios handled here: 1.
PipelineServiceClientResponse	killIngestion(IngestionPipeline ingestionPipeline)
final HttpResponse<String>	post(String endpoint, String payload)
final HttpResponse<String>	post(String endpoint, String payload, boolean authenticate)
Map<String,String>	requestGetHostIp()
PipelineServiceClientResponse	runApplicationFlow(App application)
PipelineServiceClientResponse	runAutomationsWorkflow(Workflow workflow)
PipelineServiceClientResponse	runPipeline(IngestionPipeline ingestionPipeline, ServiceEntityInterface service)
PipelineServiceClientResponse	toggleIngestion(IngestionPipeline ingestionPipeline)
PipelineServiceClientResponse	validateAppRegistration(AppMarketPlaceDefinition appMarketPlaceDefinition)

Methods inherited from class org.openmetadata.sdk.PipelineServiceClient

buildHealthyStatus, buildUnhealthyStatus, buildVersionMismatchErrorMessage, getBasicAuthenticationHeader, getHostIp, getPlatform, getQueuedPipelineStatus, getServerVersion, getServiceStatus, getServiceStatusBackoff, getVersionFromString, setPlatform, validateServiceURL, validServerClientVersions

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

username

protected final String username

password

protected final String password

client

protected final HttpClient client

serviceURL

protected final URL serviceURL

Constructor Details

AirflowRESTClient

public AirflowRESTClient(PipelineServiceClientConfiguration config)
                  throws KeyStoreException

Throws:

KeyStoreException

Method Details

post

public final HttpResponse<String> post(String endpoint,
 String payload,
 boolean authenticate)
                                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

post

public final HttpResponse<String> post(String endpoint,
 String payload)
                                throws IOException,
InterruptedException

Throws:

IOException

InterruptedException

deployPipeline

public PipelineServiceClientResponse deployPipeline(IngestionPipeline ingestionPipeline,
 ServiceEntityInterface service)

Specified by:

deployPipeline in class PipelineServiceClient

deletePipeline

public PipelineServiceClientResponse deletePipeline(IngestionPipeline ingestionPipeline)

Specified by:

deletePipeline in class PipelineServiceClient

runPipeline

public PipelineServiceClientResponse runPipeline(IngestionPipeline ingestionPipeline,
 ServiceEntityInterface service)

Specified by:

runPipeline in class PipelineServiceClient

toggleIngestion

public PipelineServiceClientResponse toggleIngestion(IngestionPipeline ingestionPipeline)

Specified by:

toggleIngestion in class PipelineServiceClient

getQueuedPipelineStatusInternal

public List<PipelineStatus> getQueuedPipelineStatusInternal(IngestionPipeline ingestionPipeline)

Specified by:

getQueuedPipelineStatusInternal in class PipelineServiceClient

getServiceStatusInternal

public PipelineServiceClientResponse getServiceStatusInternal()

Scenarios handled here: 1. Failed to access Airflow APIs: No response from Airflow; APIs might not be installed 2. Auth failed when accessing Airflow APIs 3. Different versions between server and client

Specified by:

getServiceStatusInternal in class PipelineServiceClient

runAutomationsWorkflow

public PipelineServiceClientResponse runAutomationsWorkflow(Workflow workflow)

Specified by:

runAutomationsWorkflow in class PipelineServiceClient

runApplicationFlow

public PipelineServiceClientResponse runApplicationFlow(App application)

Specified by:

runApplicationFlow in class PipelineServiceClient

validateAppRegistration

public PipelineServiceClientResponse validateAppRegistration(AppMarketPlaceDefinition appMarketPlaceDefinition)

Specified by:

validateAppRegistration in class PipelineServiceClient

killIngestion

public PipelineServiceClientResponse killIngestion(IngestionPipeline ingestionPipeline)

Specified by:

killIngestion in class PipelineServiceClient

requestGetHostIp

public Map<String,String> requestGetHostIp()

Specified by:

requestGetHostIp in class PipelineServiceClient

getLastIngestionLogs

public Map<String,String> getLastIngestionLogs(IngestionPipeline ingestionPipeline,
 String after)

Specified by:

getLastIngestionLogs in class PipelineServiceClient

buildURI

public org.apache.http.client.utils.URIBuilder buildURI(String path)