WebRequest (com.contrastsecurity:java-sarif 1.0 API)

java.lang.Object
- com.contrastsecurity.sarif.WebRequest

```
public class WebRequest
extends Object
```
Describes an HTTP request.

Constructor Summary

Constructors
Constructor and Description

WebRequest()

Constructors
Constructor and Description
`WebRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(Object other)`
`ArtifactContent`	`getBody()` Represents the contents of an artifact.
`Headers`	`getHeaders()` The request headers.
`Integer`	`getIndex()` The index within the run.webRequests array of the request object associated with this result.
`String`	`getMethod()` The HTTP method.
`Parameters`	`getParameters()` The request parameters.
`PropertyBag`	`getProperties()` Key/value pairs that provide additional information about the object.
`String`	`getProtocol()` The request protocol.
`String`	`getTarget()` The target of the request.
`String`	`getVersion()` The request version.
`int`	`hashCode()`
`void`	`setBody(ArtifactContent body)` Represents the contents of an artifact.
`void`	`setHeaders(Headers headers)` The request headers.
`void`	`setIndex(Integer index)` The index within the run.webRequests array of the request object associated with this result.
`void`	`setMethod(String method)` The HTTP method.
`void`	`setParameters(Parameters parameters)` The request parameters.
`void`	`setProperties(PropertyBag properties)` Key/value pairs that provide additional information about the object.
`void`	`setProtocol(String protocol)` The request protocol.
`void`	`setTarget(String target)` The target of the request.
`void`	`setVersion(String version)` The request version.
`String`	`toString()`
`WebRequest`	`withBody(ArtifactContent body)`
`WebRequest`	`withHeaders(Headers headers)`
`WebRequest`	`withIndex(Integer index)`
`WebRequest`	`withMethod(String method)`
`WebRequest`	`withParameters(Parameters parameters)`
`WebRequest`	`withProperties(PropertyBag properties)`
`WebRequest`	`withProtocol(String protocol)`
`WebRequest`	`withTarget(String target)`
`WebRequest`	`withVersion(String version)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - WebRequest
```
public WebRequest()
```
- Method Detail
  - getIndex
```
public Integer getIndex()
```
    The index within the run.webRequests array of the request object associated with this result.
  - setIndex
```
public void setIndex(Integer index)
```
    The index within the run.webRequests array of the request object associated with this result.
  - withIndex
```
public WebRequest withIndex(Integer index)
```
  - getProtocol
```
public String getProtocol()
```
    The request protocol. Example: 'http'.
  - setProtocol
```
public void setProtocol(String protocol)
```
    The request protocol. Example: 'http'.
  - withProtocol
```
public WebRequest withProtocol(String protocol)
```
  - getVersion
```
public String getVersion()
```
    The request version. Example: '1.1'.
  - setVersion
```
public void setVersion(String version)
```
    The request version. Example: '1.1'.
  - withVersion
```
public WebRequest withVersion(String version)
```
  - getTarget
```
public String getTarget()
```
    The target of the request.
  - setTarget
```
public void setTarget(String target)
```
    The target of the request.
  - withTarget
```
public WebRequest withTarget(String target)
```
  - getMethod
```
public String getMethod()
```
    The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.
  - setMethod
```
public void setMethod(String method)
```
    The HTTP method. Well-known values are 'GET', 'PUT', 'POST', 'DELETE', 'PATCH', 'HEAD', 'OPTIONS', 'TRACE', 'CONNECT'.
  - withMethod
```
public WebRequest withMethod(String method)
```
  - getHeaders
```
public Headers getHeaders()
```
    The request headers.
  - setHeaders
```
public void setHeaders(Headers headers)
```
    The request headers.
  - withHeaders
```
public WebRequest withHeaders(Headers headers)
```
  - getParameters
```
public Parameters getParameters()
```
    The request parameters.
  - setParameters
```
public void setParameters(Parameters parameters)
```
    The request parameters.
  - withParameters
```
public WebRequest withParameters(Parameters parameters)
```
  - getBody
```
public ArtifactContent getBody()
```
    Represents the contents of an artifact.
  - setBody
```
public void setBody(ArtifactContent body)
```
    Represents the contents of an artifact.
  - withBody
```
public WebRequest withBody(ArtifactContent body)
```
  - getProperties
```
public PropertyBag getProperties()
```
    Key/value pairs that provide additional information about the object.
  - setProperties
```
public void setProperties(PropertyBag properties)
```
    Key/value pairs that provide additional information about the object.
  - withProperties
```
public WebRequest withProperties(PropertyBag properties)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - equals
```
public boolean equals(Object other)
```
    Overrides:
    
    equals in class Object

Class WebRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

WebRequest

Method Detail

getIndex

setIndex

withIndex

getProtocol

setProtocol

withProtocol

getVersion

setVersion

withVersion

getTarget

setTarget

withTarget

getMethod

setMethod

withMethod

getHeaders

setHeaders

withHeaders

getParameters

setParameters

withParameters

getBody

setBody

withBody

getProperties

setProperties

withProperties

toString

hashCode

equals