openconsensus.resource

Class Resource

java.lang.Object

openconsensus.resource.Resource

@Immutable
public abstract class Resource
extends Object

Resource represents a resource, which capture identifying information about the entities for which signals (stats or traces) are reported.

Since:

0.1.0

Method Summary

Modifier and Type	Method and Description
static Resource	create(Map<String,String> labels) Returns a Resource.
static Resource	getEmpty()
abstract Map<String,String>	getLabels() Returns a map of labels that describe the resource.
Resource	merge(Resource other) Returns a new, merged Resource by merging the current Resource with the other Resource.

Methods inherited from class java.lang.Object

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

Method Detail

getEmpty

public static Resource getEmpty()

getLabels

public abstract Map<String,String> getLabels()

Returns a map of labels that describe the resource.

Returns:

a map of labels.

Since:

0.1.0

create

public static Resource create(Map<String,String> labels)

Returns a Resource.

Parameters:

labels - a map of labels that describe the resource.

Returns:

a Resource.

Throws:

NullPointerException - if labels is null.

IllegalArgumentException - if label key or label value is not a valid printable ASCII string or exceed MAX_LENGTH characters.

Since:

0.1.0

merge

public Resource merge(@Nullable
                      Resource other)

Returns a new, merged Resource by merging the current Resource with the other Resource. In case of a collision, current Resource takes precedence.

Parameters:

other - the Resource that will be merged with this.

Returns:

the newly merged Resource.