airflow.providers.salesforce.operators.salesforce_apex_rest¶

Classes¶

SalesforceApexRestOperator

Execute a APEX Rest API action.

Module Contents¶

class airflow.providers.salesforce.operators.salesforce_apex_rest.SalesforceApexRestOperator(*, endpoint, method='GET', payload, salesforce_conn_id='salesforce_default', **kwargs)[source]¶

Bases: airflow.models.BaseOperator

Execute a APEX Rest API action.

See also

For more information on how to use this operator, take a look at the guide: SalesforceApexRestOperator

Parameters:

endpoint (str) – The REST endpoint for the request.
method (str) – HTTP method for the request (default GET)
payload (dict) – A dict of parameters to send in a POST / PUT request
salesforce_conn_id (str) – The Salesforce Connection id.

endpoint[source]¶

method = 'GET'[source]¶

payload[source]¶

salesforce_conn_id = 'salesforce_default'[source]¶

execute(context)[source]¶

Make an HTTP request to an APEX REST endpoint and pushes results to xcom.

Parameters:: context (airflow.sdk.definitions.context.Context) – The task context during execution.
Returns:: Apex response
Return type:: dict