com.azure.core.http.HttpPipelineCallContext.yml

### YamlMime:JavaType
uid: "com.azure.core.http.HttpPipelineCallContext"
fullName: "com.azure.core.http.HttpPipelineCallContext"
name: "HttpPipelineCallContext"
nameWithType: "HttpPipelineCallContext"
summary: "Represents the context for a single HTTP request in the HTTP pipeline."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  methodsRef:
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
  - "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **HttpPipelineCallContext**"
methods:
- uid: "com.azure.core.http.HttpPipelineCallContext.getContext()"
  fullName: "com.azure.core.http.HttpPipelineCallContext.getContext()"
  name: "getContext()"
  nameWithType: "HttpPipelineCallContext.getContext()"
  summary: "Gets the context associated to the HTTP call."
  syntax: "public Context getContext()"
  desc: "Gets the context associated to the HTTP call.\n\nThe returned context is a snapshot of the data stored in this http pipeline call context."
  returns:
    description: "The context associated to the HTTP call."
    type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.HttpPipelineCallContext.getData(java.lang.String)"
  fullName: "com.azure.core.http.HttpPipelineCallContext.getData(String key)"
  name: "getData(String key)"
  nameWithType: "HttpPipelineCallContext.getData(String key)"
  summary: "Gets a value with the given key stored in the context."
  parameters:
  - description: "The key to find in the context."
    name: "key"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public Optional<Object> getData(String key)"
  desc: "Gets a value with the given key stored in the context."
  returns:
    description: "The value associated with the key."
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Optional.html\">Optional</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>&gt;"
- uid: "com.azure.core.http.HttpPipelineCallContext.getHttpRequest()"
  fullName: "com.azure.core.http.HttpPipelineCallContext.getHttpRequest()"
  name: "getHttpRequest()"
  nameWithType: "HttpPipelineCallContext.getHttpRequest()"
  summary: "Gets the HTTP request."
  syntax: "public HttpRequest getHttpRequest()"
  desc: "Gets the HTTP request."
  returns:
    description: "The HTTP request."
    type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.core.http.HttpPipelineCallContext.setData(java.lang.String,java.lang.Object)"
  fullName: "com.azure.core.http.HttpPipelineCallContext.setData(String key, Object value)"
  name: "setData(String key, Object value)"
  nameWithType: "HttpPipelineCallContext.setData(String key, Object value)"
  summary: "Stores a key-value data in the context."
  parameters:
  - description: "The key to add."
    name: "key"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The value to associate with that key."
    name: "value"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
  syntax: "public void setData(String key, Object value)"
  desc: "Stores a key-value data in the context."
- uid: "com.azure.core.http.HttpPipelineCallContext.setHttpRequest(com.azure.core.http.HttpRequest)"
  fullName: "com.azure.core.http.HttpPipelineCallContext.setHttpRequest(HttpRequest request)"
  name: "setHttpRequest(HttpRequest request)"
  nameWithType: "HttpPipelineCallContext.setHttpRequest(HttpRequest request)"
  summary: "Sets the HTTP request object in the context."
  parameters:
  - description: "The HTTP request."
    name: "request"
    type: "<xref href=\"com.azure.core.http.HttpRequest?alt=com.azure.core.http.HttpRequest&text=HttpRequest\" data-throw-if-not-resolved=\"False\" />"
  syntax: "public HttpPipelineCallContext setHttpRequest(HttpRequest request)"
  desc: "Sets the HTTP request object in the context."
  returns:
    description: "The updated HttpPipelineCallContext object."
    type: "<xref href=\"com.azure.core.http.HttpPipelineCallContext?alt=com.azure.core.http.HttpPipelineCallContext&text=HttpPipelineCallContext\" data-throw-if-not-resolved=\"False\" />"
type: "class"
desc: "Represents the context for a single HTTP request in the HTTP pipeline.\n\nThis class encapsulates the HTTP request and the associated context data. The context data is a key-value store that can be used to pass additional information along with the HTTP request.\n\nIt provides methods to get and set the HTTP request, get the context data, and get and set data in the context using a key.\n\nThis class is useful when you want to send an HTTP request through the HTTP pipeline and need to associate additional data with the request."
metadata: {}
package: "com.azure.core.http"
artifact: com.azure:azure-core:1.49.0