azure.batch.models.BatchError.yml

### YamlMime:PythonClass
uid: azure.batch.models.BatchError
name: BatchError
fullName: azure.batch.models.BatchError
module: azure.batch.models
summary: 'An error response received from the Azure Batch service.


  All required parameters must be populated in order to send to server.'
constructor:
  syntax: 'BatchError(*args: Any, **kwargs: Any)'
variables:
- description: 'An identifier for the error. Codes are invariant and are intended
    to be consumed

    programmatically. Required.'
  name: code
  types:
  - <xref:str>
- description: 'A message describing the error, intended to be suitable for display
    in a user

    interface.'
  name: message
  types:
  - <xref:azure.batch.models.BatchErrorMessage>
- description: 'A collection of key-value pairs containing additional details about
    the

    error.'
  name: values_property
  types:
  - <xref:list>[<xref:azure.batch.models.BatchErrorDetail>]
methods:
- uid: azure.batch.models.BatchError.as_dict
  name: as_dict
  summary: Return a dict that can be JSONify using json.dump.
  signature: 'as_dict(*, exclude_readonly: bool = False) -> Dict[str, Any]'
  keywordOnlyParameters:
  - name: exclude_readonly
    description: Whether to remove the readonly properties.
    types:
    - <xref:bool>
  return:
    description: A dict JSON compatible object
    types:
    - <xref:dict>
- uid: azure.batch.models.BatchError.clear
  name: clear
  signature: clear() -> None
- uid: azure.batch.models.BatchError.copy
  name: copy
  signature: copy() -> Model
- uid: azure.batch.models.BatchError.get
  name: get
  signature: 'get(key: str, default: Any = None) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
    defaultValue: None
- uid: azure.batch.models.BatchError.items
  name: items
  signature: items() -> ItemsView[str, Any]
- uid: azure.batch.models.BatchError.keys
  name: keys
  signature: keys() -> KeysView[str]
- uid: azure.batch.models.BatchError.pop
  name: pop
  signature: 'pop(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchError.popitem
  name: popitem
  signature: popitem() -> Tuple[str, Any]
- uid: azure.batch.models.BatchError.setdefault
  name: setdefault
  signature: 'setdefault(key: str, default: ~typing.Any = <object object>) -> Any'
  parameters:
  - name: key
    isRequired: true
  - name: default
- uid: azure.batch.models.BatchError.update
  name: update
  signature: 'update(*args: Any, **kwargs: Any) -> None'
- uid: azure.batch.models.BatchError.values
  name: values
  signature: values() -> ValuesView[Any]
attributes:
- uid: azure.batch.models.BatchError.code
  name: code
  summary: 'An identifier for the error. Codes are invariant and are intended to be
    consumed

    programmatically. Required.'
  signature: 'code: str'
- uid: azure.batch.models.BatchError.message
  name: message
  summary: A message describing the error, intended to be suitable for display in
    a user interface.
  signature: 'message: _models.BatchErrorMessage | None'
- uid: azure.batch.models.BatchError.values_property
  name: values_property
  summary: A collection of key-value pairs containing additional details about the
    error.
  signature: 'values_property: List[_models.BatchErrorDetail] | None'