BatchSpecMetadata#

class BatchSpecMetadata(action=None, name=None, uri=None, should_stop_on_error=False, chunk_size=1, *args, **kwargs)#

Bases: object

The metadata section on the input specification for performing the batch operation.

Parameters:

  • action (required) – (action)

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

  • uri (required) – (uri) The absolute URI of the API operation on which batching will be performed.

  • 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 (Default False)

  • chunk_size (min=1,) – (chunk_size) The chunk size to use during the batching operation. If not specified a minimum value of 1 would be chosen. (Default 1)

property action#
Type:

ActionType

property chunk_size#

The chunk size to use during the batching operation. If not specified a minimum value of 1 would be chosen.

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

to_dict()#

Returns the model properties as a dictionary

to_str()#

Returns the string representation of the model

property uri#

The absolute URI of the API operation on which batching will be performed.

Type:

str