azure-docs-sdk-java/docs-ref-autogen/com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.yml

### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse"
fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse"
name: "HttpResponse"
nameWithType: "HttpResponse"
summary: "An HTTPS response."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedMembers:
- "java.lang.Object.clone()"
- "java.lang.Object.equals(java.lang.Object)"
- "java.lang.Object.finalize()"
- "java.lang.Object.getClass()"
- "java.lang.Object.hashCode()"
- "java.lang.Object.notify()"
- "java.lang.Object.notifyAll()"
- "java.lang.Object.toString()"
- "java.lang.Object.wait()"
- "java.lang.Object.wait(long)"
- "java.lang.Object.wait(long,int)"
syntax: "public class HttpResponse"
constructors:
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.HttpResponse()"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.HttpResponse()"
  name: "HttpResponse()"
  nameWithType: "HttpResponse.HttpResponse()"
  modifiers:
  - "protected"
  syntax: "protected HttpResponse()"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.HttpResponse(int,byte[],java.util.Map<java.lang.String,java.util.List<java.lang.String>>,byte[])"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.HttpResponse(int status, byte[] body, Map<String,List<String>> headerFields, byte[] errorReason)"
  name: "HttpResponse(int status, byte[] body, Map<String,List<String>> headerFields, byte[] errorReason)"
  nameWithType: "HttpResponse.HttpResponse(int status, byte[] body, Map<String,List<String>> headerFields, byte[] errorReason)"
  summary: "Constructor."
  parameters:
  - description: "The HTTPS status code."
    name: "status"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  - description: "The response body."
    name: "body"
    type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
  - description: "The map of header field names and the values associated with the field name."
    name: "headerFields"
    type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
  - description: "The error reason."
    name: "errorReason"
    type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
  syntax: "public HttpResponse(int status, byte[] body, Map<String,List<String>> headerFields, byte[] errorReason)"
  desc: "Constructor."
fields:
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.body"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.body"
  name: "body"
  nameWithType: "HttpResponse.body"
  modifiers:
  - "protected"
  - "final"
  field:
    type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
  syntax: "protected final byte[] body"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.errorReason"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.errorReason"
  name: "errorReason"
  nameWithType: "HttpResponse.errorReason"
  modifiers:
  - "protected"
  - "final"
  field:
    type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
  syntax: "protected final byte[] errorReason"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.headerFields"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.headerFields"
  name: "headerFields"
  nameWithType: "HttpResponse.headerFields"
  modifiers:
  - "protected"
  - "final"
  field:
    type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "protected final Map<String,String> headerFields"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.status"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.status"
  name: "status"
  nameWithType: "HttpResponse.status"
  modifiers:
  - "protected"
  - "final"
  field:
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "protected final int status"
methods:
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.canonicalizeFieldName(java.lang.String)"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.canonicalizeFieldName(String field)"
  name: "canonicalizeFieldName(String field)"
  nameWithType: "HttpResponse.canonicalizeFieldName(String field)"
  modifiers:
  - "protected"
  - "static"
  parameters:
  - name: "field"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "protected static String canonicalizeFieldName(String field)"
  returns:
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.flattenValuesList(java.util.List<java.lang.String>)"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.flattenValuesList(List<String> values)"
  name: "flattenValuesList(List<String> values)"
  nameWithType: "HttpResponse.flattenValuesList(List<String> values)"
  modifiers:
  - "protected"
  - "static"
  parameters:
  - name: "values"
    type: "<xref href=\"java.util.List?alt=java.util.List&text=List\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
  syntax: "protected static String flattenValuesList(List<String> values)"
  returns:
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getBody()"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getBody()"
  name: "getBody()"
  nameWithType: "HttpResponse.getBody()"
  summary: "Getter for the response body."
  syntax: "public byte[] getBody()"
  desc: "Getter for the response body."
  returns:
    description: "The response body."
    type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getErrorReason()"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getErrorReason()"
  name: "getErrorReason()"
  nameWithType: "HttpResponse.getErrorReason()"
  summary: "Getter for the error reason."
  syntax: "public byte[] getErrorReason()"
  desc: "Getter for the error reason."
  returns:
    description: "The error reason."
    type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getHeaderField(java.lang.String)"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getHeaderField(String field)"
  name: "getHeaderField(String field)"
  nameWithType: "HttpResponse.getHeaderField(String field)"
  summary: "Getter for a header field."
  parameters:
  - description: "the header field name."
    name: "field"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public String getHeaderField(String field)"
  desc: "Getter for a header field."
  returns:
    description: "the header field value. If multiple values are present, they are\n returned as a comma-separated list according to RFC2616."
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getHeaderFields()"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getHeaderFields()"
  name: "getHeaderFields()"
  nameWithType: "HttpResponse.getHeaderFields()"
  summary: "Getter for the header fields."
  syntax: "public Map<String,String> getHeaderFields()"
  desc: "Getter for the header fields."
  returns:
    description: "The copy of the header fields for this response."
    type: "<xref href=\"java.util.Map?alt=java.util.Map&text=Map\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />,<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getStatus()"
  fullName: "com.microsoft.azure.sdk.iot.service.transport.http.HttpResponse.getStatus()"
  name: "getStatus()"
  nameWithType: "HttpResponse.getStatus()"
  summary: "Getter for the HTTPS status code."
  syntax: "public int getStatus()"
  desc: "Getter for the HTTPS status code."
  returns:
    description: "The HTTPS status code."
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "An HTTPS response. Contains the status code, body, header fields, and error reason (if any)."
metadata: {}
package: "com.microsoft.azure.sdk.iot.service.transport.http"
artifact: com.microsoft.azure.sdk.iot:iot-service-client:1.30.0