Class protos.google.cloud.vision.v1.AsyncAnnotateFileRequest (2.3.8)

Represents an AsyncAnnotateFileRequest.

Package

@google-cloud/vision!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.vision.v1.IAsyncAnnotateFileRequest);

Constructs a new AsyncAnnotateFileRequest.

Parameter

Name	Description
properties	`IAsyncAnnotateFileRequest` Properties to set

Properties

features

public features: google.cloud.vision.v1.IFeature[];

AsyncAnnotateFileRequest features.

Property Value

Type	Description
google.cloud.vision.v1.IFeature[]

imageContext

public imageContext?: (google.cloud.vision.v1.IImageContext|null);

AsyncAnnotateFileRequest imageContext.

Property Value

Type	Description
(google.cloud.vision.v1.IImageContext\|null)

inputConfig

public inputConfig?: (google.cloud.vision.v1.IInputConfig|null);

AsyncAnnotateFileRequest inputConfig.

Property Value

Type	Description
(google.cloud.vision.v1.IInputConfig\|null)

outputConfig

public outputConfig?: (google.cloud.vision.v1.IOutputConfig|null);

AsyncAnnotateFileRequest outputConfig.

Property Value

Type	Description
(google.cloud.vision.v1.IOutputConfig\|null)

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.IAsyncAnnotateFileRequest): google.cloud.vision.v1.AsyncAnnotateFileRequest;

Creates a new AsyncAnnotateFileRequest instance using the specified properties.

Parameter

Name	Description
properties	`IAsyncAnnotateFileRequest` Properties to set

Returns

Type	Description
google.cloud.vision.v1.AsyncAnnotateFileRequest	AsyncAnnotateFileRequest instance

decode(reader, length)

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

Decodes an AsyncAnnotateFileRequest 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.vision.v1.AsyncAnnotateFileRequest	AsyncAnnotateFileRequest

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vision.v1.AsyncAnnotateFileRequest;

Decodes an AsyncAnnotateFileRequest 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.vision.v1.AsyncAnnotateFileRequest	AsyncAnnotateFileRequest

encode(message, writer)

public static encode(message: google.cloud.vision.v1.IAsyncAnnotateFileRequest, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified AsyncAnnotateFileRequest message. Does not implicitly messages.

Parameters

Name	Description
message	`IAsyncAnnotateFileRequest` AsyncAnnotateFileRequest 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.vision.v1.IAsyncAnnotateFileRequest, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IAsyncAnnotateFileRequest` AsyncAnnotateFileRequest 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.vision.v1.AsyncAnnotateFileRequest;

Creates an AsyncAnnotateFileRequest 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.vision.v1.AsyncAnnotateFileRequest	AsyncAnnotateFileRequest

toJSON()

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

Converts this AsyncAnnotateFileRequest to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

Name	Description
message	`google.cloud.vision.v1.AsyncAnnotateFileRequest` AsyncAnnotateFileRequest
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 AsyncAnnotateFileRequest 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