Class protos.google.cloud.language.v1beta2.AnnotateTextRequest

Represents an AnnotateTextRequest.

Package

@google-cloud/language

Constructors

(constructor)(properties)

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

Constructs a new AnnotateTextRequest.

Parameter
NameDescription
properties google.cloud.language.v1beta2.IAnnotateTextRequest

Properties to set

Properties

document

public document?: (google.cloud.language.v1beta2.IDocument|null);

AnnotateTextRequest document.

encodingType

public encodingType: (google.cloud.language.v1beta2.EncodingType|keyof typeof google.cloud.language.v1beta2.EncodingType);

AnnotateTextRequest encodingType.

features

public features?: (google.cloud.language.v1beta2.AnnotateTextRequest.IFeatures|null);

AnnotateTextRequest features.

Methods

create(properties)

public static create(properties?: google.cloud.language.v1beta2.IAnnotateTextRequest): google.cloud.language.v1beta2.AnnotateTextRequest;

Creates a new AnnotateTextRequest instance using the specified properties.

Parameter
NameDescription
properties google.cloud.language.v1beta2.IAnnotateTextRequest

Properties to set

Returns
TypeDescription
google.cloud.language.v1beta2.AnnotateTextRequest

AnnotateTextRequest instance

decode(reader, length)

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

Decodes an AnnotateTextRequest 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.v1beta2.AnnotateTextRequest

AnnotateTextRequest

decodeDelimited(reader)

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

Decodes an AnnotateTextRequest 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.v1beta2.AnnotateTextRequest

AnnotateTextRequest

encode(message, writer)

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

Encodes the specified AnnotateTextRequest message. Does not implicitly messages.

Parameters
NameDescription
message google.cloud.language.v1beta2.IAnnotateTextRequest

AnnotateTextRequest 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.v1beta2.IAnnotateTextRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message google.cloud.language.v1beta2.IAnnotateTextRequest

AnnotateTextRequest 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.v1beta2.AnnotateTextRequest;

Creates an AnnotateTextRequest 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.v1beta2.AnnotateTextRequest

AnnotateTextRequest

toJSON()

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

Converts this AnnotateTextRequest to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.language.v1beta2.AnnotateTextRequest

AnnotateTextRequest

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an AnnotateTextRequest 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