/
azure.core.exceptions.ODataV4Format.yml
89 lines (85 loc) · 3.81 KB
/
azure.core.exceptions.ODataV4Format.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
### YamlMime:PythonClass
uid: azure.core.exceptions.ODataV4Format
name: ODataV4Format
fullName: azure.core.exceptions.ODataV4Format
module: azure.core.exceptions
inheritances:
- builtins.object
summary: "Class to describe OData V4 error format.\n\n[http://docs.oasis-open.org/odata/odata-json-format/v4.0/os/odata-json-format-v4.0-os.html#_Toc372793091](http://docs.oasis-open.org/odata/odata-json-format/v4.0/os/odata-json-format-v4.0-os.html#_Toc372793091)\n\
\nExample of JSON:\n\n<!-- literal_block {\"ids\": [], \"classes\": [], \"names\"\
: [], \"dupnames\": [], \"backrefs\": [], \"xml:space\": \"preserve\", \"force\"\
: false, \"language\": \"json\", \"highlight_args\": {}, \"linenos\": false} -->\n\
\n````json\n\n {\n \"error\": {\n \"code\": \"ValidationError\"\
,\n \"message\": \"One or more fields contain incorrect values: \",\n\
\ \"details\": [\n {\n \"code\": \"ValidationError\"\
,\n \"target\": \"representation\",\n \"message\"\
: \"Parsing error(s): String '' does not match regex pattern '^[^{}/ :]+(?: :\\\\\
d+)?$'.\n Path 'host', line 1, position 297.\"\n \
\ },\n {\n \"code\": \"ValidationError\",\n \
\ \"target\": \"representation\",\n \"message\"\
: \"Parsing error(s): The input OpenAPI file is not valid for the OpenAPI specificate\n\
\ https: //github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md\n\
\ (schema https://github.com/OAI/OpenAPI-Specification/blob/master/schemas/v2.0/schema.json).\"\
\n }\n ]\n }\n }\n ````"
constructor:
syntax: 'ODataV4Format(json_object: Mapping[str, Any])'
parameters:
- name: json_object
description: A Python dict representing a ODataV4 JSON
isRequired: true
types:
- <xref:dict>
variables:
- description: 'Its value is a service-defined error code.
This code serves as a sub-status for the HTTP error code specified in the response.'
name: ~.code
types:
- <xref:str>
- description: Human-readable, language-dependent representation of the error.
name: message
types:
- <xref:str>
- description: 'The target of the particular error (for example, the name of the property
in error).
This field is optional and may be None.'
name: target
types:
- <xref:str>
- description: 'Array of ODataV4Format instances that MUST contain name/value pairs
for code and message, and MAY contain a name/value pair for target, as described
above.'
name: details
types:
- <xref:list>[<xref:azure.core.exceptions.ODataV4Format>]
- description: 'An object. The contents of this object are service-defined.
Usually this object contains information that will help debug the service.'
name: innererror
types:
- <xref:dict>
methods:
- uid: azure.core.exceptions.ODataV4Format.message_details
name: message_details
summary: Return a detailed string of the error.
signature: message_details() -> str
return:
description: A string with the details of the error.
types:
- <xref:str>
attributes:
- uid: azure.core.exceptions.ODataV4Format.error
name: error
- uid: azure.core.exceptions.ODataV4Format.CODE_LABEL
name: CODE_LABEL
signature: CODE_LABEL = 'code'
- uid: azure.core.exceptions.ODataV4Format.DETAILS_LABEL
name: DETAILS_LABEL
signature: DETAILS_LABEL = 'details'
- uid: azure.core.exceptions.ODataV4Format.INNERERROR_LABEL
name: INNERERROR_LABEL
signature: INNERERROR_LABEL = 'innererror'
- uid: azure.core.exceptions.ODataV4Format.MESSAGE_LABEL
name: MESSAGE_LABEL
signature: MESSAGE_LABEL = 'message'
- uid: azure.core.exceptions.ODataV4Format.TARGET_LABEL
name: TARGET_LABEL
signature: TARGET_LABEL = 'target'