org.cloudfoundry.doppler

Class Envelope.Builder

java.lang.Object

org.cloudfoundry.doppler.Envelope.Builder

Enclosing class:

Envelope

public static final class Envelope.Builder
extends Object

Builds instances of type Envelope. Initialize attributes and then invoke the build() method to create an immutable instance.

Builder is not thread-safe and generally should not be stored in a field or collection, but instead used immediately to create instances.

Method Summary

Modifier and Type	Method and Description
Envelope	build() Builds a new Envelope.
Envelope.Builder	containerMetric(ContainerMetric containerMetric) Initializes the value for the containerMetric attribute.
Envelope.Builder	counterEvent(CounterEvent counterEvent) Initializes the value for the counterEvent attribute.
Envelope.Builder	deployment(String deployment) Initializes the value for the deployment attribute.
Envelope.Builder	error(Error error) Initializes the value for the error attribute.
Envelope.Builder	eventType(EventType eventType) Initializes the value for the eventType attribute.
Envelope.Builder	from(Envelope instance) Fill a builder with attribute values from the provided Envelope instance.
Envelope.Builder	httpStartStop(HttpStartStop httpStartStop) Initializes the value for the httpStartStop attribute.
Envelope.Builder	index(String index) Initializes the value for the index attribute.
Envelope.Builder	ip(String ip) Initializes the value for the ip attribute.
Envelope.Builder	job(String job) Initializes the value for the job attribute.
Envelope.Builder	logMessage(LogMessage logMessage) Initializes the value for the logMessage attribute.
Envelope.Builder	origin(String origin) Initializes the value for the origin attribute.
Envelope.Builder	putAllTags(Map<String,? extends String> tags) Put all mappings from the specified map as entries to tags map.
Envelope.Builder	tag(Map.Entry<String,? extends String> entry) Put one entry to the tags map.
Envelope.Builder	tag(String key, String value) Put one entry to the tags map.
Envelope.Builder	tags(Map<String,? extends String> tags) Sets or replaces all mappings from the specified map as entries for the tags map.
Envelope.Builder	timestamp(Long timestamp) Initializes the value for the timestamp attribute.
Envelope.Builder	valueMetric(ValueMetric valueMetric) Initializes the value for the valueMetric attribute.

Methods inherited from class java.lang.Object

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

Method Detail

from

public final Envelope.Builder from(Envelope instance)

Fill a builder with attribute values from the provided Envelope instance. Regular attribute values will be replaced with those from the given instance. Absent optional values will not replace present values. Collection elements and entries will be added, not replaced.

Parameters:

instance - The instance from which to copy values

Returns:

this builder for use in a chained invocation

containerMetric

public final Envelope.Builder containerMetric(ContainerMetric containerMetric)

Initializes the value for the containerMetric attribute.

Parameters:

containerMetric - The value for containerMetric (can be null)

Returns:

this builder for use in a chained invocation

counterEvent

public final Envelope.Builder counterEvent(CounterEvent counterEvent)

Initializes the value for the counterEvent attribute.

Parameters:

counterEvent - The value for counterEvent (can be null)

Returns:

this builder for use in a chained invocation

deployment

public final Envelope.Builder deployment(String deployment)

Initializes the value for the deployment attribute.

Parameters:

deployment - The value for deployment (can be null)

Returns:

this builder for use in a chained invocation

error

public final Envelope.Builder error(Error error)

Initializes the value for the error attribute.

Parameters:

error - The value for error (can be null)

Returns:

this builder for use in a chained invocation

eventType

public final Envelope.Builder eventType(EventType eventType)

Initializes the value for the eventType attribute.

Parameters:

eventType - The value for eventType

Returns:

this builder for use in a chained invocation

httpStartStop

public final Envelope.Builder httpStartStop(HttpStartStop httpStartStop)

Initializes the value for the httpStartStop attribute.

Parameters:

httpStartStop - The value for httpStartStop (can be null)

Returns:

this builder for use in a chained invocation

index

public final Envelope.Builder index(String index)

Initializes the value for the index attribute.

Parameters:

index - The value for index (can be null)

Returns:

this builder for use in a chained invocation

ip

public final Envelope.Builder ip(String ip)

Initializes the value for the ip attribute.

Parameters:

ip - The value for ip (can be null)

Returns:

this builder for use in a chained invocation

job

public final Envelope.Builder job(String job)

Initializes the value for the job attribute.

Parameters:

job - The value for job (can be null)

Returns:

this builder for use in a chained invocation

logMessage

public final Envelope.Builder logMessage(LogMessage logMessage)

Initializes the value for the logMessage attribute.

Parameters:

logMessage - The value for logMessage (can be null)

Returns:

this builder for use in a chained invocation

origin

public final Envelope.Builder origin(String origin)

Initializes the value for the origin attribute.

Parameters:

origin - The value for origin

Returns:

this builder for use in a chained invocation

tag

public final Envelope.Builder tag(String key,
                                  String value)

Put one entry to the tags map.

Parameters:

key - The key in the tags map

value - The associated value in the tags map

Returns:

this builder for use in a chained invocation

tag

public final Envelope.Builder tag(Map.Entry<String,? extends String> entry)

Put one entry to the tags map. Nulls are not permitted

Parameters:

entry - The key and value entry

Returns:

this builder for use in a chained invocation

tags

public final Envelope.Builder tags(Map<String,? extends String> tags)

Sets or replaces all mappings from the specified map as entries for the tags map. Nulls are not permitted

Parameters:

tags - The entries that will be added to the tags map

Returns:

this builder for use in a chained invocation

putAllTags

public final Envelope.Builder putAllTags(Map<String,? extends String> tags)

Put all mappings from the specified map as entries to tags map. Nulls are not permitted

Parameters:

tags - The entries that will be added to the tags map

Returns:

this builder for use in a chained invocation

timestamp

public final Envelope.Builder timestamp(Long timestamp)

Initializes the value for the timestamp attribute.

Parameters:

timestamp - The value for timestamp (can be null)

Returns:

this builder for use in a chained invocation

valueMetric

public final Envelope.Builder valueMetric(ValueMetric valueMetric)

Initializes the value for the valueMetric attribute.

Parameters:

valueMetric - The value for valueMetric (can be null)

Returns:

this builder for use in a chained invocation

build

public Envelope build()

Builds a new Envelope.

Returns:

An immutable instance of Envelope

Throws:

IllegalStateException - if any required attributes are missing