Package io.opentelemetry.proto.profiles.v1experimental

Interface SampleOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Sample, Sample.Builder
public interface SampleOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    long
    getAttributes(int index)
    References to attributes in Profile.attribute_table.
    int
    getAttributesCount()
    References to attributes in Profile.attribute_table.
    List<Long>
    getAttributesList()
    References to attributes in Profile.attribute_table.
    Label
    getLabel(int index)
    label includes additional context for this sample.
    int
    getLabelCount()
    label includes additional context for this sample.
    List<Label>
    getLabelList()
    label includes additional context for this sample.
    LabelOrBuilder
    getLabelOrBuilder(int index)
    label includes additional context for this sample.
    List<? extends LabelOrBuilder>
    getLabelOrBuilderList()
    label includes additional context for this sample.
    long
    getLink()
    Reference to link in Profile.link_table.
    long
    getLocationIndex(int index)
    The indices recorded here correspond to locations in Profile.location.
    int
    getLocationIndexCount()
    The indices recorded here correspond to locations in Profile.location.
    List<Long>
    getLocationIndexList()
    The indices recorded here correspond to locations in Profile.location.
    long
    getLocationsLength()
    locations_length along with locations_start_index refers to a slice of locations in Profile.location.
    long
    getLocationsStartIndex()
    locations_start_index along with locations_length refers to to a slice of locations in Profile.location.
    int
    getStacktraceIdIndex()
    A 128bit id that uniquely identifies this stacktrace, globally.
    long
    getTimestampsUnixNano(int index)
    Timestamps associated with Sample represented in nanoseconds.
    int
    getTimestampsUnixNanoCount()
    Timestamps associated with Sample represented in nanoseconds.
    List<Long>
    getTimestampsUnixNanoList()
    Timestamps associated with Sample represented in nanoseconds.
    long
    getValue(int index)
    The type and unit of each value is defined by the corresponding entry in Profile.sample_type.
    int
    getValueCount()
    The type and unit of each value is defined by the corresponding entry in Profile.sample_type.
    List<Long>
    getValueList()
    The type and unit of each value is defined by the corresponding entry in Profile.sample_type.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getLocationIndexList

      List<Long> getLocationIndexList()
       The indices recorded here correspond to locations in Profile.location.
 The leaf is at location_index[0]. [deprecated, superseded by locations_start_index / locations_length]
      repeated uint64 location_index = 1;
      Returns:
      A list containing the locationIndex.

    • getLocationIndexCount

      int getLocationIndexCount()
       The indices recorded here correspond to locations in Profile.location.
 The leaf is at location_index[0]. [deprecated, superseded by locations_start_index / locations_length]
      repeated uint64 location_index = 1;
      Returns:
      The count of locationIndex.

    • getLocationIndex

      long getLocationIndex(int index)
       The indices recorded here correspond to locations in Profile.location.
 The leaf is at location_index[0]. [deprecated, superseded by locations_start_index / locations_length]
      repeated uint64 location_index = 1;
      Parameters:
      index - The index of the element to return.
      Returns:
      The locationIndex at the given index.

    • getLocationsStartIndex

      long getLocationsStartIndex()
       locations_start_index along with locations_length refers to to a slice of locations in Profile.location.
 Supersedes location_index.
      uint64 locations_start_index = 7;
      Returns:
      The locationsStartIndex.

    • getLocationsLength

      long getLocationsLength()
       locations_length along with locations_start_index refers to a slice of locations in Profile.location.
 Supersedes location_index.
      uint64 locations_length = 8;
      Returns:
      The locationsLength.

    • getStacktraceIdIndex

      int getStacktraceIdIndex()
       A 128bit id that uniquely identifies this stacktrace, globally. Index into string table. [optional]
      uint32 stacktrace_id_index = 9;
      Returns:
      The stacktraceIdIndex.

    • getValueList

      List<Long> getValueList()
       The type and unit of each value is defined by the corresponding
 entry in Profile.sample_type. All samples must have the same
 number of values, the same as the length of Profile.sample_type.
 When aggregating multiple samples into a single sample, the
 result has a list of values that is the element-wise sum of the
 lists of the originals.
      repeated int64 value = 2;
      Returns:
      A list containing the value.

    • getValueCount

      int getValueCount()
       The type and unit of each value is defined by the corresponding
 entry in Profile.sample_type. All samples must have the same
 number of values, the same as the length of Profile.sample_type.
 When aggregating multiple samples into a single sample, the
 result has a list of values that is the element-wise sum of the
 lists of the originals.
      repeated int64 value = 2;
      Returns:
      The count of value.

    • getValue

      long getValue(int index)
       The type and unit of each value is defined by the corresponding
 entry in Profile.sample_type. All samples must have the same
 number of values, the same as the length of Profile.sample_type.
 When aggregating multiple samples into a single sample, the
 result has a list of values that is the element-wise sum of the
 lists of the originals.
      repeated int64 value = 2;
      Parameters:
      index - The index of the element to return.
      Returns:
      The value at the given index.

    • getLabelList

      List<Label> getLabelList()
       label includes additional context for this sample. It can include
 things like a thread id, allocation size, etc.

 NOTE: While possible, having multiple values for the same label key is
 strongly discouraged and should never be used. Most tools (e.g. pprof) do
 not have good (or any) support for multi-value labels. And an even more
 discouraged case is having a string label and a numeric label of the same
 name on a sample.  Again, possible to express, but should not be used.
 [deprecated, superseded by attributes]
      repeated .opentelemetry.proto.profiles.v1experimental.Label label = 3;

    • getLabel

      Label getLabel(int index)
       label includes additional context for this sample. It can include
 things like a thread id, allocation size, etc.

 NOTE: While possible, having multiple values for the same label key is
 strongly discouraged and should never be used. Most tools (e.g. pprof) do
 not have good (or any) support for multi-value labels. And an even more
 discouraged case is having a string label and a numeric label of the same
 name on a sample.  Again, possible to express, but should not be used.
 [deprecated, superseded by attributes]
      repeated .opentelemetry.proto.profiles.v1experimental.Label label = 3;

    • getLabelCount

      int getLabelCount()
       label includes additional context for this sample. It can include
 things like a thread id, allocation size, etc.

 NOTE: While possible, having multiple values for the same label key is
 strongly discouraged and should never be used. Most tools (e.g. pprof) do
 not have good (or any) support for multi-value labels. And an even more
 discouraged case is having a string label and a numeric label of the same
 name on a sample.  Again, possible to express, but should not be used.
 [deprecated, superseded by attributes]
      repeated .opentelemetry.proto.profiles.v1experimental.Label label = 3;

    • getLabelOrBuilderList

      List<? extends LabelOrBuilder> getLabelOrBuilderList()
       label includes additional context for this sample. It can include
 things like a thread id, allocation size, etc.

 NOTE: While possible, having multiple values for the same label key is
 strongly discouraged and should never be used. Most tools (e.g. pprof) do
 not have good (or any) support for multi-value labels. And an even more
 discouraged case is having a string label and a numeric label of the same
 name on a sample.  Again, possible to express, but should not be used.
 [deprecated, superseded by attributes]
      repeated .opentelemetry.proto.profiles.v1experimental.Label label = 3;

    • getLabelOrBuilder

      LabelOrBuilder getLabelOrBuilder(int index)
       label includes additional context for this sample. It can include
 things like a thread id, allocation size, etc.

 NOTE: While possible, having multiple values for the same label key is
 strongly discouraged and should never be used. Most tools (e.g. pprof) do
 not have good (or any) support for multi-value labels. And an even more
 discouraged case is having a string label and a numeric label of the same
 name on a sample.  Again, possible to express, but should not be used.
 [deprecated, superseded by attributes]
      repeated .opentelemetry.proto.profiles.v1experimental.Label label = 3;

    • getAttributesList

      List<Long> getAttributesList()
       References to attributes in Profile.attribute_table. [optional]
      repeated uint64 attributes = 10;
      Returns:
      A list containing the attributes.

    • getAttributesCount

      int getAttributesCount()
       References to attributes in Profile.attribute_table. [optional]
      repeated uint64 attributes = 10;
      Returns:
      The count of attributes.

    • getAttributes

      long getAttributes(int index)
       References to attributes in Profile.attribute_table. [optional]
      repeated uint64 attributes = 10;
      Parameters:
      index - The index of the element to return.
      Returns:
      The attributes at the given index.

    • getLink

      long getLink()
       Reference to link in Profile.link_table. [optional]
      uint64 link = 12;
      Returns:
      The link.

    • getTimestampsUnixNanoList

      List<Long> getTimestampsUnixNanoList()
       Timestamps associated with Sample represented in nanoseconds. These timestamps are expected
 to fall within the Profile's time range. [optional]
      repeated uint64 timestamps_unix_nano = 13;
      Returns:
      A list containing the timestampsUnixNano.

    • getTimestampsUnixNanoCount

      int getTimestampsUnixNanoCount()
       Timestamps associated with Sample represented in nanoseconds. These timestamps are expected
 to fall within the Profile's time range. [optional]
      repeated uint64 timestamps_unix_nano = 13;
      Returns:
      The count of timestampsUnixNano.

    • getTimestampsUnixNano

      long getTimestampsUnixNano(int index)
       Timestamps associated with Sample represented in nanoseconds. These timestamps are expected
 to fall within the Profile's time range. [optional]
      repeated uint64 timestamps_unix_nano = 13;
      Parameters:
      index - The index of the element to return.
      Returns:
      The timestampsUnixNano at the given index.