Package io.opentelemetry.proto.common.v1

Class EntityRef

java.lang.Object
com.google.protobuf.AbstractMessageLite<MessageType,BuilderType>
com.google.protobuf.GeneratedMessageLite<EntityRef,EntityRef.Builder>
io.opentelemetry.proto.common.v1.EntityRef
All Implemented Interfaces:
com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, EntityRefOrBuilder
public final class EntityRef extends com.google.protobuf.GeneratedMessageLite<EntityRef,EntityRef.Builder> implements EntityRefOrBuilder
 A reference to an Entity.
 Entity represents an object of interest associated with produced telemetry: e.g spans, metrics, profiles, or logs.

 Status: [Development]
Protobuf type opentelemetry.proto.common.v1.EntityRef

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    EntityRef.Builder
    A reference to an Entity.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageLite

    com.google.protobuf.GeneratedMessageLite.DefaultInstanceBasedParser<T extends com.google.protobuf.GeneratedMessageLite<T,?>>, com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageLite.ExtendableMessage<MessageType,BuilderType>,BuilderType extends com.google.protobuf.GeneratedMessageLite.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageLite.GeneratedExtension<ContainingType extends com.google.protobuf.MessageLite,Type extends Object>, com.google.protobuf.GeneratedMessageLite.MethodToInvoke, com.google.protobuf.GeneratedMessageLite.SerializedForm

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    DESCRIPTION_KEYS_FIELD_NUMBER
     
    static final int
    ID_KEYS_FIELD_NUMBER
     
    static final int
    SCHEMA_URL_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageLite

    unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    protected final Object
    dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
     
    static EntityRef
    getDefaultInstance()
     
    String
    getDescriptionKeys(int index)
    Descriptive (non-identifying) attribute keys of the entity.
    com.google.protobuf.ByteString
    getDescriptionKeysBytes(int index)
    Descriptive (non-identifying) attribute keys of the entity.
    int
    getDescriptionKeysCount()
    Descriptive (non-identifying) attribute keys of the entity.
    List<String>
    getDescriptionKeysList()
    Descriptive (non-identifying) attribute keys of the entity.
    String
    getIdKeys(int index)
    Attribute Keys that identify the entity.
    com.google.protobuf.ByteString
    getIdKeysBytes(int index)
    Attribute Keys that identify the entity.
    int
    getIdKeysCount()
    Attribute Keys that identify the entity.
    List<String>
    getIdKeysList()
    Attribute Keys that identify the entity.
    String
    getSchemaUrl()
    The Schema URL, if known.
    com.google.protobuf.ByteString
    getSchemaUrlBytes()
    The Schema URL, if known.
    String
    getType()
    Defines the type of the entity.
    com.google.protobuf.ByteString
    getTypeBytes()
    Defines the type of the entity.
    static EntityRef.Builder
    newBuilder()
     
    static EntityRef.Builder
    newBuilder(EntityRef prototype)
     
    static EntityRef
    parseDelimitedFrom(InputStream input)
     
    static EntityRef
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EntityRef
    parseFrom(byte[] data)
     
    static EntityRef
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EntityRef
    parseFrom(com.google.protobuf.ByteString data)
     
    static EntityRef
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EntityRef
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static EntityRef
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EntityRef
    parseFrom(InputStream input)
     
    static EntityRef
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static EntityRef
    parseFrom(ByteBuffer data)
     
    static EntityRef
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<EntityRef>
    parser()
     

    Methods inherited from class com.google.protobuf.GeneratedMessageLite

    createBuilder, createBuilder, dynamicMethod, dynamicMethod, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, emptyProtobufList, equals, getDefaultInstanceForType, getParserForType, getSerializedSize, hashCode, isInitialized, isInitialized, makeImmutable, mergeLengthDelimitedField, mergeUnknownFields, mergeVarintField, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBuilderForType, newMessageInfo, newRepeatedGeneratedExtension, newSingularGeneratedExtension, parseDelimitedFrom, parseDelimitedFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parseFrom, parsePartialFrom, parseUnknownField, registerDefaultInstance, toBuilder, toString, writeTo

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Field Details

  • Method Details

    • getSchemaUrl

      public String getSchemaUrl()
       The Schema URL, if known. This is the identifier of the Schema that the entity data
 is recorded in. To learn more about Schema URL see
 https://opentelemetry.io/docs/specs/otel/schemas/#schema-url

 This schema_url applies to the data in this message and to the Resource attributes
 referenced by id_keys and description_keys.
 TODO: discuss if we are happy with this somewhat complicated definition of what
 the schema_url applies to.

 This field obsoletes the schema_url field in ResourceMetrics/ResourceSpans/ResourceLogs.
      string schema_url = 1 [json_name = "schemaUrl"];
      Specified by:
      getSchemaUrl in interface EntityRefOrBuilder
      Returns:
      The schemaUrl.

    • getSchemaUrlBytes

      public com.google.protobuf.ByteString getSchemaUrlBytes()
       The Schema URL, if known. This is the identifier of the Schema that the entity data
 is recorded in. To learn more about Schema URL see
 https://opentelemetry.io/docs/specs/otel/schemas/#schema-url

 This schema_url applies to the data in this message and to the Resource attributes
 referenced by id_keys and description_keys.
 TODO: discuss if we are happy with this somewhat complicated definition of what
 the schema_url applies to.

 This field obsoletes the schema_url field in ResourceMetrics/ResourceSpans/ResourceLogs.
      string schema_url = 1 [json_name = "schemaUrl"];
      Specified by:
      getSchemaUrlBytes in interface EntityRefOrBuilder
      Returns:
      The bytes for schemaUrl.

    • getType

      public String getType()
       Defines the type of the entity. MUST not change during the lifetime of the entity.
 For example: "service" or "host". This field is required and MUST not be empty
 for valid entities.
      string type = 2 [json_name = "type"];
      Specified by:
      getType in interface EntityRefOrBuilder
      Returns:
      The type.

    • getTypeBytes

      public com.google.protobuf.ByteString getTypeBytes()
       Defines the type of the entity. MUST not change during the lifetime of the entity.
 For example: "service" or "host". This field is required and MUST not be empty
 for valid entities.
      string type = 2 [json_name = "type"];
      Specified by:
      getTypeBytes in interface EntityRefOrBuilder
      Returns:
      The bytes for type.

    • getIdKeysList

      public List<String> getIdKeysList()
       Attribute Keys that identify the entity.
 MUST not change during the lifetime of the entity. The Id must contain at least one attribute.
 These keys MUST exist in the containing {message}.attributes.
      repeated string id_keys = 3 [json_name = "idKeys"];
      Specified by:
      getIdKeysList in interface EntityRefOrBuilder
      Returns:
      A list containing the idKeys.

    • getIdKeysCount

      public int getIdKeysCount()
       Attribute Keys that identify the entity.
 MUST not change during the lifetime of the entity. The Id must contain at least one attribute.
 These keys MUST exist in the containing {message}.attributes.
      repeated string id_keys = 3 [json_name = "idKeys"];
      Specified by:
      getIdKeysCount in interface EntityRefOrBuilder
      Returns:
      The count of idKeys.

    • getIdKeys

      public String getIdKeys(int index)
       Attribute Keys that identify the entity.
 MUST not change during the lifetime of the entity. The Id must contain at least one attribute.
 These keys MUST exist in the containing {message}.attributes.
      repeated string id_keys = 3 [json_name = "idKeys"];
      Specified by:
      getIdKeys in interface EntityRefOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The idKeys at the given index.

    • getIdKeysBytes

      public com.google.protobuf.ByteString getIdKeysBytes(int index)
       Attribute Keys that identify the entity.
 MUST not change during the lifetime of the entity. The Id must contain at least one attribute.
 These keys MUST exist in the containing {message}.attributes.
      repeated string id_keys = 3 [json_name = "idKeys"];
      Specified by:
      getIdKeysBytes in interface EntityRefOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the idKeys at the given index.

    • getDescriptionKeysList

      public List<String> getDescriptionKeysList()
       Descriptive (non-identifying) attribute keys of the entity.
 MAY change over the lifetime of the entity. MAY be empty.
 These attribute keys are not part of entity's identity.
 These keys MUST exist in the containing {message}.attributes.
      repeated string description_keys = 4 [json_name = "descriptionKeys"];
      Specified by:
      getDescriptionKeysList in interface EntityRefOrBuilder
      Returns:
      A list containing the descriptionKeys.

    • getDescriptionKeysCount

      public int getDescriptionKeysCount()
       Descriptive (non-identifying) attribute keys of the entity.
 MAY change over the lifetime of the entity. MAY be empty.
 These attribute keys are not part of entity's identity.
 These keys MUST exist in the containing {message}.attributes.
      repeated string description_keys = 4 [json_name = "descriptionKeys"];
      Specified by:
      getDescriptionKeysCount in interface EntityRefOrBuilder
      Returns:
      The count of descriptionKeys.

    • getDescriptionKeys

      public String getDescriptionKeys(int index)
       Descriptive (non-identifying) attribute keys of the entity.
 MAY change over the lifetime of the entity. MAY be empty.
 These attribute keys are not part of entity's identity.
 These keys MUST exist in the containing {message}.attributes.
      repeated string description_keys = 4 [json_name = "descriptionKeys"];
      Specified by:
      getDescriptionKeys in interface EntityRefOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The descriptionKeys at the given index.

    • getDescriptionKeysBytes

      public com.google.protobuf.ByteString getDescriptionKeysBytes(int index)
       Descriptive (non-identifying) attribute keys of the entity.
 MAY change over the lifetime of the entity. MAY be empty.
 These attribute keys are not part of entity's identity.
 These keys MUST exist in the containing {message}.attributes.
      repeated string description_keys = 4 [json_name = "descriptionKeys"];
      Specified by:
      getDescriptionKeysBytes in interface EntityRefOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the descriptionKeys at the given index.

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilder

      public static EntityRef.Builder newBuilder()

    • newBuilder

      public static EntityRef.Builder newBuilder(EntityRef prototype)

    • dynamicMethod

      protected final Object dynamicMethod(com.google.protobuf.GeneratedMessageLite.MethodToInvoke method, Object arg0, Object arg1)
      Specified by:
      dynamicMethod in class com.google.protobuf.GeneratedMessageLite<EntityRef,EntityRef.Builder>

    • getDefaultInstance

      public static EntityRef getDefaultInstance()

    • parser

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