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

Represents an ImageContext.

Package

@google-cloud/vision!

Constructors

(constructor)(properties)

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

Constructs a new ImageContext.

Parameter

Name	Description
properties	`IImageContext` Properties to set

Properties

cropHintsParams

public cropHintsParams?: (google.cloud.vision.v1.ICropHintsParams|null);

ImageContext cropHintsParams.

Property Value

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

languageHints

public languageHints: string[];

ImageContext languageHints.

Property Value

Type	Description
string[]

latLongRect

public latLongRect?: (google.cloud.vision.v1.ILatLongRect|null);

ImageContext latLongRect.

Property Value

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

productSearchParams

public productSearchParams?: (google.cloud.vision.v1.IProductSearchParams|null);

ImageContext productSearchParams.

Property Value

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

textDetectionParams

public textDetectionParams?: (google.cloud.vision.v1.ITextDetectionParams|null);

ImageContext textDetectionParams.

Property Value

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

webDetectionParams

public webDetectionParams?: (google.cloud.vision.v1.IWebDetectionParams|null);

ImageContext webDetectionParams.

Property Value

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

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.IImageContext): google.cloud.vision.v1.ImageContext;

Creates a new ImageContext instance using the specified properties.

Parameter

Name	Description
properties	`IImageContext` Properties to set

Returns

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

decode(reader, length)

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

Decodes an ImageContext 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.ImageContext	ImageContext

decodeDelimited(reader)

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

Decodes an ImageContext 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.ImageContext	ImageContext

encode(message, writer)

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

Encodes the specified ImageContext message. Does not implicitly messages.

Parameters

Name	Description
message	`IImageContext` ImageContext 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.IImageContext, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IImageContext` ImageContext 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.ImageContext;

Creates an ImageContext 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.ImageContext	ImageContext

toJSON()

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

Converts this ImageContext to JSON.

Returns

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

toObject(message, options)

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

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

Parameters

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