Class protos.google.backstory.Entity (0.10.1)

Represents an Entity.

Implements

Package

@google-cloud/chronicle

Constructors

(constructor)(properties)

constructor(properties?: google.backstory.IEntity);

Constructs a new Entity.

Parameter
Name Description
properties IEntity

Properties to set

Properties

additional

public additional?: (google.protobuf.IStruct|null);

Entity additional.

entity

public entity?: (google.backstory.INoun|null);

Entity entity.

metadata

public metadata?: (google.backstory.IEntityMetadata|null);

Entity metadata.

metric

public metric?: (google.backstory.IMetric|null);

Entity metric.

relations

public relations: google.backstory.IRelation[];

Entity relations.

riskScore

public riskScore?: (google.backstory.IEntityRisk|null);

Entity riskScore.

Methods

create(properties)

public static create(properties?: google.backstory.IEntity): google.backstory.Entity;

Creates a new Entity instance using the specified properties.

Parameter
Name Description
properties IEntity

Properties to set

Returns
Type Description
Entity

Entity instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.backstory.Entity;

Decodes an Entity message from the specified reader or buffer.

Parameters
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
Type Description
Entity

Entity

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.backstory.Entity;

Decodes an Entity message from the specified reader or buffer, length delimited.

Parameter
Name Description
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
Type Description
Entity

Entity

encode(message, writer)

public static encode(message: google.backstory.IEntity, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Entity message. Does not implicitly messages.

Parameters
Name Description
message IEntity

Entity message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.backstory.IEntity, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Entity message, length delimited. Does not implicitly messages.

Parameters
Name Description
message IEntity

Entity message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
Type Description
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.backstory.Entity;

Creates an Entity message from a plain object. Also converts values to their respective internal types.

Parameter
Name Description
object { [k: string]: any }

Plain object

Returns
Type Description
Entity

Entity

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for Entity

Parameter
Name Description
typeUrlPrefix string

your custom typeUrlPrefix(default "type.googleapis.com")

Returns
Type Description
string

The default type url

toJSON()

public toJSON(): { [k: string]: any };

Converts this Entity to JSON.

Returns
Type Description
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.backstory.Entity, options?: $protobuf.IConversionOptions): { [k: string]: any };

Creates a plain object from an Entity message. Also converts values to other types if specified.

Parameters
Name Description
message Entity

Entity

options $protobuf.IConversionOptions

Conversion options

Returns
Type Description
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies an Entity message.

Parameter
Name Description
message { [k: string]: any }

Plain object to verify

Returns
Type Description
(string|null)

null if valid, otherwise the reason why it is not