### YamlMime:JavaType
uid: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest"
fullName: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest"
name: "HttpRequest"
nameWithType: "HttpRequest"
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "<xref href=\"java.lang.Object?alt=java.lang.Object&text=Object\" data-throw-if-not-resolved=\"False\" />"
  methodsRef:
  - "<xref href=\"java.lang.Object.clone()?alt=java.lang.Object.clone&text=clone\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.equals(java.lang.Object)?alt=java.lang.Object.equals&text=equals\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.finalize()?alt=java.lang.Object.finalize&text=finalize\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.getClass()?alt=java.lang.Object.getClass&text=getClass\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.hashCode()?alt=java.lang.Object.hashCode&text=hashCode\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notify()?alt=java.lang.Object.notify&text=notify\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.notifyAll()?alt=java.lang.Object.notifyAll&text=notifyAll\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.toString()?alt=java.lang.Object.toString&text=toString\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait()?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
  - "<xref href=\"java.lang.Object.wait(long,int)?alt=java.lang.Object.wait&text=wait\" data-throw-if-not-resolved=\"False\" />"
syntax: "public class **HttpRequest**"
constructors:
- uid: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.HttpRequest()"
  fullName: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.HttpRequest()"
  name: "HttpRequest()"
  nameWithType: "HttpRequest.HttpRequest()"
  modifiers:
  - "protected"
  syntax: "protected HttpRequest()"
- uid: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.HttpRequest(java.net.URL,com.microsoft.azure.sdk.iot.deps.transport.http.HttpMethod,byte[])"
  fullName: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.HttpRequest(URL url, HttpMethod method, byte[] body)"
  name: "HttpRequest(URL url, HttpMethod method, byte[] body)"
  nameWithType: "HttpRequest.HttpRequest(URL url, HttpMethod method, byte[] body)"
  summary: "Constructor."
  parameters:
  - description: "The URL for the request."
    name: "url"
    type: "<xref href=\"java.net.URL?alt=java.net.URL&text=URL\" data-throw-if-not-resolved=\"False\" />"
  - description: "The HTTPS request method (i.e. GET)."
    name: "method"
    type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.transport.http.HttpMethod?alt=com.microsoft.azure.sdk.iot.deps.transport.http.HttpMethod&text=HttpMethod\" data-throw-if-not-resolved=\"False\" />"
  - description: "The request body. Must be an array of size 0 if the request method is GET or DELETE."
    name: "body"
    type: "<xref href=\"byte?alt=byte&text=byte\" data-throw-if-not-resolved=\"False\" />[]"
  syntax: "public HttpRequest(URL url, HttpMethod method, byte[] body)"
  exceptions:
  - description: "This exception thrown if an IOException occurs\n in setting up the HTTPS connection."
    type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
  desc: "Constructor. Takes a URL as an argument and returns an HTTPS request that is ready to be sent."
fields:
- uid: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.connection"
  fullName: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.connection"
  name: "connection"
  nameWithType: "HttpRequest.connection"
  summary: "The underlying HTTPS connection stream."
  modifiers:
  - "protected"
  - "final"
  field:
    type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.transport.http.HttpConnection?alt=com.microsoft.azure.sdk.iot.deps.transport.http.HttpConnection&text=HttpConnection\" data-throw-if-not-resolved=\"False\" />"
  syntax: "protected final HttpConnection connection"
  desc: "The underlying HTTPS connection stream."
methods:
- uid: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.send()"
  fullName: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.send()"
  name: "send()"
  nameWithType: "HttpRequest.send()"
  summary: "Executes the HTTPS request."
  syntax: "public HttpResponse send()"
  exceptions:
  - description: "This exception thrown if the connection could not be\n established, or the input/output streams could not be accessed."
    type: "<xref href=\"java.io.IOException?alt=java.io.IOException&text=IOException\" data-throw-if-not-resolved=\"False\" />"
  desc: "Executes the HTTPS request."
  returns:
    description: "The HTTPS response."
    type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.transport.http.HttpResponse?alt=com.microsoft.azure.sdk.iot.deps.transport.http.HttpResponse&text=HttpResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.setHeaderField(java.lang.String,java.lang.String)"
  fullName: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.setHeaderField(String field, String value)"
  name: "setHeaderField(String field, String value)"
  nameWithType: "HttpRequest.setHeaderField(String field, String value)"
  summary: "Sets the header field to the given value."
  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\" />"
  - description: "The header field value."
    name: "value"
    type: "<xref href=\"java.lang.String?alt=java.lang.String&text=String\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public HttpRequest setHeaderField(String field, String value)"
  desc: "Sets the header field to the given value."
  returns:
    description: "The object itself, for fluent setting."
    type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest?alt=com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.setReadTimeoutMillis(int)"
  fullName: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.setReadTimeoutMillis(int timeout)"
  name: "setReadTimeoutMillis(int timeout)"
  nameWithType: "HttpRequest.setReadTimeoutMillis(int timeout)"
  summary: "Sets the read timeout, in milliseconds, for the request."
  parameters:
  - description: "The read timeout."
    name: "timeout"
    type: "<xref href=\"int?alt=int&text=int\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public HttpRequest setReadTimeoutMillis(int timeout)"
  desc: "Sets the read timeout, in milliseconds, for the request. The read timeout is the number of milliseconds after the server receives a request and before the server sends data back."
  returns:
    description: "The object itself, for fluent setting."
    type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest?alt=com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.setSSLContext(javax.net.ssl.SSLContext)"
  fullName: "com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest.setSSLContext(SSLContext sslContext)"
  name: "setSSLContext(SSLContext sslContext)"
  nameWithType: "HttpRequest.setSSLContext(SSLContext sslContext)"
  parameters:
  - name: "sslContext"
    type: "<xref href=\"javax.net.ssl.SSLContext?alt=javax.net.ssl.SSLContext&text=SSLContext\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public HttpRequest setSSLContext(SSLContext sslContext)"
  returns:
    type: "<xref href=\"com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest?alt=com.microsoft.azure.sdk.iot.deps.transport.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
type: "class"
metadata: {}
package: "com.microsoft.azure.sdk.iot.deps.transport.http"
artifact: com.microsoft.azure.sdk.iot:iot-deps:0.12.0