Package io.opentelemetry.proto.common.v1

Interface EntityRefOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder
All Known Implementing Classes:
EntityRef, EntityRef.Builder
public interface EntityRefOrBuilder extends com.google.protobuf.MessageLiteOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    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.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    getDefaultInstanceForType, isInitialized

  • Method Details

    • getSchemaUrl

      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"];
      Returns:
      The schemaUrl.

    • getSchemaUrlBytes

      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"];
      Returns:
      The bytes for schemaUrl.

    • getType

      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"];
      Returns:
      The type.

    • getTypeBytes

      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"];
      Returns:
      The bytes for type.

    • getIdKeysList

      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"];
      Returns:
      A list containing the idKeys.

    • getIdKeysCount

      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"];
      Returns:
      The count of idKeys.

    • getIdKeys

      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"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The idKeys at the given index.

    • getIdKeysBytes

      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"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The idKeys at the given index.

    • getDescriptionKeysList

      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"];
      Returns:
      A list containing the descriptionKeys.

    • getDescriptionKeysCount

      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"];
      Returns:
      The count of descriptionKeys.

    • getDescriptionKeys

      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"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The descriptionKeys at the given index.

    • getDescriptionKeysBytes

      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"];
      Parameters:
      index - The index of the element to return.
      Returns:
      The descriptionKeys at the given index.