MetricDescriptor.Builder (opencensus-proto 0.2.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>
    - - io.opencensus.proto.metrics.v1.MetricDescriptor.Builder

All Implemented Interfaces:

com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, MetricDescriptorOrBuilder, Cloneable

Enclosing class:

MetricDescriptor
```
public static final class MetricDescriptor.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>
implements MetricDescriptorOrBuilder
```
```
 Defines a metric type and its schema.
 
```
Protobuf type opencensus.proto.metrics.v1.MetricDescriptor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`MetricDescriptor.Builder`	`addAllLabelKeys(Iterable<? extends LabelKey> values)` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`addLabelKeys(int index, LabelKey.Builder builderForValue)` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`addLabelKeys(int index, LabelKey value)` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`addLabelKeys(LabelKey.Builder builderForValue)` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`addLabelKeys(LabelKey value)` The label keys associated with the metric descriptor.
`LabelKey.Builder`	`addLabelKeysBuilder()` The label keys associated with the metric descriptor.
`LabelKey.Builder`	`addLabelKeysBuilder(int index)` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`MetricDescriptor`	`build()`
`MetricDescriptor`	`buildPartial()`
`MetricDescriptor.Builder`	`clear()`
`MetricDescriptor.Builder`	`clearDescription()` A detailed description of the metric, which can be used in documentation.
`MetricDescriptor.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`MetricDescriptor.Builder`	`clearLabelKeys()` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`clearName()` The metric type, including its DNS name prefix.
`MetricDescriptor.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`MetricDescriptor.Builder`	`clearType()` `.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;`
`MetricDescriptor.Builder`	`clearUnit()` The unit in which the metric value is reported.
`MetricDescriptor.Builder`	`clone()`
`MetricDescriptor`	`getDefaultInstanceForType()`
`String`	`getDescription()` A detailed description of the metric, which can be used in documentation.
`com.google.protobuf.ByteString`	`getDescriptionBytes()` A detailed description of the metric, which can be used in documentation.
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`LabelKey`	`getLabelKeys(int index)` The label keys associated with the metric descriptor.
`LabelKey.Builder`	`getLabelKeysBuilder(int index)` The label keys associated with the metric descriptor.
`List<LabelKey.Builder>`	`getLabelKeysBuilderList()` The label keys associated with the metric descriptor.
`int`	`getLabelKeysCount()` The label keys associated with the metric descriptor.
`List<LabelKey>`	`getLabelKeysList()` The label keys associated with the metric descriptor.
`LabelKeyOrBuilder`	`getLabelKeysOrBuilder(int index)` The label keys associated with the metric descriptor.
`List<? extends LabelKeyOrBuilder>`	`getLabelKeysOrBuilderList()` The label keys associated with the metric descriptor.
`String`	`getName()` The metric type, including its DNS name prefix.
`com.google.protobuf.ByteString`	`getNameBytes()` The metric type, including its DNS name prefix.
`MetricDescriptor.Type`	`getType()` `.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;`
`int`	`getTypeValue()` `.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;`
`String`	`getUnit()` The unit in which the metric value is reported.
`com.google.protobuf.ByteString`	`getUnitBytes()` The unit in which the metric value is reported.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`MetricDescriptor.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`MetricDescriptor.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`MetricDescriptor.Builder`	`mergeFrom(MetricDescriptor other)`
`MetricDescriptor.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`MetricDescriptor.Builder`	`removeLabelKeys(int index)` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`setDescription(String value)` A detailed description of the metric, which can be used in documentation.
`MetricDescriptor.Builder`	`setDescriptionBytes(com.google.protobuf.ByteString value)` A detailed description of the metric, which can be used in documentation.
`MetricDescriptor.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`MetricDescriptor.Builder`	`setLabelKeys(int index, LabelKey.Builder builderForValue)` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`setLabelKeys(int index, LabelKey value)` The label keys associated with the metric descriptor.
`MetricDescriptor.Builder`	`setName(String value)` The metric type, including its DNS name prefix.
`MetricDescriptor.Builder`	`setNameBytes(com.google.protobuf.ByteString value)` The metric type, including its DNS name prefix.
`MetricDescriptor.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`MetricDescriptor.Builder`	`setType(MetricDescriptor.Type value)` `.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;`
`MetricDescriptor.Builder`	`setTypeValue(int value)` `.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;`
`MetricDescriptor.Builder`	`setUnit(String value)` The unit in which the metric value is reported.
`MetricDescriptor.Builder`	`setUnitBytes(com.google.protobuf.ByteString value)` The unit in which the metric value is reported.
`MetricDescriptor.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, newBuilderForField, onBuilt, onChanged, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

Method Detail

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

clear
```
public MetricDescriptor.Builder clear()
```
Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

getDefaultInstanceForType
```
public MetricDescriptor getDefaultInstanceForType()
```
Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build
```
public MetricDescriptor build()
```
Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial
```
public MetricDescriptor buildPartial()
```
Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

clone
```
public MetricDescriptor.Builder clone()
```
Specified by:

clone in interface com.google.protobuf.Message.Builder

Specified by:

clone in interface com.google.protobuf.MessageLite.Builder

Overrides:

clone in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

setField

public MetricDescriptor.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)

Specified by:: setField in interface com.google.protobuf.Message.Builder
Overrides:: setField in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

clearField
```
public MetricDescriptor.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
Specified by:

clearField in interface com.google.protobuf.Message.Builder

Overrides:

clearField in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

clearOneof
```
public MetricDescriptor.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
Specified by:

clearOneof in interface com.google.protobuf.Message.Builder

Overrides:

clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

setRepeatedField

public MetricDescriptor.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)

Specified by:: setRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

addRepeatedField

public MetricDescriptor.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)

Specified by:: addRepeatedField in interface com.google.protobuf.Message.Builder
Overrides:: addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

mergeFrom
```
public MetricDescriptor.Builder mergeFrom(com.google.protobuf.Message other)
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MetricDescriptor.Builder>

mergeFrom

public MetricDescriptor.Builder mergeFrom(MetricDescriptor other)

isInitialized
```
public final boolean isInitialized()
```
Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<MetricDescriptor.Builder>

mergeFrom
```
public MetricDescriptor.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
```
Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<MetricDescriptor.Builder>

Throws:

IOException

getName

public String getName()

 The metric type, including its DNS name prefix. It must be unique.

string name = 1;

Specified by:: getName in interface MetricDescriptorOrBuilder

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The metric type, including its DNS name prefix. It must be unique.

string name = 1;

Specified by:: getNameBytes in interface MetricDescriptorOrBuilder

setName

public MetricDescriptor.Builder setName(String value)

 The metric type, including its DNS name prefix. It must be unique.

string name = 1;

clearName

public MetricDescriptor.Builder clearName()

 The metric type, including its DNS name prefix. It must be unique.

string name = 1;

setNameBytes

public MetricDescriptor.Builder setNameBytes(com.google.protobuf.ByteString value)

 The metric type, including its DNS name prefix. It must be unique.

string name = 1;

getDescription

public String getDescription()

 A detailed description of the metric, which can be used in documentation.

string description = 2;

Specified by:: getDescription in interface MetricDescriptorOrBuilder

getDescriptionBytes

public com.google.protobuf.ByteString getDescriptionBytes()

 A detailed description of the metric, which can be used in documentation.

string description = 2;

Specified by:: getDescriptionBytes in interface MetricDescriptorOrBuilder

setDescription

public MetricDescriptor.Builder setDescription(String value)

 A detailed description of the metric, which can be used in documentation.

string description = 2;

clearDescription

public MetricDescriptor.Builder clearDescription()

 A detailed description of the metric, which can be used in documentation.

string description = 2;

setDescriptionBytes

public MetricDescriptor.Builder setDescriptionBytes(com.google.protobuf.ByteString value)

 A detailed description of the metric, which can be used in documentation.

string description = 2;

getUnit

public String getUnit()

 The unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.

string unit = 3;

Specified by:: getUnit in interface MetricDescriptorOrBuilder

getUnitBytes

public com.google.protobuf.ByteString getUnitBytes()

 The unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.

string unit = 3;

Specified by:: getUnitBytes in interface MetricDescriptorOrBuilder

setUnit

public MetricDescriptor.Builder setUnit(String value)

 The unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.

string unit = 3;

clearUnit

public MetricDescriptor.Builder clearUnit()

 The unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.

string unit = 3;

setUnitBytes

public MetricDescriptor.Builder setUnitBytes(com.google.protobuf.ByteString value)

 The unit in which the metric value is reported. Follows the format
 described by http://unitsofmeasure.org/ucum.html.

string unit = 3;

getTypeValue
```
public int getTypeValue()
```
.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;

Specified by:

getTypeValue in interface MetricDescriptorOrBuilder

setTypeValue
```
public MetricDescriptor.Builder setTypeValue(int value)
```
.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;

getType
```
public MetricDescriptor.Type getType()
```
.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;

Specified by:

getType in interface MetricDescriptorOrBuilder

setType

public MetricDescriptor.Builder setType(MetricDescriptor.Type value)

.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;

clearType
```
public MetricDescriptor.Builder clearType()
```
.opencensus.proto.metrics.v1.MetricDescriptor.Type type = 4;

getLabelKeysList
```
public List<LabelKey> getLabelKeysList()
```
```
 The label keys associated with the metric descriptor.
 
```
repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;
Specified by:

getLabelKeysList in interface MetricDescriptorOrBuilder

getLabelKeysCount
```
public int getLabelKeysCount()
```
```
 The label keys associated with the metric descriptor.
 
```
repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;
Specified by:

getLabelKeysCount in interface MetricDescriptorOrBuilder

getLabelKeys
```
public LabelKey getLabelKeys(int index)
```
```
 The label keys associated with the metric descriptor.
 
```
repeated .opencensus.proto.metrics.v1.LabelKey label_keys = 5;
Specified by:

getLabelKeys in interface MetricDescriptorOrBuilder