Class Id (0.3.0)

public final class Id extends GeneratedMessage implements IdOrBuilder

Identifier to identify a UDM object like a UDM event, Entity, Collection. The full identifier for persistence is created by setting the 32 most significant bits as the Id.Namespace enum This is a convenience wrapper to define the id space enum values and provide an easy interface for RPCs, most persistence use cases should use a denormalized form.

Protobuf type google.backstory.Id

Implements

IdOrBuilder

Static Fields

ID_FIELD_NUMBER

public static final int ID_FIELD_NUMBER
Field Value
Type Description
int

NAMESPACE_FIELD_NUMBER

public static final int NAMESPACE_FIELD_NUMBER
Field Value
Type Description
int

STRING_ID_FIELD_NUMBER

public static final int STRING_ID_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Id getDefaultInstance()
Returns
Type Description
Id

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Id.Builder newBuilder()
Returns
Type Description
Id.Builder

newBuilder(Id prototype)

public static Id.Builder newBuilder(Id prototype)
Parameter
Name Description
prototype Id
Returns
Type Description
Id.Builder

parseDelimitedFrom(InputStream input)

public static Id parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Id
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Id parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Id
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Id parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Id
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Id parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Id
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Id parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Id
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Id parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Id
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Id parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Id
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Id parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Id
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Id parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Id
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Id parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Id
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Id parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Id
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Id parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Id
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Id> parser()
Returns
Type Description
Parser<Id>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Id getDefaultInstanceForType()
Returns
Type Description
Id

getId()

public ByteString getId()

Full raw ID.

bytes id = 2;

Returns
Type Description
ByteString

The id.

getNamespace()

public Id.Namespace getNamespace()

Namespace the id belongs to.

.google.backstory.Id.Namespace namespace = 1;

Returns
Type Description
Id.Namespace

The namespace.

getNamespaceValue()

public int getNamespaceValue()

Namespace the id belongs to.

.google.backstory.Id.Namespace namespace = 1;

Returns
Type Description
int

The enum numeric value on the wire for namespace.

getParserForType()

public Parser<Id> getParserForType()
Returns
Type Description
Parser<Id>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStringId()

public String getStringId()

Some ids are stored as strings that are not able to be translated to bytes, so store these separately. Ex. detection id of the form de_aaaaaaaa-aaaa...

string string_id = 3;

Returns
Type Description
String

The stringId.

getStringIdBytes()

public ByteString getStringIdBytes()

Some ids are stored as strings that are not able to be translated to bytes, so store these separately. Ex. detection id of the form de_aaaaaaaa-aaaa...

string string_id = 3;

Returns
Type Description
ByteString

The bytes for stringId.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Id.Builder newBuilderForType()
Returns
Type Description
Id.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Id.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Id.Builder
Overrides

toBuilder()

public Id.Builder toBuilder()
Returns
Type Description
Id.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException