Package com.cognite.client.dto

Class TimeseriesMetadata

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

The time series header.
Protobuf type com.cognite.client.dto.TimeseriesMetadata
See Also:

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

    • NAME_FIELD_NUMBER

      public static final int NAME_FIELD_NUMBER
      See Also:

    • DESCRIPTION_FIELD_NUMBER

      public static final int DESCRIPTION_FIELD_NUMBER
      See Also:

    • IS_STRING_FIELD_NUMBER

      public static final int IS_STRING_FIELD_NUMBER
      See Also:

    • IS_STEP_FIELD_NUMBER

      public static final int IS_STEP_FIELD_NUMBER
      See Also:

    • UNIT_FIELD_NUMBER

      public static final int UNIT_FIELD_NUMBER
      See Also:

    • ASSET_ID_FIELD_NUMBER

      public static final int ASSET_ID_FIELD_NUMBER
      See Also:

    • SECURITY_CATEGORIES_FIELD_NUMBER

      public static final int SECURITY_CATEGORIES_FIELD_NUMBER
      See Also:

    • CREATED_TIME_FIELD_NUMBER

      public static final int CREATED_TIME_FIELD_NUMBER
      See Also:

    • LAST_UPDATED_TIME_FIELD_NUMBER

      public static final int LAST_UPDATED_TIME_FIELD_NUMBER
      See Also:

    • METADATA_FIELD_NUMBER

      public static final int METADATA_FIELD_NUMBER
      See Also:

    • DATA_SET_ID_FIELD_NUMBER

      public static final int DATA_SET_ID_FIELD_NUMBER
      See Also:

    • UNIT_EXTERNAL_ID_FIELD_NUMBER

      public static final int UNIT_EXTERNAL_ID_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()

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

    • internalGetFieldAccessorTable

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

    • hasId

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

    • getId

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

    • hasExternalId

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

    • getExternalId

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

    • getExternalIdBytes

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

    • hasName

      public boolean hasName()
      optional string name = 3;
      Specified by:
      hasName in interface TimeseriesMetadataOrBuilder
      Returns:
      Whether the name field is set.

    • getName

      public String getName()
      optional string name = 3;
      Specified by:
      getName in interface TimeseriesMetadataOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
      optional string name = 3;
      Specified by:
      getNameBytes in interface TimeseriesMetadataOrBuilder
      Returns:
      The bytes for name.

    • hasDescription

      public boolean hasDescription()
      optional string description = 4;
      Specified by:
      hasDescription in interface TimeseriesMetadataOrBuilder
      Returns:
      Whether the description field is set.

    • getDescription

      public String getDescription()
      optional string description = 4;
      Specified by:
      getDescription in interface TimeseriesMetadataOrBuilder
      Returns:
      The description.

    • getDescriptionBytes

      public com.google.protobuf.ByteString getDescriptionBytes()
      optional string description = 4;
      Specified by:
      getDescriptionBytes in interface TimeseriesMetadataOrBuilder
      Returns:
      The bytes for description.

    • getIsString

      public boolean getIsString()
      bool is_string = 5;
      Specified by:
      getIsString in interface TimeseriesMetadataOrBuilder
      Returns:
      The isString.

    • getIsStep

      public boolean getIsStep()
      bool is_step = 6;
      Specified by:
      getIsStep in interface TimeseriesMetadataOrBuilder
      Returns:
      The isStep.

    • hasUnit

      public boolean hasUnit()
      optional string unit = 7;
      Specified by:
      hasUnit in interface TimeseriesMetadataOrBuilder
      Returns:
      Whether the unit field is set.

    • getUnit

      public String getUnit()
      optional string unit = 7;
      Specified by:
      getUnit in interface TimeseriesMetadataOrBuilder
      Returns:
      The unit.

    • getUnitBytes

      public com.google.protobuf.ByteString getUnitBytes()
      optional string unit = 7;
      Specified by:
      getUnitBytes in interface TimeseriesMetadataOrBuilder
      Returns:
      The bytes for unit.

    • hasAssetId

      public boolean hasAssetId()
      optional int64 asset_id = 8;
      Specified by:
      hasAssetId in interface TimeseriesMetadataOrBuilder
      Returns:
      Whether the assetId field is set.

    • getAssetId

      public long getAssetId()
      optional int64 asset_id = 8;
      Specified by:
      getAssetId in interface TimeseriesMetadataOrBuilder
      Returns:
      The assetId.

    • getSecurityCategoriesList

      public List<Long> getSecurityCategoriesList()
      repeated int64 security_categories = 9;
      Specified by:
      getSecurityCategoriesList in interface TimeseriesMetadataOrBuilder
      Returns:
      A list containing the securityCategories.

    • getSecurityCategoriesCount

      public int getSecurityCategoriesCount()
      repeated int64 security_categories = 9;
      Specified by:
      getSecurityCategoriesCount in interface TimeseriesMetadataOrBuilder
      Returns:
      The count of securityCategories.

    • getSecurityCategories

      public long getSecurityCategories(int index)
      repeated int64 security_categories = 9;
      Specified by:
      getSecurityCategories in interface TimeseriesMetadataOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The securityCategories at the given index.

    • hasCreatedTime

      public boolean hasCreatedTime()
      optional int64 created_time = 10;
      Specified by:
      hasCreatedTime in interface TimeseriesMetadataOrBuilder
      Returns:
      Whether the createdTime field is set.

    • getCreatedTime

      public long getCreatedTime()
      optional int64 created_time = 10;
      Specified by:
      getCreatedTime in interface TimeseriesMetadataOrBuilder
      Returns:
      The createdTime.

    • hasLastUpdatedTime

      public boolean hasLastUpdatedTime()
      optional int64 last_updated_time = 11;
      Specified by:
      hasLastUpdatedTime in interface TimeseriesMetadataOrBuilder
      Returns:
      Whether the lastUpdatedTime field is set.

    • getLastUpdatedTime

      public long getLastUpdatedTime()
      optional int64 last_updated_time = 11;
      Specified by:
      getLastUpdatedTime in interface TimeseriesMetadataOrBuilder
      Returns:
      The lastUpdatedTime.

    • getMetadataCount

      public int getMetadataCount()
      Description copied from interface: TimeseriesMetadataOrBuilder
      map<string, string> metadata = 12;
      Specified by:
      getMetadataCount in interface TimeseriesMetadataOrBuilder

    • containsMetadata

      public boolean containsMetadata(String key)
      map<string, string> metadata = 12;
      Specified by:
      containsMetadata in interface TimeseriesMetadataOrBuilder

    • getMetadata

      @Deprecated public Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.
      Specified by:
      getMetadata in interface TimeseriesMetadataOrBuilder

    • getMetadataMap

      public Map<String,String> getMetadataMap()
      map<string, string> metadata = 12;
      Specified by:
      getMetadataMap in interface TimeseriesMetadataOrBuilder

    • getMetadataOrDefault

      public String getMetadataOrDefault(String key, String defaultValue)
      map<string, string> metadata = 12;
      Specified by:
      getMetadataOrDefault in interface TimeseriesMetadataOrBuilder

    • getMetadataOrThrow

      public String getMetadataOrThrow(String key)
      map<string, string> metadata = 12;
      Specified by:
      getMetadataOrThrow in interface TimeseriesMetadataOrBuilder

    • hasDataSetId

      public boolean hasDataSetId()
      optional int64 data_set_id = 13;
      Specified by:
      hasDataSetId in interface TimeseriesMetadataOrBuilder
      Returns:
      Whether the dataSetId field is set.

    • getDataSetId

      public long getDataSetId()
      optional int64 data_set_id = 13;
      Specified by:
      getDataSetId in interface TimeseriesMetadataOrBuilder
      Returns:
      The dataSetId.

    • hasUnitExternalId

      public boolean hasUnitExternalId()
      optional string unit_external_id = 14;
      Specified by:
      hasUnitExternalId in interface TimeseriesMetadataOrBuilder
      Returns:
      Whether the unitExternalId field is set.

    • getUnitExternalId

      public String getUnitExternalId()
      optional string unit_external_id = 14;
      Specified by:
      getUnitExternalId in interface TimeseriesMetadataOrBuilder
      Returns:
      The unitExternalId.

    • getUnitExternalIdBytes

      public com.google.protobuf.ByteString getUnitExternalIdBytes()
      optional string unit_external_id = 14;
      Specified by:
      getUnitExternalIdBytes in interface TimeseriesMetadataOrBuilder
      Returns:
      The bytes for unitExternalId.

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static TimeseriesMetadata.Builder newBuilder()

    • newBuilder

      public static TimeseriesMetadata.Builder newBuilder(TimeseriesMetadata prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static TimeseriesMetadata getDefaultInstance()

    • parser

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

    • getParserForType

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