Skip to content

Latest commit

 

History

History
43 lines (34 loc) · 4.92 KB

File metadata and controls

43 lines (34 loc) · 4.92 KB

GetBatchQueryJobResponse

Properties

Name Type Description Notes
batches List[GetBatchQueryResponse] A JSON array object that contains a list of batch objects. [optional]
encrypted BatchQueryEncrypted [optional]
format BatchQueryFormat [optional]
id str The job ID created for the AQuA API request. The job ID can be used for querying for the query status. The ID exists only if the JSON request can be parsed and validated successfully. Otherwise, the job ID is null. [optional]
name str The name of the job. 32 character limit. [optional]
partner str The partner field indicates the unique ID of a data integration partner. The dropdown list of this field displays partner IDs for the past thirty days. It must be used together with &quot;project&quot; field to uniquely identify a data integration target. For example, if a continuous AQuA session is to retrieve data incrementally for a Salesforce.com Org 00170000011K3Ub, you can use partner as &quot;Salesforce&quot;, and &quot;project&quot; as &quot;00170000011K3Ub.&quot; This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. Note: Zuora highly recommends you use the stateless mode instead of the stateful mode to extract bulk data. See <a href=&quot;https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/Bulk_data__extraction_from_Zuora_using_AQuA\" target=&quot;_blank&quot;>Bulk data extraction from Zuora using AQuA</a> for best practices. Note: Submit a request at <a href=&quot;http://support.zuora.com\" target=&quot;_blank&quot;>Zuora Global Support</a> to obtain a partner ID. [optional]
project str The project field contains the unique ID of a data integration project for a particular partner. The dropdown list of this field displays project IDs for the past thirty days. This field must be used together with partner field to uniquely identify a data integration target. This field is required only if you are using AQuA in stateful mode. Otherwise, if you are using AQuA in stateless mode, partner field can be null. [optional]
offset float This field specifies the time offset for AQuA queries in stateful mode. It is an integer in the range 0 to 3,600 seconds. For example, if you set this field to 600 seconds and you post a query in stateful mode at 2:00 AM, it will query against data created or updated between the completion time of the previous query and 1:50 AM. The value of this field will override the value you configured in Settings > Administration > AQuA API Stateful Mode Time Offset. [optional]
use_last_completed_job_queries bool If this flag is set to `true`, then all the previous queries are merged with existing queries. If the flag is set to `false`, then the previous queries are ignored, and only the new query is executed. [optional]
start_time str The start time of the query. [optional]
status BatchQueryStatus [optional]
localized_status BatchQueryStatus [optional]
version str The API version you want to use. The supported versions are as follows: - `1.1`. It supports both modes - `1.0`. Default. It supports stateless modes only. See <a href=&quot;https://knowledgecenter.zuora.com/Zuora_Central_Platform/API/AB_Aggregate_Query_API/BA_Stateless_and_Stateful_Modes\" target=&quot;_blank&quot;>Stateless and stateful modes</a> for more information. [optional]
error_code str The error code used to identify the failure reason. [optional]
message str The error message used to describe the failure reason detail. [optional]

Example

from zuora_sdk.models.get_batch_query_job_response import GetBatchQueryJobResponse

# TODO update the JSON string below
json = "{}"
# create an instance of GetBatchQueryJobResponse from a JSON string
get_batch_query_job_response_instance = GetBatchQueryJobResponse.from_json(json)
# print the JSON string representation of the object
print(GetBatchQueryJobResponse.to_json())

# convert the object into a dict
get_batch_query_job_response_dict = get_batch_query_job_response_instance.to_dict()
# create an instance of GetBatchQueryJobResponse from a dict
get_batch_query_job_response_from_dict = GetBatchQueryJobResponse.from_dict(get_batch_query_job_response_dict)

[Back to Model list] [Back to API list] [Back to README]