Package io.opentelemetry.proto.common.v1

Class EntityRef

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
io.opentelemetry.proto.common.v1.EntityRef
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, EntityRefOrBuilder, Serializable
@Generated public final class EntityRef extends com.google.protobuf.GeneratedMessage 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
See Also:

  • 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.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

    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.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static EntityRef
    getDefaultInstance()
     
    EntityRef
    getDefaultInstanceForType()
     
    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.
    com.google.protobuf.ProtocolStringList
    getDescriptionKeysList()
    Descriptive (non-identifying) attribute keys of the entity.
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    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.
    com.google.protobuf.ProtocolStringList
    getIdKeysList()
    Attribute Keys that identify the entity.
    com.google.protobuf.Parser<EntityRef>
    getParserForType()
     
    String
    getSchemaUrl()
    The Schema URL, if known.
    com.google.protobuf.ByteString
    getSchemaUrlBytes()
    The Schema URL, if known.
    int
    getSerializedSize()
     
    String
    getType()
    Defines the type of the entity.
    com.google.protobuf.ByteString
    getTypeBytes()
    Defines the type of the entity.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static EntityRef.Builder
    newBuilder()
     
    static EntityRef.Builder
    newBuilder(EntityRef prototype)
     
    EntityRef.Builder
    newBuilderForType()
     
    protected EntityRef.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    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()
     
    EntityRef.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage

    • 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;
      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;
      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;
      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;
      Specified by:
      getTypeBytes in interface EntityRefOrBuilder
      Returns:
      The bytes for type.

    • getIdKeysList

      public com.google.protobuf.ProtocolStringList 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;
      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;
      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;
      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;
      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 com.google.protobuf.ProtocolStringList 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;
      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;
      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;
      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;
      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.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 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

    • newBuilderForType

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

    • newBuilder

      public static EntityRef.Builder newBuilder()

    • newBuilder

      public static EntityRef.Builder newBuilder(EntityRef prototype)

    • toBuilder

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

    • newBuilderForType

      protected EntityRef.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static EntityRef getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<EntityRef> 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.GeneratedMessage

    • getDefaultInstanceForType

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