Field | Description |
payload | Binary or dictionary payload to submit with the request. |
metadata.requestId | Required. A request ID (string) to include in the response. |
metadata.http.method | Required. The HTTP method to use: GET, POST, PUT or DELETE. |
metadata.http.path | Required. URI (string) on the host to submit the request to. |
metadata.http.headers.content-encoding | The Content-Encoding to be applied to the entity-body. This can be one of the following: gzip, deflate or identity. When an unsupported content encoding is specified, the HTTP request is ignored and an error message is logged. |
metadata.http.headers.keyname | An HTTP header (string) to set in the request. See also
Handling HTTP headers. |
metadata.http.cookies.keyname | An HTTP cookie (string) to set in the request. See also
Dealing with cookies. |
metadata.http.queryString.keyname | An HTTP query parameter (string) to be encoded as part of the path in the URI. See also
Providing HTTP query parameters. |
metadata.charset | Describes the format of the payload (string). See also
Handling HTTP headers. |
metadata.contentType | Describes the format of the payload (string). See also
Handling HTTP headers. |
metadata.http.form.name.contentType | The media type of the form data. See also
Handling HTML form encoding. |
metadata.http.form.name.charset | The encoding of the form data. See also
Handling HTML form encoding. |
metadata.http.form.name.filename | The file name of the form data. See also
Handling HTML form encoding. |
Field | Description |
payload | Binary payload received in the response. May be an empty buffer if no response, or null in some error cases. |
metadata.requestId | The request ID (string) from the request. Always present in the response. |
metadata.http.method | The HTTP method from the request: GET, POST, PUT or DELETE. Always present in the response. |
metadata.http.path | The HTTP path (string) from the request. Always present in the response. |
metadata.http.statusCode | HTTP status code (integer). Code 200 indicates success. All other codes indicate errors. Always present in the response. See also
Distinguishing response types. |
metadata.http.statusReason | HTTP status reason (string). Always present in the response. |
metadata.http.headers.keyname | The HTTP header (string) returned by the response. See also
Handling HTTP headers. |
metadata.http.cookies.keyname | An HTTP cookie (string) being set by the response. Only present if this is in the response headers. See also
Dealing with cookies. |
metadata.charset | Describes the format of the payload (string). Only present if this is in the response headers. See also
Handling HTTP headers. |
metadata.contentType | Describes the format of the payload (string). Only present if this is in the response headers. See also
Handling HTTP headers. |