com.rollbar.api.payload.data

Class Data.Builder

java.lang.Object

com.rollbar.api.payload.data.Data.Builder

Enclosing class:

Data

public static final class Data.Builder
extends java.lang.Object

Builder class for data.

Constructor Summary

Constructors

Constructor and Description
Builder() Constructor.
Builder(Data data) Constructor.

Method Summary

Modifier and Type	Method and Description
Data.Builder	body(Body body) The actual data being sent to rollbar (not metadata, about the request, server, etc.).
Data	build() Builds the data.
Data.Builder	client(Client client) Data about the client device this event occurred on.
Data.Builder	codeVersion(java.lang.String codeVersion) The currently running version of the code.
Data.Builder	context(java.lang.String context) Custom identifier to help find where the error came from, Controller class name, for instance.
Data.Builder	custom(java.util.Map<java.lang.String,java.lang.Object> custom) Custom data that will aid in debugging the error.
Data.Builder	environment(java.lang.String environment) Represents the current environment (e.g.: production, debug, test).
Data.Builder	fingerprint(java.lang.String fingerprint) Override the default and custom grouping with a string, if over 255 characters will be hashed.
Data.Builder	framework(java.lang.String framework) The framework being run (e.g.
Data.Builder	isUncaught(boolean isUncaught) Specify whether this data object originates from an uncaught exception or not.
Data.Builder	language(java.lang.String language) The language running (most likely java, but any JVM language might be here).
Data.Builder	level(Level level) The rollbar error level.
Data.Builder	level(java.lang.String level) The rollbar error level.
Data.Builder	notifier(Notifier notifier) Information about this notifier, esp.
Data.Builder	person(Person person) Data about the user that experienced the error, if possible.
Data.Builder	platform(java.lang.String platform) The platform running (most likely JVM and a version).
Data.Builder	request(Request request) Data about the Http Request that caused this, if applicable.
Data.Builder	server(Server server) Data about the machine on which the error occurred.
Data.Builder	timestamp(java.lang.Long timestamp) The moment the bug happened, visible in ui as client_timestamp.
Data.Builder	title(java.lang.String title) The title, max length 255 characters, overrides the default and custom ones set by Rollbar.
Data.Builder	uuid(java.lang.String uuid) Override the error UUID, unique to each project, used to deduplicate occurrences.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Constructor.

Builder

public Builder(Data data)

Constructor.

Parameters:

data - the data to initialize a new builder instance.

Method Detail

environment

public Data.Builder environment(java.lang.String environment)

Represents the current environment (e.g.: production, debug, test).

Parameters:

environment - the environment.

Returns:

the builder instance.

body

public Data.Builder body(Body body)

The actual data being sent to rollbar (not metadata, about the request, server, etc.).

Parameters:

body - the body.

Returns:

the builder instance.

level

public Data.Builder level(java.lang.String level)

The rollbar error level.

Parameters:

level - the level.

Returns:

the builder instance.

level

public Data.Builder level(Level level)

The rollbar error level.

Parameters:

level - the level.

Returns:

the builder instance.

timestamp

public Data.Builder timestamp(java.lang.Long timestamp)

The moment the bug happened, visible in ui as client_timestamp.

Parameters:

timestamp - the timestamp as a Long with millisecond precision. This vaulue is converted to seconds when serialized to JSON to conform to the API spec.

Returns:

the builder instance.

codeVersion

public Data.Builder codeVersion(java.lang.String codeVersion)

The currently running version of the code.

Parameters:

codeVersion - the code version.

Returns:

the builder instance.

platform

public Data.Builder platform(java.lang.String platform)

The platform running (most likely JVM and a version).

Parameters:

platform - the platform.

Returns:

the builder instance.

language

public Data.Builder language(java.lang.String language)

The language running (most likely java, but any JVM language might be here).

Parameters:

language - the language.

Returns:

the builder instance.

framework

public Data.Builder framework(java.lang.String framework)

The framework being run (e.g. Play, Spring, etc).

Parameters:

framework - the framework.

Returns:

the builder instance.

context

public Data.Builder context(java.lang.String context)

Custom identifier to help find where the error came from, Controller class name, for instance.

Parameters:

context - the context.

Returns:

the builder instance.

request

public Data.Builder request(Request request)

Data about the Http Request that caused this, if applicable.

Parameters:

request - the request.

Returns:

the builder instance.

person

public Data.Builder person(Person person)

Data about the user that experienced the error, if possible.

Parameters:

person - the person.

Returns:

the builder instance.

server

public Data.Builder server(Server server)

Data about the machine on which the error occurred.

Parameters:

server - the server.

Returns:

the builder instance.

client

public Data.Builder client(Client client)

Data about the client device this event occurred on. As there can be multiple client environments for a given event (i.e. Flash running inside an HTML page), data should be namespaced by platform.

Parameters:

client - the client.

Returns:

the builder instance.

custom

public Data.Builder custom(java.util.Map<java.lang.String,java.lang.Object> custom)

Custom data that will aid in debugging the error.

Parameters:

custom - the custom.

Returns:

the builder instance.

fingerprint

public Data.Builder fingerprint(java.lang.String fingerprint)

Override the default and custom grouping with a string, if over 255 characters will be hashed.

Parameters:

fingerprint - the fingerprint.

Returns:

the builder instance.

title

public Data.Builder title(java.lang.String title)

The title, max length 255 characters, overrides the default and custom ones set by Rollbar.

Parameters:

title - the title.

Returns:

the builder instance.

uuid

public Data.Builder uuid(java.lang.String uuid)

Override the error UUID, unique to each project, used to deduplicate occurrences.

Parameters:

uuid - the uuid.

Returns:

the builder instance.

isUncaught

public Data.Builder isUncaught(boolean isUncaught)

Specify whether this data object originates from an uncaught exception or not.

Parameters:

isUncaught - true if this comes from an uncaught exception.

Returns:

the builder instance.

notifier

public Data.Builder notifier(Notifier notifier)

Information about this notifier, esp. if creating a framework specific notifier

Parameters:

notifier - the notifier.

Returns:

the builder instance.

build

public Data build()

Builds the data.

Returns:

the data.