azure.batch.models.ExitConditions.yml

### YamlMime:PythonClass
uid: azure.batch.models.ExitConditions
name: ExitConditions
fullName: azure.batch.models.ExitConditions
module: azure.batch.models
inheritances:
- msrest.serialization.Model
summary: Specifies how the Batch service should respond when the Task completes.
constructor:
  syntax: ExitConditions(*, exit_codes=None, exit_code_ranges=None, pre_processing_error=None,
    file_upload_error=None, default=None, **kwargs)
  parameters:
  - name: exit_codes
    isRequired: true
    types:
    - <xref:list>[<xref:azure.batch.models.ExitCodeMapping>]
  - name: exit_code_ranges
    isRequired: true
    types:
    - <xref:list>[<xref:azure.batch.models.ExitCodeRangeMapping>]
  - name: pre_processing_error
    description: 'How the Batch service should respond if the

      Task fails to start due to an error.'
    isRequired: true
    types:
    - <xref:azure.batch.models.ExitOptions>
  - name: file_upload_error
    description: 'How the Batch service should respond if a file

      upload error occurs. If the Task exited with an exit code that was

      specified via exitCodes or exitCodeRanges, and then encountered a file

      upload error, then the action specified by the exit code takes precedence.'
    isRequired: true
    types:
    - <xref:azure.batch.models.ExitOptions>
  - name: default
    description: 'How the Batch service should respond if the Task fails

      with an exit condition not covered by any of the other properties. This

      value is used if the Task exits with any nonzero exit code not listed in

      the exitCodes or exitCodeRanges collection, with a pre-processing error if

      the preProcessingError property is not present, or with a file upload

      error if the fileUploadError property is not present. If you want

      non-default behavior on exit code 0, you must list it explicitly using the

      exitCodes or exitCodeRanges collection.'
    isRequired: true
    types:
    - <xref:azure.batch.models.ExitOptions>
  keywordOnlyParameters:
  - name: exit_codes
    isRequired: true
  - name: exit_code_ranges
    isRequired: true
  - name: pre_processing_error
    isRequired: true
  - name: file_upload_error
    isRequired: true
  - name: default
    isRequired: true
methods:
- uid: azure.batch.models.ExitConditions.as_dict
  name: as_dict
  summary: "Return a dict that can be JSONify using json.dump.\n\nAdvanced usage might\
    \ optionally use a callback as parameter:\n\nKey is the attribute name used in\
    \ Python. Attr_desc\nis a dict of metadata. Currently contains 'type' with the\n\
    msrest type and 'key' with the RestAPI encoded key.\nValue is the current value\
    \ in this object.\n\nThe string returned will be used to serialize the key.\n\
    If the return type is a list, this is considered hierarchical\nresult dict.\n\n\
    See the three examples in this file:\n\n* attribute_transformer \n\n* full_restapi_key_transformer\
    \ \n\n* last_restapi_key_transformer \n\nIf you want XML serialization, you can\
    \ pass the kwargs is_xml=True."
  signature: as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>,
    **kwargs)
  parameters:
  - name: key_transformer
    description: A key transformer function.
    types:
    - <xref:function>
  - name: keep_readonly
    defaultValue: 'True'
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.batch.models.ExitConditions.deserialize
  name: deserialize
  summary: Parse a str using the RestAPI syntax and return a model.
  signature: deserialize(data, content_type=None)
  parameters:
  - name: data
    description: A str using RestAPI structure. JSON by default.
    isRequired: true
    types:
    - <xref:str>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.batch.models.ExitConditions.enable_additional_properties_sending
  name: enable_additional_properties_sending
  signature: enable_additional_properties_sending()
- uid: azure.batch.models.ExitConditions.from_dict
  name: from_dict
  summary: 'Parse a dict using given key extractor return a model.


    By default consider key

    extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor

    and last_rest_key_case_insensitive_extractor)'
  signature: from_dict(data, key_extractors=None, content_type=None)
  parameters:
  - name: data
    description: A dict using RestAPI structure
    isRequired: true
    types:
    - <xref:dict>
  - name: content_type
    description: JSON by default, set application/xml if XML.
    defaultValue: None
    types:
    - <xref:str>
  - name: key_extractors
    defaultValue: None
  return:
    description: An instance of this model
  exceptions:
  - type: DeserializationError if something went wrong
- uid: azure.batch.models.ExitConditions.is_xml_model
  name: is_xml_model
  signature: is_xml_model()
- uid: azure.batch.models.ExitConditions.serialize
  name: serialize
  summary: 'Return the JSON that would be sent to azure from this model.


    This is an alias to *as_dict(full_restapi_key_transformer, keep_readonly=False)*.


    If you want XML serialization, you can pass the kwargs is_xml=True.'
  signature: serialize(keep_readonly=False, **kwargs)
  parameters:
  - name: keep_readonly
    description: If you want to serialize the readonly attributes
    defaultValue: 'False'
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.batch.models.ExitConditions.validate
  name: validate
  summary: Validate this model recursively and return a list of ValidationError.
  signature: validate()
  return:
    description: A list of validation error
    types:
    - <xref:list>