Package io.opentelemetry.proto.profiles.v1experimental

Class ProfileContainer

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.opentelemetry.proto.profiles.v1experimental.ProfileContainer
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, ProfileContainerOrBuilder, Serializable
public final class ProfileContainer extends com.google.protobuf.GeneratedMessageV3 implements ProfileContainerOrBuilder
 A ProfileContainer represents a single profile. It wraps pprof profile with OpenTelemetry specific metadata.
Protobuf type opentelemetry.proto.profiles.v1experimental.ProfileContainer
See Also:

  • Field Details

    • PROFILE_ID_FIELD_NUMBER

      public static final int PROFILE_ID_FIELD_NUMBER
      See Also:

    • START_TIME_UNIX_NANO_FIELD_NUMBER

      public static final int START_TIME_UNIX_NANO_FIELD_NUMBER
      See Also:

    • END_TIME_UNIX_NANO_FIELD_NUMBER

      public static final int END_TIME_UNIX_NANO_FIELD_NUMBER
      See Also:

    • ATTRIBUTES_FIELD_NUMBER

      public static final int ATTRIBUTES_FIELD_NUMBER
      See Also:

    • DROPPED_ATTRIBUTES_COUNT_FIELD_NUMBER

      public static final int DROPPED_ATTRIBUTES_COUNT_FIELD_NUMBER
      See Also:

    • ORIGINAL_PAYLOAD_FORMAT_FIELD_NUMBER

      public static final int ORIGINAL_PAYLOAD_FORMAT_FIELD_NUMBER
      See Also:

    • ORIGINAL_PAYLOAD_FIELD_NUMBER

      public static final int ORIGINAL_PAYLOAD_FIELD_NUMBER
      See Also:

    • PROFILE_FIELD_NUMBER

      public static final int PROFILE_FIELD_NUMBER
      See Also:

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • 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

    • getProfileId

      public com.google.protobuf.ByteString getProfileId()
       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 = 1;
      Specified by:
      getProfileId in interface ProfileContainerOrBuilder
      Returns:
      The profileId.

    • getStartTimeUnixNano

      public long getStartTimeUnixNano()
       start_time_unix_nano is the start time of the profile.
 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

 This field is semantically required and it is expected that end_time >= start_time.
      fixed64 start_time_unix_nano = 2;
      Specified by:
      getStartTimeUnixNano in interface ProfileContainerOrBuilder
      Returns:
      The startTimeUnixNano.

    • getEndTimeUnixNano

      public long getEndTimeUnixNano()
       end_time_unix_nano is the end time of the profile.
 Value is UNIX Epoch time in nanoseconds since 00:00:00 UTC on 1 January 1970.

 This field is semantically required and it is expected that end_time >= start_time.
      fixed64 end_time_unix_nano = 3;
      Specified by:
      getEndTimeUnixNano in interface ProfileContainerOrBuilder
      Returns:
      The endTimeUnixNano.

    • getAttributesList

      public List<KeyValue> getAttributesList()
       attributes 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 .opentelemetry.proto.common.v1.KeyValue attributes = 4;
      Specified by:
      getAttributesList in interface ProfileContainerOrBuilder

    • getAttributesOrBuilderList

      public List<? extends KeyValueOrBuilder> getAttributesOrBuilderList()
       attributes 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 .opentelemetry.proto.common.v1.KeyValue attributes = 4;
      Specified by:
      getAttributesOrBuilderList in interface ProfileContainerOrBuilder

    • getAttributesCount

      public int getAttributesCount()
       attributes 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 .opentelemetry.proto.common.v1.KeyValue attributes = 4;
      Specified by:
      getAttributesCount in interface ProfileContainerOrBuilder

    • getAttributes

      public KeyValue getAttributes(int index)
       attributes 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 .opentelemetry.proto.common.v1.KeyValue attributes = 4;
      Specified by:
      getAttributes in interface ProfileContainerOrBuilder

    • getAttributesOrBuilder

      public KeyValueOrBuilder getAttributesOrBuilder(int index)
       attributes 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 .opentelemetry.proto.common.v1.KeyValue attributes = 4;
      Specified by:
      getAttributesOrBuilder in interface ProfileContainerOrBuilder

    • getDroppedAttributesCount

      public int getDroppedAttributesCount()
       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 = 5;
      Specified by:
      getDroppedAttributesCount in interface ProfileContainerOrBuilder
      Returns:
      The droppedAttributesCount.

    • getOriginalPayloadFormat

      public 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 = 6;
      Specified by:
      getOriginalPayloadFormat in interface ProfileContainerOrBuilder
      Returns:
      The originalPayloadFormat.

    • getOriginalPayloadFormatBytes

      public com.google.protobuf.ByteString getOriginalPayloadFormatBytes()
       Specifies format of the original payload. Common values are defined in semantic conventions. [required if original_payload is present]
      string original_payload_format = 6;
      Specified by:
      getOriginalPayloadFormatBytes in interface ProfileContainerOrBuilder
      Returns:
      The bytes for originalPayloadFormat.

    • getOriginalPayload

      public com.google.protobuf.ByteString getOriginalPayload()
       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 `profile` MUST be present and contain the same profiling information.
      bytes original_payload = 7;
      Specified by:
      getOriginalPayload in interface ProfileContainerOrBuilder
      Returns:
      The originalPayload.

    • hasProfile

      public boolean hasProfile()
       This is a reference to a pprof profile. Required, even when original_payload is present.
      .opentelemetry.proto.profiles.v1experimental.Profile profile = 8;
      Specified by:
      hasProfile in interface ProfileContainerOrBuilder
      Returns:
      Whether the profile field is set.

    • getProfile

      public Profile getProfile()
       This is a reference to a pprof profile. Required, even when original_payload is present.
      .opentelemetry.proto.profiles.v1experimental.Profile profile = 8;
      Specified by:
      getProfile in interface ProfileContainerOrBuilder
      Returns:
      The profile.

    • getProfileOrBuilder

      public ProfileOrBuilder getProfileOrBuilder()
       This is a reference to a pprof profile. Required, even when original_payload is present.
      .opentelemetry.proto.profiles.v1experimental.Profile profile = 8;
      Specified by:
      getProfileOrBuilder in interface ProfileContainerOrBuilder

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static ProfileContainer parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProfileContainer parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProfileContainer parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProfileContainer parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProfileContainer parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProfileContainer parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static ProfileContainer parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProfileContainer parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ProfileContainer parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static ProfileContainer parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProfileContainer parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static ProfileContainer parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public ProfileContainer.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static ProfileContainer.Builder newBuilder()

    • newBuilder

      public static ProfileContainer.Builder newBuilder(ProfileContainer prototype)

    • toBuilder

      public ProfileContainer.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected ProfileContainer.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static ProfileContainer getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<ProfileContainer> parser()

    • getParserForType

      public com.google.protobuf.Parser<ProfileContainer> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public ProfileContainer getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder