FINAL
Represents the details of a single request and may optionally contain
application logs written during the request using the syslog
function.
Methods
getAppId
getAppId() : string
Returns
string
The application ID that handled this request.
getAppLogs
getAppLogs() : array<mixed,\google\appengine\api\log\AppLogLine>
Returns
array<mixed,\google\appengine\api\log\AppLogLine>
The {@link AppLogLine}s added during this request.
getCombined
getCombined() : string
Returns
string
The Apache-format combined log entry for this request. While the information in this field can be constructed from the rest of this message, we include this method for convenience.
getStartTimeUsec
getStartTimeUsec() : double
Returns
double
The time at which this request began processing, in microseconds since the Unix epoch.
getStartDateTime
getStartDateTime() : \google\appengine\api\log\DateTime
Returns
\google\appengine\api\log\DateTime
The same value as {@link getStartTimeUsec()} as a DateTime instance accurate to the second. For greater accuracy use {@link getStartTimeUsec()}.
getEndTimeUsec
getEndTimeUsec() : double
Returns
double
The time at which the request finished processing, in microseconds since the Unix epoch.
getEndDateTime
getEndDateTime() : \google\appengine\api\log\DateTime
Returns
\google\appengine\api\log\DateTime
The same value as {@link getEndTimeUsec()} as a DateTime instance accurate to the second. For greater accuracy use {@link getEndTimeUsec()}.
getHost
getHost() : string
Returns
string
The Internet host and port number of the resource being requested.
getHttpVersion
getHttpVersion() : string
Returns
string
The HTTP version of this request.
getInstanceKey
getInstanceKey() : string
Returns
string
Mostly-unique identifier for the instance that handled the request, or the empty string.
getIp
getIp() : string
Returns
string
The origin IP address of this request. App Engine uses an origin IP address from the 0.0.0.0/8 range when the request is to a web hook. Some examples of web hooks are task queues, cron jobs and warming requests.
getLatencyUsec
getLatencyUsec() : double
Returns
double
The time required to process this request in microseconds.
getMethod
getMethod() : string
Returns
string
The request's HTTP method (e.g., GET, PUT, POST).
getNickname
getNickname() : string
Returns
string
The nickname of the user that made the request. An empty string is returned if the user is not logged in.
getOffset
getOffset() : string
Returns
string
A url safe value that may be used as an option to
LogService::fetch($options) to continue reading after this
log.
getPendingTimeUsec
getPendingTimeUsec() : double
Returns
double
The time, in microseconds, that this request spent in the pending request queue, if it was pending at all.
getReferrer
getReferrer() : string
Returns
string
The referrer URL of this request.
getInstanceIndex
getInstanceIndex() : integer
Returns
integer
The module instance that handled the request if manual_scaling or basic_scaling is configured or -1 for automatic_scaling.
getRequestId
getRequestId() : string
Returns
string
A globally unique identifier for a request, based on the request's starting time.
getResource
getResource() : string
Returns
string
The resource path on the server requested by the client. Contains only the path component of the request URL.
getResponseSize
getResponseSize() : integer
Returns
integer
The size (in bytes) of the response sent back to the client.
getStatus
getStatus() : integer
Returns
integer
The HTTP response status of this request.
getTaskName
getTaskName() : string
Returns
string
The request's task name, if this request was generated via the Task Queue API.
getTaskQueueName
getTaskQueueName() : string
Returns
string
The request's queue name, if this request was generated via the Task Queue API.
getUrlMapEntry
getUrlMapEntry() : string
Returns
string
The file or class within the URL mapping used for this request. Useful for tracking down the source code which was responsible for managing the request, especially for multiply mapped handlers.
getUserAgent
getUserAgent() : string
Returns
string
The user agent used to make this request.
getVersionId
getVersionId() : string
Returns
string
The version of the application that handled this request.
getModuleId
getModuleId() : string
Returns
string
The version of the application that handled this request.
isFinished
isFinished() : boolean
Returns
boolean
Whether or not this request has finished processing. If not, this request is still active.
isLoadingRequest
isLoadingRequest() : boolean
Returns
boolean
Whether or not this request was a loading request.
getAppEngineRelease
getAppEngineRelease() : string
Returns
string
App Engine Release, e.g. "1.8.4"