io.opentelemetry.proto.profiles.v1experimental.SampleOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of open-telemetry-protocol Show documentation
Open Telemetry protocol for building storage integrations
The newest version!
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: opentelemetry/proto/profiles/v1experimental/pprofextended.proto

package io.opentelemetry.proto.profiles.v1experimental;

public interface SampleOrBuilder extends
    // @@protoc_insertion_point(interface_extends:opentelemetry.proto.profiles.v1experimental.Sample)
    com.google.protobuf.MessageOrBuilder {

  /**
   *    * 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;
   * @return A list containing the locationIndex.
   */
  java.util.List 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;
   * @return The count of locationIndex.
   */
  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;
   * @param index The index of the element to return.
   * @return The locationIndex at the given index.
   */
  long getLocationIndex(int index);

  /**
   *    * 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;
   * @return The locationsStartIndex.
   */
  long getLocationsStartIndex();

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

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

  /**
   *    * 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;
   * @return A list containing the value.
   */
  java.util.List 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;
   * @return The count of value.
   */
  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;
   * @param index The index of the element to return.
   * @return The value at the given index.
   */
  long getValue(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;
   */
  java.util.List 
      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;
   */
  io.opentelemetry.proto.profiles.v1experimental.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;
   */
  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;
   */
  java.util.List 
      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;
   */
  io.opentelemetry.proto.profiles.v1experimental.LabelOrBuilder getLabelOrBuilder(
      int index);

  /**
   *    * References to attributes in Profile.attribute_table. [optional]
   * 
   *
   * repeated uint64 attributes = 10;
   * @return A list containing the attributes.
   */
  java.util.List getAttributesList();
  /**
   *    * References to attributes in Profile.attribute_table. [optional]
   * 
   *
   * repeated uint64 attributes = 10;
   * @return The count of attributes.
   */
  int getAttributesCount();
  /**
   *    * References to attributes in Profile.attribute_table. [optional]
   * 
   *
   * repeated uint64 attributes = 10;
   * @param index The index of the element to return.
   * @return The attributes at the given index.
   */
  long getAttributes(int index);

  /**
   *    * Reference to link in Profile.link_table. [optional]
   * 
   *
   * uint64 link = 12;
   * @return The link.
   */
  long getLink();

  /**
   *    * 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;
   * @return A list containing the timestampsUnixNano.
   */
  java.util.List 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;
   * @return The count of timestampsUnixNano.
   */
  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;
   * @param index The index of the element to return.
   * @return The timestampsUnixNano at the given index.
   */
  long getTimestampsUnixNano(int index);
}