ServiceRequest (API bindings 2.7.7 API)

Type Parameters:

R - Result type

All Superinterfaces:

Serializable

All Known Implementing Classes:

BaseRequest, CheckPoliciesRequest, CheckPolicyComplianceRequest, CheckVulnerabilitiesRequest, ConfigurationRequest, GetDependencyDataRequest, SummaryScanRequest, UpdateInventoryRequest
```
public interface ServiceRequest<R>
extends Serializable
```
The interface describe the functionality to be exposed by any request to the WhiteSource service.

Author:

Edo.Shor

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`String`	`agent()`
`String`	`agentVersion()`
`boolean`	`aggregateModules()`
`String`	`aggregateProjectName()`
`String`	`aggregateProjectToken()`
`String`	`logData()`
`String`	`orgToken()`
`String`	`pluginVersion()`
`boolean`	`preserveModuleStructure()`
`String`	`product()`
`String`	`productVersion()`
`String`	`requesterEmail()`
`long`	`timeStamp()`
`RequestType`	`type()`
`String`	`userKey()`

- Method Detail
  - type
```
RequestType type()
```
    Returns:
    
    Request type.
  - agent
```
String agent()
```
    Returns:
    
    Agent type identifier.
  - agentVersion
```
String agentVersion()
```
    Returns:
    
    Agent API version.
  - orgToken
```
String orgToken()
```
    Returns:
    
    WhiteSource service token of the organization to update.
  - product
```
String product()
```
    Returns:
    
    Name or WhiteSource service token of the product to update.
  - productVersion
```
String productVersion()
```
    Returns:
    
    Version of the product to update.
  - timeStamp
```
long timeStamp()
```
    Returns:
    
    Time stamp when the request created (client side)
  - requesterEmail
```
String requesterEmail()
```
    Returns:
    
    Email of the WhiteSource user that issues this request.
  - pluginVersion
```
String pluginVersion()
```
    Returns:
    
    Plugin version.
  - userKey
```
String userKey()
```
    Returns:
    
    WhiteSource user key who sent the request.
  - aggregateModules
```
boolean aggregateModules()
```
    Returns:
    
    aggregate modules boolean property.
  - preserveModuleStructure
```
boolean preserveModuleStructure()
```
    Returns:
    
    preserve module structure boolean property.
  - aggregateProjectName
```
String aggregateProjectName()
```
    Returns:
    
    aggregate project name (name identifier).
  - aggregateProjectToken
```
String aggregateProjectToken()
```
    Returns:
    
    aggregate project token (token identifier).
  - logData
```
String logData()
```

Interface ServiceRequest<R>

Method Summary

Method Detail

type

agent

agentVersion

orgToken

product

productVersion

timeStamp

requesterEmail

pluginVersion

userKey

aggregateModules

preserveModuleStructure

aggregateProjectName

aggregateProjectToken

logData