Some or all of the information on this page might not apply to Cloud de Confiance by S3NS. See Differences from Google Cloud for more details.

Class protos.google.cloud.language.v1beta2.EntityMention (5.2.2)

Represents an EntityMention.

Package

@google-cloud/language

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.language.v1beta2.IEntityMention);

Constructs a new EntityMention.

Parameter
Name	Description
`properties`	`IEntityMention` Properties to set

Properties

sentiment

public sentiment?: (google.cloud.language.v1beta2.ISentiment|null);

EntityMention sentiment.

text

public text?: (google.cloud.language.v1beta2.ITextSpan|null);

EntityMention text.

type

public type: (google.cloud.language.v1beta2.EntityMention.Type|keyof typeof google.cloud.language.v1beta2.EntityMention.Type);

EntityMention type.

Methods

create(properties)

public static create(properties?: google.cloud.language.v1beta2.IEntityMention): google.cloud.language.v1beta2.EntityMention;

Creates a new EntityMention instance using the specified properties.

Parameter
Name	Description
`properties`	`IEntityMention` Properties to set

Returns
Type	Description
`google.cloud.language.v1beta2.EntityMention`	EntityMention instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.language.v1beta2.EntityMention;

Decodes an EntityMention message from the specified reader or buffer.

Parameters
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
`length`	`number` Message length if known beforehand

Returns
Type	Description
`google.cloud.language.v1beta2.EntityMention`	EntityMention

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.language.v1beta2.EntityMention;

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

Parameter
Name	Description
`reader`	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns
Type	Description
`google.cloud.language.v1beta2.EntityMention`	EntityMention

encode(message, writer)

public static encode(message: google.cloud.language.v1beta2.IEntityMention, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified EntityMention message. Does not implicitly messages.

Parameters
Name	Description
`message`	`IEntityMention` EntityMention 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.cloud.language.v1beta2.IEntityMention, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
Name	Description
`message`	`IEntityMention` EntityMention 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.cloud.language.v1beta2.EntityMention;

Creates an EntityMention 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
`google.cloud.language.v1beta2.EntityMention`	EntityMention

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for EntityMention

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 EntityMention to JSON.

Returns
Type	Description
`{ [k: string]: any }`	JSON object

toObject(message, options)

public static toObject(message: google.cloud.language.v1beta2.EntityMention, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
Name	Description
`message`	`google.cloud.language.v1beta2.EntityMention` EntityMention
`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 EntityMention 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