Package com.cognite.client.dto

Class Item

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
com.cognite.client.dto.Item
All Implemented Interfaces:
ItemOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
public final class Item extends com.google.protobuf.GeneratedMessageV3 implements ItemOrBuilder

Represents an identifiable data item independent of resource type (asset, event, time series, etc.).

The item is identified via externalId (primarily) or id (secondarily).

For time series data points there are two extra attributes, inclusiveBegin and exclusiveEnd, that pinpoints the
referenced time window.
Protobuf type com.cognite.client.dto.Item
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Item.Builder
    Represents an identifiable data item independent of resource type (asset, event, time series, etc.).
    static enum 
    Item.IdTypeCase
     

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

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    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
    EXCLUSIVE_END_FIELD_NUMBER
     
    static final int
    EXTERNAL_ID_FIELD_NUMBER
     
    static final int
    ID_FIELD_NUMBER
     
    static final int
    INCLUSIVE_BEGIN_FIELD_NUMBER
     
    static final int
    LEGACY_NAME_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, 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 Item
    getDefaultInstance()
     
    Item
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    long
    getExclusiveEnd()
    End of time window for a time series data point.
    String
    getExternalId()
    string external_id = 2;
    com.google.protobuf.ByteString
    getExternalIdBytes()
    string external_id = 2;
    long
    getId()
    int64 id = 1;
    Item.IdTypeCase
    getIdTypeCase()
     
    long
    getInclusiveBegin()
    Start of time window for a time series data point.
    String
    getLegacyName()
    string legacy_name = 3;
    com.google.protobuf.ByteString
    getLegacyNameBytes()
    string legacy_name = 3;
    com.google.protobuf.Parser<Item>
    getParserForType()
     
    int
    getSerializedSize()
     
    boolean
    hasExclusiveEnd()
    End of time window for a time series data point.
    boolean
    hasExternalId()
    string external_id = 2;
    int
    hashCode()
     
    boolean
    hasId()
    int64 id = 1;
    boolean
    hasInclusiveBegin()
    Start of time window for a time series data point.
    boolean
    hasLegacyName()
    string legacy_name = 3;
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Item.Builder
    newBuilder()
     
    static Item.Builder
    newBuilder(Item prototype)
     
    Item.Builder
    newBuilderForType()
     
    protected Item.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static Item
    parseDelimitedFrom(InputStream input)
     
    static Item
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Item
    parseFrom(byte[] data)
     
    static Item
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Item
    parseFrom(com.google.protobuf.ByteString data)
     
    static Item
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Item
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Item
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Item
    parseFrom(InputStream input)
     
    static Item
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Item
    parseFrom(ByteBuffer data)
     
    static Item
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Item>
    parser()
     
    Item.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, 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, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, 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

    • ID_FIELD_NUMBER

      public static final int ID_FIELD_NUMBER
      See Also:

    • EXTERNAL_ID_FIELD_NUMBER

      public static final int EXTERNAL_ID_FIELD_NUMBER
      See Also:

    • LEGACY_NAME_FIELD_NUMBER

      public static final int LEGACY_NAME_FIELD_NUMBER
      See Also:

    • INCLUSIVE_BEGIN_FIELD_NUMBER

      public static final int INCLUSIVE_BEGIN_FIELD_NUMBER
      See Also:

    • EXCLUSIVE_END_FIELD_NUMBER

      public static final int EXCLUSIVE_END_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

    • getIdTypeCase

      public Item.IdTypeCase getIdTypeCase()
      Specified by:
      getIdTypeCase in interface ItemOrBuilder

    • hasId

      public boolean hasId()
      int64 id = 1;
      Specified by:
      hasId in interface ItemOrBuilder
      Returns:
      Whether the id field is set.

    • getId

      public long getId()
      int64 id = 1;
      Specified by:
      getId in interface ItemOrBuilder
      Returns:
      The id.

    • hasExternalId

      public boolean hasExternalId()
      string external_id = 2;
      Specified by:
      hasExternalId in interface ItemOrBuilder
      Returns:
      Whether the externalId field is set.

    • getExternalId

      public String getExternalId()
      string external_id = 2;
      Specified by:
      getExternalId in interface ItemOrBuilder
      Returns:
      The externalId.

    • getExternalIdBytes

      public com.google.protobuf.ByteString getExternalIdBytes()
      string external_id = 2;
      Specified by:
      getExternalIdBytes in interface ItemOrBuilder
      Returns:
      The bytes for externalId.

    • hasLegacyName

      public boolean hasLegacyName()
      string legacy_name = 3;
      Specified by:
      hasLegacyName in interface ItemOrBuilder
      Returns:
      Whether the legacyName field is set.

    • getLegacyName

      public String getLegacyName()
      string legacy_name = 3;
      Specified by:
      getLegacyName in interface ItemOrBuilder
      Returns:
      The legacyName.

    • getLegacyNameBytes

      public com.google.protobuf.ByteString getLegacyNameBytes()
      string legacy_name = 3;
      Specified by:
      getLegacyNameBytes in interface ItemOrBuilder
      Returns:
      The bytes for legacyName.

    • hasInclusiveBegin

      public boolean hasInclusiveBegin()
       Start of time window for a time series data point.
      optional int64 inclusive_begin = 4;
      Specified by:
      hasInclusiveBegin in interface ItemOrBuilder
      Returns:
      Whether the inclusiveBegin field is set.

    • getInclusiveBegin

      public long getInclusiveBegin()
       Start of time window for a time series data point.
      optional int64 inclusive_begin = 4;
      Specified by:
      getInclusiveBegin in interface ItemOrBuilder
      Returns:
      The inclusiveBegin.

    • hasExclusiveEnd

      public boolean hasExclusiveEnd()
       End of time window for a time series data point.
      optional int64 exclusive_end = 5;
      Specified by:
      hasExclusiveEnd in interface ItemOrBuilder
      Returns:
      Whether the exclusiveEnd field is set.

    • getExclusiveEnd

      public long getExclusiveEnd()
       End of time window for a time series data point.
      optional int64 exclusive_end = 5;
      Specified by:
      getExclusiveEnd in interface ItemOrBuilder
      Returns:
      The exclusiveEnd.

    • 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 Item parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Item.Builder newBuilder()

    • newBuilder

      public static Item.Builder newBuilder(Item prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Item getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Item> 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 Item getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder