
io.opentelemetry.proto.profiles.v1development.ProfileOrBuilder Maven / Gradle / Ivy
The newest version!
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: opentelemetry/proto/profiles/v1development/profiles.proto
// Protobuf Java Version: 3.25.1
package io.opentelemetry.proto.profiles.v1development;
public interface ProfileOrBuilder extends
// @@protoc_insertion_point(interface_extends:opentelemetry.proto.profiles.v1development.Profile)
com.google.protobuf.MessageOrBuilder {
/**
*
* A description of the samples associated with each Sample.value.
* For a cpu profile this might be:
* [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
* For a heap profile, this might be:
* [["allocations","count"], ["space","bytes"]],
* If one of the values represents the number of events represented
* by the sample, by convention it should be at index 0 and use
* sample_type.unit == "count".
*
*
* repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;
*/
java.util.List
getSampleTypeList();
/**
*
* A description of the samples associated with each Sample.value.
* For a cpu profile this might be:
* [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
* For a heap profile, this might be:
* [["allocations","count"], ["space","bytes"]],
* If one of the values represents the number of events represented
* by the sample, by convention it should be at index 0 and use
* sample_type.unit == "count".
*
*
* repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;
*/
io.opentelemetry.proto.profiles.v1development.ValueType getSampleType(int index);
/**
*
* A description of the samples associated with each Sample.value.
* For a cpu profile this might be:
* [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
* For a heap profile, this might be:
* [["allocations","count"], ["space","bytes"]],
* If one of the values represents the number of events represented
* by the sample, by convention it should be at index 0 and use
* sample_type.unit == "count".
*
*
* repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;
*/
int getSampleTypeCount();
/**
*
* A description of the samples associated with each Sample.value.
* For a cpu profile this might be:
* [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
* For a heap profile, this might be:
* [["allocations","count"], ["space","bytes"]],
* If one of the values represents the number of events represented
* by the sample, by convention it should be at index 0 and use
* sample_type.unit == "count".
*
*
* repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;
*/
java.util.List extends io.opentelemetry.proto.profiles.v1development.ValueTypeOrBuilder>
getSampleTypeOrBuilderList();
/**
*
* A description of the samples associated with each Sample.value.
* For a cpu profile this might be:
* [["cpu","nanoseconds"]] or [["wall","seconds"]] or [["syscall","count"]]
* For a heap profile, this might be:
* [["allocations","count"], ["space","bytes"]],
* If one of the values represents the number of events represented
* by the sample, by convention it should be at index 0 and use
* sample_type.unit == "count".
*
*
* repeated .opentelemetry.proto.profiles.v1development.ValueType sample_type = 1;
*/
io.opentelemetry.proto.profiles.v1development.ValueTypeOrBuilder getSampleTypeOrBuilder(
int index);
/**
*
* The set of samples recorded in this profile.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;
*/
java.util.List
getSampleList();
/**
*
* The set of samples recorded in this profile.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;
*/
io.opentelemetry.proto.profiles.v1development.Sample getSample(int index);
/**
*
* The set of samples recorded in this profile.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;
*/
int getSampleCount();
/**
*
* The set of samples recorded in this profile.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;
*/
java.util.List extends io.opentelemetry.proto.profiles.v1development.SampleOrBuilder>
getSampleOrBuilderList();
/**
*
* The set of samples recorded in this profile.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Sample sample = 2;
*/
io.opentelemetry.proto.profiles.v1development.SampleOrBuilder getSampleOrBuilder(
int index);
/**
*
* Mapping from address ranges to the image/binary/library mapped
* into that address range. mapping[0] will be the main binary.
* If multiple binaries contribute to the Profile and no main
* binary can be identified, mapping[0] has no special meaning.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;
*/
java.util.List
getMappingTableList();
/**
*
* Mapping from address ranges to the image/binary/library mapped
* into that address range. mapping[0] will be the main binary.
* If multiple binaries contribute to the Profile and no main
* binary can be identified, mapping[0] has no special meaning.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;
*/
io.opentelemetry.proto.profiles.v1development.Mapping getMappingTable(int index);
/**
*
* Mapping from address ranges to the image/binary/library mapped
* into that address range. mapping[0] will be the main binary.
* If multiple binaries contribute to the Profile and no main
* binary can be identified, mapping[0] has no special meaning.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;
*/
int getMappingTableCount();
/**
*
* Mapping from address ranges to the image/binary/library mapped
* into that address range. mapping[0] will be the main binary.
* If multiple binaries contribute to the Profile and no main
* binary can be identified, mapping[0] has no special meaning.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;
*/
java.util.List extends io.opentelemetry.proto.profiles.v1development.MappingOrBuilder>
getMappingTableOrBuilderList();
/**
*
* Mapping from address ranges to the image/binary/library mapped
* into that address range. mapping[0] will be the main binary.
* If multiple binaries contribute to the Profile and no main
* binary can be identified, mapping[0] has no special meaning.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Mapping mapping_table = 3;
*/
io.opentelemetry.proto.profiles.v1development.MappingOrBuilder getMappingTableOrBuilder(
int index);
/**
*
* Locations referenced by samples via location_indices.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;
*/
java.util.List
getLocationTableList();
/**
*
* Locations referenced by samples via location_indices.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;
*/
io.opentelemetry.proto.profiles.v1development.Location getLocationTable(int index);
/**
*
* Locations referenced by samples via location_indices.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;
*/
int getLocationTableCount();
/**
*
* Locations referenced by samples via location_indices.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;
*/
java.util.List extends io.opentelemetry.proto.profiles.v1development.LocationOrBuilder>
getLocationTableOrBuilderList();
/**
*
* Locations referenced by samples via location_indices.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Location location_table = 4;
*/
io.opentelemetry.proto.profiles.v1development.LocationOrBuilder getLocationTableOrBuilder(
int index);
/**
*
* Array of locations referenced by samples.
*
*
* repeated int32 location_indices = 5;
* @return A list containing the locationIndices.
*/
java.util.List getLocationIndicesList();
/**
*
* Array of locations referenced by samples.
*
*
* repeated int32 location_indices = 5;
* @return The count of locationIndices.
*/
int getLocationIndicesCount();
/**
*
* Array of locations referenced by samples.
*
*
* repeated int32 location_indices = 5;
* @param index The index of the element to return.
* @return The locationIndices at the given index.
*/
int getLocationIndices(int index);
/**
*
* Functions referenced by locations.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;
*/
java.util.List
getFunctionTableList();
/**
*
* Functions referenced by locations.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;
*/
io.opentelemetry.proto.profiles.v1development.Function getFunctionTable(int index);
/**
*
* Functions referenced by locations.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;
*/
int getFunctionTableCount();
/**
*
* Functions referenced by locations.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;
*/
java.util.List extends io.opentelemetry.proto.profiles.v1development.FunctionOrBuilder>
getFunctionTableOrBuilderList();
/**
*
* Functions referenced by locations.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Function function_table = 6;
*/
io.opentelemetry.proto.profiles.v1development.FunctionOrBuilder getFunctionTableOrBuilder(
int index);
/**
*
* Lookup table for attributes.
*
*
* repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;
*/
java.util.List
getAttributeTableList();
/**
*
* Lookup table for attributes.
*
*
* repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;
*/
io.opentelemetry.proto.common.v1.KeyValue getAttributeTable(int index);
/**
*
* Lookup table for attributes.
*
*
* repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;
*/
int getAttributeTableCount();
/**
*
* Lookup table for attributes.
*
*
* repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;
*/
java.util.List extends io.opentelemetry.proto.common.v1.KeyValueOrBuilder>
getAttributeTableOrBuilderList();
/**
*
* Lookup table for attributes.
*
*
* repeated .opentelemetry.proto.common.v1.KeyValue attribute_table = 7;
*/
io.opentelemetry.proto.common.v1.KeyValueOrBuilder getAttributeTableOrBuilder(
int index);
/**
*
* Represents a mapping between Attribute Keys and Units.
*
*
* repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;
*/
java.util.List
getAttributeUnitsList();
/**
*
* Represents a mapping between Attribute Keys and Units.
*
*
* repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;
*/
io.opentelemetry.proto.profiles.v1development.AttributeUnit getAttributeUnits(int index);
/**
*
* Represents a mapping between Attribute Keys and Units.
*
*
* repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;
*/
int getAttributeUnitsCount();
/**
*
* Represents a mapping between Attribute Keys and Units.
*
*
* repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;
*/
java.util.List extends io.opentelemetry.proto.profiles.v1development.AttributeUnitOrBuilder>
getAttributeUnitsOrBuilderList();
/**
*
* Represents a mapping between Attribute Keys and Units.
*
*
* repeated .opentelemetry.proto.profiles.v1development.AttributeUnit attribute_units = 8;
*/
io.opentelemetry.proto.profiles.v1development.AttributeUnitOrBuilder getAttributeUnitsOrBuilder(
int index);
/**
*
* Lookup table for links.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;
*/
java.util.List
getLinkTableList();
/**
*
* Lookup table for links.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;
*/
io.opentelemetry.proto.profiles.v1development.Link getLinkTable(int index);
/**
*
* Lookup table for links.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;
*/
int getLinkTableCount();
/**
*
* Lookup table for links.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;
*/
java.util.List extends io.opentelemetry.proto.profiles.v1development.LinkOrBuilder>
getLinkTableOrBuilderList();
/**
*
* Lookup table for links.
*
*
* repeated .opentelemetry.proto.profiles.v1development.Link link_table = 9;
*/
io.opentelemetry.proto.profiles.v1development.LinkOrBuilder getLinkTableOrBuilder(
int index);
/**
*
* A common table for strings referenced by various messages.
* string_table[0] must always be "".
*
*
* repeated string string_table = 10;
* @return A list containing the stringTable.
*/
java.util.List
getStringTableList();
/**
*
* A common table for strings referenced by various messages.
* string_table[0] must always be "".
*
*
* repeated string string_table = 10;
* @return The count of stringTable.
*/
int getStringTableCount();
/**
*
* A common table for strings referenced by various messages.
* string_table[0] must always be "".
*
*
* repeated string string_table = 10;
* @param index The index of the element to return.
* @return The stringTable at the given index.
*/
java.lang.String getStringTable(int index);
/**
*
* A common table for strings referenced by various messages.
* string_table[0] must always be "".
*
*
* repeated string string_table = 10;
* @param index The index of the value to return.
* @return The bytes of the stringTable at the given index.
*/
com.google.protobuf.ByteString
getStringTableBytes(int index);
/**
*
* Time of collection (UTC) represented as nanoseconds past the epoch.
*
*
* int64 time_nanos = 11;
* @return The timeNanos.
*/
long getTimeNanos();
/**
*
* Duration of the profile, if a duration makes sense.
*
*
* int64 duration_nanos = 12;
* @return The durationNanos.
*/
long getDurationNanos();
/**
*
* The kind of events between sampled occurrences.
* e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
*
*
* .opentelemetry.proto.profiles.v1development.ValueType period_type = 13;
* @return Whether the periodType field is set.
*/
boolean hasPeriodType();
/**
*
* The kind of events between sampled occurrences.
* e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
*
*
* .opentelemetry.proto.profiles.v1development.ValueType period_type = 13;
* @return The periodType.
*/
io.opentelemetry.proto.profiles.v1development.ValueType getPeriodType();
/**
*
* The kind of events between sampled occurrences.
* e.g [ "cpu","cycles" ] or [ "heap","bytes" ]
*
*
* .opentelemetry.proto.profiles.v1development.ValueType period_type = 13;
*/
io.opentelemetry.proto.profiles.v1development.ValueTypeOrBuilder getPeriodTypeOrBuilder();
/**
*
* The number of events between sampled occurrences.
*
*
* int64 period = 14;
* @return The period.
*/
long getPeriod();
/**
*
* Free-form text associated with the profile. The text is displayed as is
* to the user by the tools that read profiles (e.g. by pprof). This field
* should not be used to store any machine-readable information, it is only
* for human-friendly content. The profile must stay functional if this field
* is cleaned.
*
*
* repeated int32 comment_strindices = 15;
* @return A list containing the commentStrindices.
*/
java.util.List getCommentStrindicesList();
/**
*
* Free-form text associated with the profile. The text is displayed as is
* to the user by the tools that read profiles (e.g. by pprof). This field
* should not be used to store any machine-readable information, it is only
* for human-friendly content. The profile must stay functional if this field
* is cleaned.
*
*
* repeated int32 comment_strindices = 15;
* @return The count of commentStrindices.
*/
int getCommentStrindicesCount();
/**
*
* Free-form text associated with the profile. The text is displayed as is
* to the user by the tools that read profiles (e.g. by pprof). This field
* should not be used to store any machine-readable information, it is only
* for human-friendly content. The profile must stay functional if this field
* is cleaned.
*
*
* repeated int32 comment_strindices = 15;
* @param index The index of the element to return.
* @return The commentStrindices at the given index.
*/
int getCommentStrindices(int index);
/**
*
* Index into the string table of the type of the preferred sample
* value. If unset, clients should default to the last sample value.
*
*
* int32 default_sample_type_strindex = 16;
* @return The defaultSampleTypeStrindex.
*/
int getDefaultSampleTypeStrindex();
/**
*
* A globally unique identifier for a profile. The ID is a 16-byte array. An ID with
* all zeroes is considered invalid.
*
* This field is required.
*
*
* bytes profile_id = 17;
* @return The profileId.
*/
com.google.protobuf.ByteString getProfileId();
/**
*
* dropped_attributes_count is the number of attributes that were discarded. Attributes
* can be discarded because their keys are too long or because there are too many
* attributes. If this value is 0, then no attributes were dropped.
*
*
* uint32 dropped_attributes_count = 19;
* @return The droppedAttributesCount.
*/
int getDroppedAttributesCount();
/**
*
* Specifies format of the original payload. Common values are defined in semantic conventions. [required if original_payload is present]
*
*
* string original_payload_format = 20;
* @return The originalPayloadFormat.
*/
java.lang.String getOriginalPayloadFormat();
/**
*
* Specifies format of the original payload. Common values are defined in semantic conventions. [required if original_payload is present]
*
*
* string original_payload_format = 20;
* @return The bytes for originalPayloadFormat.
*/
com.google.protobuf.ByteString
getOriginalPayloadFormatBytes();
/**
*
* Original payload can be stored in this field. This can be useful for users who want to get the original payload.
* Formats such as JFR are highly extensible and can contain more information than what is defined in this spec.
* Inclusion of original payload should be configurable by the user. Default behavior should be to not include the original payload.
* If the original payload is in pprof format, it SHOULD not be included in this field.
* The field is optional, however if it is present then equivalent converted data should be populated in other fields
* of this message as far as is practicable.
*
*
* bytes original_payload = 21;
* @return The originalPayload.
*/
com.google.protobuf.ByteString getOriginalPayload();
/**
*
* References to attributes in attribute_table. [optional]
* It is a collection of key/value pairs. Note, global attributes
* like server name can be set using the resource API. Examples of attributes:
*
* "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
* "/http/server_latency": 300
* "abc.com/myattribute": true
* "abc.com/score": 10.239
*
* The OpenTelemetry API specification further restricts the allowed value types:
* https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
* Attribute keys MUST be unique (it is not allowed to have more than one
* attribute with the same key).
*
*
* repeated int32 attribute_indices = 22;
* @return A list containing the attributeIndices.
*/
java.util.List getAttributeIndicesList();
/**
*
* References to attributes in attribute_table. [optional]
* It is a collection of key/value pairs. Note, global attributes
* like server name can be set using the resource API. Examples of attributes:
*
* "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
* "/http/server_latency": 300
* "abc.com/myattribute": true
* "abc.com/score": 10.239
*
* The OpenTelemetry API specification further restricts the allowed value types:
* https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
* Attribute keys MUST be unique (it is not allowed to have more than one
* attribute with the same key).
*
*
* repeated int32 attribute_indices = 22;
* @return The count of attributeIndices.
*/
int getAttributeIndicesCount();
/**
*
* References to attributes in attribute_table. [optional]
* It is a collection of key/value pairs. Note, global attributes
* like server name can be set using the resource API. Examples of attributes:
*
* "/http/user_agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_14_2) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/71.0.3578.98 Safari/537.36"
* "/http/server_latency": 300
* "abc.com/myattribute": true
* "abc.com/score": 10.239
*
* The OpenTelemetry API specification further restricts the allowed value types:
* https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute
* Attribute keys MUST be unique (it is not allowed to have more than one
* attribute with the same key).
*
*
* repeated int32 attribute_indices = 22;
* @param index The index of the element to return.
* @return The attributeIndices at the given index.
*/
int getAttributeIndices(int index);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy