Batch#

class Batch(name=None, start_time=None, end_time=None, size=None, success_count=None, failed_count=None, completion_status=None, execution_status=None, should_stop_on_error=None, ext_id=None, links=None, tenant_id=None, *args, **kwargs)#

Bases: ExternalizableAbstractModel

A model that represents a Batch resource.

Parameters:

  • name (max=256 chars) – (name) An user friendly name of the batch.

  • start_time – (start_time) The execution start time of the batch. The value will be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would imply that the batch started execution at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html

  • end_time – (end_time) The completion time of the batch. The value will be in extended ISO-8601 format. For example, end time of 2022-04-23T01:23:45.678+09:00 would imply that the batch completed its execution at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html

  • size – (size) The total number of elements submitted for processing in the batch.

  • success_count – (success_count) The total number of elements successfully processed in the batch.

  • failed_count – (failed_count) The total number of elements that failed to be processed in the batch.

  • completion_status – (completion_status)

  • execution_status – (execution_status)

  • should_stop_on_error – (should_stop_on_error) A flag indicating whether the batch procession should halt or continue when an error response is received from the server during the execution of a batch chunk

property completion_status#
Type:

BatchCompletionStatus

property end_time#

The completion time of the batch. The value will be in extended ISO-8601 format. For example, end time of 2022-04-23T01:23:45.678+09:00 would imply that the batch completed its execution at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html

Type:

datetime

property execution_status#
Type:

BatchExecutionStatus

property failed_count#

The total number of elements that failed to be processed in the batch.

Type:

int

property name#

An user friendly name of the batch.

Type:

str

property should_stop_on_error#

A flag indicating whether the batch procession should halt or continue when an error response is received from the server during the execution of a batch chunk

Type:

bool

property size#

The total number of elements submitted for processing in the batch.

Type:

int

property start_time#

The execution start time of the batch. The value will be in extended ISO-8601 format. For example, start time of 2022-04-23T01:23:45.678+09:00 would imply that the batch started execution at 1:23:45.678 on the 23rd of April 2022. Details around ISO-8601 format can be found at https://www.iso.org/standard/70907.html

Type:

datetime

property success_count#

The total number of elements successfully processed in the batch.

Type:

int

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model