com.heroku.api.request.log

Class Log.LogRequestBuilder

java.lang.Object

com.heroku.api.request.log.Log.LogRequestBuilder

Enclosing class:

Log

public static class Log.LogRequestBuilder
extends Object

Builder class for specifying log request parameters. Logs can be retrieved by specifying a process, the number of lines, etc... Once the params are specified, build the Log request with getRequest(). Use this builder to specify which params a Log should use. e.g.

 new Log.LogRequestBuilder().app("myApp").ps("web.1").num(50).getRequest()

Constructor Summary

Constructors

Constructor and Description
LogRequestBuilder()

Method Summary

Modifier and Type	Method and Description
Log.LogRequestBuilder	app(String app) Name of the app to get logs for.
Log.LogRequestBuilder	dyno(String dyno) Name of the dyno to get logs for (e.g.
Log	getRequest() Finalize the params and get a Log request.
Log.LogRequestBuilder	num(int num) Number of log lines to retrieve.
Log.LogRequestBuilder	source(String source) The source of the logs.
Log.LogRequestBuilder	tail(boolean tail) Whether or not to tail the logs.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogRequestBuilder

public LogRequestBuilder()

Method Detail

getRequest

public Log getRequest()

Finalize the params and get a Log request.

Returns:

The log

app

public Log.LogRequestBuilder app(String app)

Name of the app to get logs for.

Parameters:

app - App name.

Returns:

builder object

num

public Log.LogRequestBuilder num(int num)

Number of log lines to retrieve.

Parameters:

num - number of lines

Returns:

builder object

dyno

public Log.LogRequestBuilder dyno(String dyno)

Name of the dyno to get logs for (e.g. web.1).

Parameters:

dyno - Name of the dyno. e.g. "web.1"

Returns:

builder object

source

public Log.LogRequestBuilder source(String source)

The source of the logs. This can be found by reviewing the logs and looking at the value just after the timestamp. e.g. the source of 2012-03-23T18:46:01+00:00 heroku[router] is "heroku".

Parameters:

source - source of the logs

Returns:

builder object

tail

public Log.LogRequestBuilder tail(boolean tail)

Whether or not to tail the logs. If true, a stream will be created that will remain open for an extended period of time.

Parameters:

tail - to tail the logs or not

Returns:

builder object