Package com.seeq.utilities
Interface SeeqNames.API.Headers
- Enclosing interface:
- SeeqNames.API
public static interface SeeqNames.API.Headers
When adding a new header, please MAKE SURE to add the header to either the list of
RequestHeaders
(if it is a header that the API reads from a request) or ResponseHeaders
(if it is a header that the API sets in a response to a request). If the header is used in both requests and
responses, then add it to both lists. This will ensure that our API remains CORS compatible (see
CorsHandler
for more info).-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
Names of meters Server-Meters headersstatic interface
Names of timings in Server-Timing headers -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
static final String
'true' if the client is willing to receive the response asynchronously via the websocket connection.static final String
'true' if the client is asking the server to process this request asynchronously as a Job.static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
static final String
Headers that are read from incoming requests.static final String
static final String
static final String
static final String
Headers that are set in outgoing responses.static final String
static final String
static final String
-
Field Details
-
AcceptRanges
- See Also:
-
Async
'true' if the client is willing to receive the response asynchronously via the websocket connection. Note: When set, the request could still be processed synchronously at appserver's discretion.- See Also:
-
AsyncJob
'true' if the client is asking the server to process this request asynchronously as a Job. The server may ignore this header as support for this pattern is only available on select endpoints. If the server does trigger a job it will provide its information on the response and the client will then use that to retrieve the results for the original request from the job. The client will typically poll for job until it is complete (finished or errored).- See Also:
-
Auth
- See Also:
-
IdentityPath
- See Also:
-
ContentRange
- See Also:
-
Csrf
- See Also:
-
ForwardedFor
- See Also:
-
InteractiveSessionId
- See Also:
-
PoolId
- See Also:
-
Range
- See Also:
-
RequestId
- See Also:
-
RequestOrigin
- See Also:
-
RequestOriginURL
- See Also:
-
RequestOriginLabel
- See Also:
-
Server
- See Also:
-
ServerMeters
- See Also:
-
ServerTiming
- See Also:
-
Expect
- See Also:
-
DateRangeStart
- See Also:
-
DateRangeEnd
- See Also:
-
RequestHeaders
Headers that are read from incoming requests. -
ResponseHeaders
Headers that are set in outgoing responses.
-