-
Notifications
You must be signed in to change notification settings - Fork 234
/
azure.functions.HttpResponse.yml
68 lines (66 loc) · 1.8 KB
/
azure.functions.HttpResponse.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
### YamlMime:PythonClass
uid: azure.functions.HttpResponse
name: HttpResponse
fullName: azure.functions.HttpResponse
module: azure.functions
inheritances:
- azure.functions._abc.HttpResponse
summary: An HTTP response object.
constructor:
syntax: HttpResponse(body=None, *, status_code=None, headers=None, mimetype=None,
charset=None)
parameters:
- name: body
description: Optional response body.
defaultValue: None
types:
- <xref:<xref:str/bytes>>
- name: status_code
description: Response status code. If not specified, defaults to 200.
isRequired: true
types:
- <xref:int>
- name: headers
description: An optional mapping containing response HTTP headers.
isRequired: true
types:
- <xref:dict>
- name: mimetype
description: 'An optional response MIME type. If not specified, defaults to
`''text/plain''`.'
isRequired: true
types:
- <xref:str>
- name: charset
description: 'Response content text encoding. If not specified, defaults to
`''utf-8''`.'
isRequired: true
types:
- <xref:str>
keywordOnlyParameters:
- name: status_code
isRequired: true
- name: headers
isRequired: true
- name: mimetype
isRequired: true
- name: charset
isRequired: true
methods:
- uid: azure.functions.HttpResponse.get_body
name: get_body
summary: Response body as a bytes object.
signature: get_body() -> bytes
attributes:
- uid: azure.functions.HttpResponse.charset
name: charset
summary: Response text encoding.
- uid: azure.functions.HttpResponse.headers
name: headers
summary: A dictionary of response HTTP headers.
- uid: azure.functions.HttpResponse.mimetype
name: mimetype
summary: Response MIME type.
- uid: azure.functions.HttpResponse.status_code
name: status_code
summary: Response status code.