com.heroku.api.request.log
Class Log

java.lang.Object
  com.heroku.api.request.log.Log

All Implemented Interfaces:

Request<LogStreamResponse>

public class Log
extends Object
implements Request<LogStreamResponse>

Nested Class Summary

static class

Log.LogRequestBuilder Builder class for specifying log request parameters.

Constructor Summary

Log(Log.LogRequestBuilder logRequest)

Log(String app)

Log(String app, boolean tail)

Method Summary

String	getBody() Value of the request body.
String	getEndpoint() Path and query parameters of a URL.
Map<String,String>	getHeaders() Map of request-specific HTTP headers.
Http.Method	getHttpMethod() HTTP method.
LogStreamResponse	getResponse(byte[] bytes, int status) Response handler.
Http.Accept	getResponseType() HTTP Accept header.
boolean	hasBody() Whether or not the request has a body.
static Log.LogRequestBuilder	logFor(String app)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Log

public Log(String app)

Log

public Log(String app,
           boolean tail)

Log

public Log(Log.LogRequestBuilder logRequest)

Method Detail

logFor

public static Log.LogRequestBuilder logFor(String app)

getHttpMethod

public Http.Method getHttpMethod()

Description copied from interface: Request

HTTP method. e.g. GET, POST, PUT, DELETE

Specified by:

getHttpMethod in interface Request<LogStreamResponse>

Returns:

The HTTP method used in the request.

getEndpoint

public String getEndpoint()

Description copied from interface: Request

Path and query parameters of a URL.

Specified by:

getEndpoint in interface Request<LogStreamResponse>

Returns:

The path and query parameters as a String.

hasBody

public boolean hasBody()

Description copied from interface: Request

Whether or not the request has a body.

Specified by:

hasBody in interface Request<LogStreamResponse>

Returns:

true if it has a request body, otherwise false

getBody

public String getBody()

Description copied from interface: Request

Value of the request body.

Specified by:

getBody in interface Request<LogStreamResponse>

Returns:

Body

getResponseType

public Http.Accept getResponseType()

Description copied from interface: Request

HTTP Accept header.

Specified by:

getResponseType in interface Request<LogStreamResponse>

Returns:

The Accept header to be used in the request. Typically "application/json" or "text/xml"

See Also:

Http.Accept

getHeaders

public Map<String,String> getHeaders()

Description copied from interface: Request

Map of request-specific HTTP headers.

Specified by:

getHeaders in interface Request<LogStreamResponse>

Returns:

Name/value pairs of HTTP headers.

getResponse

public LogStreamResponse getResponse(byte[] bytes,
                                     int status)

Description copied from interface: Request

Response handler.

Specified by:

getResponse in interface Request<LogStreamResponse>

Parameters:

bytes - Data returned from the request.

status - HTTP status code.

Returns:

The type T as specified by an individual request.