Request (yop-java-sdk-base 4.4.12 API)

所有已知实现类:

DefaultRequest
```
public interface Request<T extends BaseRequest>
```
title: 请求
description:
Represents a request being sent to Yop Api-GateWay, including the parameters being sent as part of the request, the endpoint to which the request should be sent, etc
Copyright: Copyright (c) 2017
Company: 易宝支付(YeePay)

从以下版本开始:

17/11/13 17:03

版本:

1.0.0

作者:

menghao.chen

方法概要

所有方法实例方法抽象方法
限定符和类型	方法和说明
`void`	`addHeader(String name, String value)` Sets the specified header for this request.
`void`	`addMultiPartFile(String name, File file)` Adds the specified file to this request
`void`	`addMultiPartFile(String name, FileParam fileParam)` Adds the specified FileParam to this request
`void`	`addMultiPartFile(String name, InputStream in)` Adds the specified file to this request
`void`	`addParameter(String name, String value)` Adds the specified request parameter to this request.
`void`	`addParameters(String name, List<String> values)` Adds the specified request parameter and list of values to this request.
`void`	`assignYos()` assign this request to yos
`InputStream`	`getContent()` Returns the optional stream containing the payload data to include for this request.
`YopContentType`	`getContentType()` http content-type
`URI`	`getEndpoint()` Returns the service endpoint to which this request should be sent.
`Map<String,String>`	`getHeaders()` Returns a map of all the headers included in this request.
`HttpMethodName`	`getHttpMethod()` Returns the HTTP method (GET, POST, etc) to use when sending this request.
`Map<String,List<MultiPartFile>>`	`getMultiPartFiles()` Return a map of all multipart files in this request
`T`	`getOriginalRequestObject()` Returns the original, user facing request object which this internal request object is representing.
`Map<String,List<String>>`	`getParameters()` Returns a map of all parameters in this request.
`String`	`getRequestId()` current request-id
`String`	`getResourcePath()` Returns the path to the resource being requested.
`String`	`getServiceName()`
`int`	`getTimeOffset()` Returns the optional value for time offset for this request.
`boolean`	`isYosRequest()`
`void`	`setContent(InputStream content)` Sets the optional stream containing the payload data to include for this request.
`void`	`setContentType(YopContentType contentType)` set the http content-type
`void`	`setEndpoint(URI endpoint)` Sets the service endpoint to which this equest should be sent.
`void`	`setHeaders(Map<String,String> headers)` Sets all headers, clearing any existing ones.
`void`	`setHttpMethod(HttpMethodName httpMethod)` Sets the HTTP method (GET, POST, etc) to use when sending this request.
`void`	`setMultiPartFiles(Map<String,List<MultiPartFile>> multiPartFiles)` Sets multipart files, clearing any existing values.
`void`	`setParameters(Map<String,List<String>> parameters)` Sets all parameters, clearing any existing values.
`void`	`setResourcePath(String path)` Sets the path to the resource being requested.
`void`	`setTimeOffset(int timeOffset)` Sets the optional value for time offset for this request.
`Request<T>`	`withMultiPartFile(String name, File file)` Adds the specified file to this request, and returns the uodated request object
`Request<T>`	`withParameter(String name, String value)` Adds the specified request parameter to this request, and returns the updated request object.
`Request<T>`	`withTimeOffset(int timeOffset)` Sets the optional value for time offset for this request.

- 方法详细资料
  - getRequestId
```
String getRequestId()
```
    current request-id
    
    返回:
  - getContentType
```
YopContentType getContentType()
```
    http content-type
    
    返回:
    
    the YopContentType
  - setContentType
```
void setContentType(YopContentType contentType)
```
    set the http content-type
    
    参数:
    
    contentType - the YopContentType
  - getHeaders
```
Map<String,String> getHeaders()
```
    Returns a map of all the headers included in this request.
    
    返回:
    
    A map of all the headers included in this request.
  - setHeaders
```
void setHeaders(Map<String,String> headers)
```
    Sets all headers, clearing any existing ones.
    
    参数:
    
    headers - headers
  - addHeader
```
void addHeader(String name,
               String value)
```
    Sets the specified header for this request.
    
    参数:
    
    name - The name of the header to set.
    
    value - The header's value.
  - getResourcePath
```
String getResourcePath()
```
    Returns the path to the resource being requested.
    
    返回:
    
    The path to the resource being requested.
  - setResourcePath
```
void setResourcePath(String path)
```
    Sets the path to the resource being requested.
    
    参数:
    
    path - The path to the resource being requested.
  - getParameters
```
Map<String,List<String>> getParameters()
```
    Returns a map of all parameters in this request.
    
    返回:
    
    A map of all parameters in this request.
  - withParameter
```
Request<T> withParameter(String name,
                         String value)
```
    Adds the specified request parameter to this request, and returns the updated request object.
    
    参数:
    
    name - The name of the request parameter.
    
    value - The value of the request parameter.
    
    返回:
    
    The updated request object.
  - setParameters
```
void setParameters(Map<String,List<String>> parameters)
```
    Sets all parameters, clearing any existing values.
    Note that List values within the parameters Map must use an implementation that supports null values.
    
    参数:
    
    parameters - the request parameters.
  - addParameters
```
void addParameters(String name,
                   List<String> values)
```
    Adds the specified request parameter and list of values to this request.
    
    参数:
    
    name - The name of the request parameter.
    
    values - The value of the request parameter.
  - addParameter
```
void addParameter(String name,
                  String value)
```
    Adds the specified request parameter to this request.
    
    参数:
    
    name - The name of the request parameter.
    
    value - The value of the request parameter.
  - getMultiPartFiles
```
Map<String,List<MultiPartFile>> getMultiPartFiles()
```
    Return a map of all multipart files in this request
    
    返回:
    
    A map of all multipart files in this request
  - setMultiPartFiles
```
void setMultiPartFiles(Map<String,List<MultiPartFile>> multiPartFiles)
```
    Sets multipart files, clearing any existing values.
    Note that List values within the parameters Map must use an implementation that supports null values.
    
    参数:
    
    multiPartFiles - the request multipart files.
  - withMultiPartFile
```
Request<T> withMultiPartFile(String name,
                             File file)
```
    Adds the specified file to this request, and returns the uodated request object
    
    参数:
    
    name - The name of the file parameter
    
    file - The file
    
    返回:
    
    The updated request
  - addMultiPartFile
```
void addMultiPartFile(String name,
                      File file)
```
    Adds the specified file to this request
    
    参数:
    
    name - The name of the file parameter
    
    file - The file
  - addMultiPartFile
```
void addMultiPartFile(String name,
                      InputStream in)
```
    Adds the specified file to this request
    
    参数:
    
    name - The name of the file parameter
    
    in - the file
  - addMultiPartFile
```
void addMultiPartFile(String name,
                      FileParam fileParam)
```
    Adds the specified FileParam to this request
    
    参数:
    
    name - The name of the file parameter
    
    fileParam - the fileParam
  - getEndpoint
```
URI getEndpoint()
```
    Returns the service endpoint to which this request should be sent.
    
    返回:
    
    The service endpoint to which this request should be sent.
  - setEndpoint
```
void setEndpoint(URI endpoint)
```
    Sets the service endpoint to which this equest should be sent.
    
    参数:
    
    endpoint - The service endpoint to which this request should be sent.
  - setHttpMethod
```
void setHttpMethod(HttpMethodName httpMethod)
```
    Sets the HTTP method (GET, POST, etc) to use when sending this request.
    
    参数:
    
    httpMethod - The HTTP method to use when sending this request.
  - getHttpMethod
```
HttpMethodName getHttpMethod()
```
    Returns the HTTP method (GET, POST, etc) to use when sending this request.
    
    返回:
    
    The HTTP method to use when sending this request.
  - getTimeOffset
```
int getTimeOffset()
```
    Returns the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    返回:
    
    The optional value for time offset (in seconds) for this request.
  - setTimeOffset
```
void setTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    参数:
    
    timeOffset - The optional value for time offset (in seconds) for this request.
  - withTimeOffset
```
Request<T> withTimeOffset(int timeOffset)
```
    Sets the optional value for time offset for this request. This will be used by the signer to adjust for potential clock skew. Value is in seconds, positive values imply the current clock is "fast", negative values imply clock is slow.
    
    参数:
    
    timeOffset - The optional value for time offset (in seconds) for this request.
    
    返回:
    
    The updated request object.
  - getContent
```
InputStream getContent()
```
    Returns the optional stream containing the payload data to include for this request. Not all requests will contain payload data.
    
    返回:
    
    The optional stream containing the payload data to include for this request.
  - setContent
```
void setContent(InputStream content)
```
    Sets the optional stream containing the payload data to include for this request. This is used, for example, for S3 chunk encoding.
    
    参数:
    
    content - The optional stream containing the payload data to include for this request.
  - getServiceName
```
String getServiceName()
```
    返回:
    
    The name of the Yop service this request is for. This is used as the service name set in request metrics and service exceptions.
  - getOriginalRequestObject
```
T getOriginalRequestObject()
```
    Returns the original, user facing request object which this internal request object is representing.
    
    返回:
    
    an instance of request as an T.
  - isYosRequest
```
boolean isYosRequest()
```
    返回:
    
    whether this request is a yos request;
  - assignYos
```
void assignYos()
```
    assign this request to yos

接口 Request<T extends BaseRequest>

方法概要

方法详细资料

getRequestId

getContentType

setContentType

getHeaders

setHeaders

addHeader

getResourcePath

setResourcePath

getParameters

withParameter

setParameters

addParameters

addParameter

getMultiPartFiles

setMultiPartFiles

withMultiPartFile

addMultiPartFile

addMultiPartFile

addMultiPartFile

getEndpoint

setEndpoint

setHttpMethod

getHttpMethod

getTimeOffset

setTimeOffset

withTimeOffset

getContent

setContent

getServiceName

getOriginalRequestObject

isYosRequest

assignYos