Class protos.google.cloud.language.v1.AnnotateTextRequest.Features (5.2.2)

Represents a Features.

Package

@google-cloud/language

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.language.v1.AnnotateTextRequest.IFeatures);

Constructs a new Features.

Parameter
NameDescription
properties IFeatures

Properties to set

Properties

classificationModelOptions

public classificationModelOptions?: (google.cloud.language.v1.IClassificationModelOptions|null);

Features classificationModelOptions.

classifyText

public classifyText: boolean;

Features classifyText.

extractDocumentSentiment

public extractDocumentSentiment: boolean;

Features extractDocumentSentiment.

extractEntities

public extractEntities: boolean;

Features extractEntities.

extractEntitySentiment

public extractEntitySentiment: boolean;

Features extractEntitySentiment.

extractSyntax

public extractSyntax: boolean;

Features extractSyntax.

Methods

create(properties)

public static create(properties?: google.cloud.language.v1.AnnotateTextRequest.IFeatures): google.cloud.language.v1.AnnotateTextRequest.Features;

Creates a new Features instance using the specified properties.

Parameter
NameDescription
properties IFeatures

Properties to set

Returns
TypeDescription
google.cloud.language.v1.AnnotateTextRequest.Features

Features instance

decode(reader, length)

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

Decodes a Features message from the specified reader or buffer.

Parameters
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
google.cloud.language.v1.AnnotateTextRequest.Features

Features

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.language.v1.AnnotateTextRequest.Features;

Decodes a Features message from the specified reader or buffer, length delimited.

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.language.v1.AnnotateTextRequest.Features

Features

encode(message, writer)

public static encode(message: google.cloud.language.v1.AnnotateTextRequest.IFeatures, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Features message. Does not implicitly messages.

Parameters
NameDescription
message IFeatures

Features message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.language.v1.AnnotateTextRequest.IFeatures, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IFeatures

Features message or plain object to encode

writer $protobuf.Writer

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.language.v1.AnnotateTextRequest.Features;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
google.cloud.language.v1.AnnotateTextRequest.Features

Features

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Features

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Features to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.language.v1.AnnotateTextRequest.Features

Features

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies a Features message.

Parameter
NameDescription
message { [k: string]: any }

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not