Class protos.google.cloud.vision.v1.AnnotateImageResponse

Represents an AnnotateImageResponse.

Package

@google-cloud/vision

Constructors

(constructor)(properties)

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

Constructs a new AnnotateImageResponse.

Parameter
NameDescription
properties IAnnotateImageResponse

Properties to set

Properties

context

public context?: (google.cloud.vision.v1.IImageAnnotationContext|null);

AnnotateImageResponse context.

cropHintsAnnotation

public cropHintsAnnotation?: (google.cloud.vision.v1.ICropHintsAnnotation|null);

AnnotateImageResponse cropHintsAnnotation.

error

public error?: (google.rpc.IStatus|null);

AnnotateImageResponse error.

faceAnnotations

public faceAnnotations: google.cloud.vision.v1.IFaceAnnotation[];

AnnotateImageResponse faceAnnotations.

fullTextAnnotation

public fullTextAnnotation?: (google.cloud.vision.v1.ITextAnnotation|null);

AnnotateImageResponse fullTextAnnotation.

imagePropertiesAnnotation

public imagePropertiesAnnotation?: (google.cloud.vision.v1.IImageProperties|null);

AnnotateImageResponse imagePropertiesAnnotation.

labelAnnotations

public labelAnnotations: google.cloud.vision.v1.IEntityAnnotation[];

AnnotateImageResponse labelAnnotations.

landmarkAnnotations

public landmarkAnnotations: google.cloud.vision.v1.IEntityAnnotation[];

AnnotateImageResponse landmarkAnnotations.

localizedObjectAnnotations

public localizedObjectAnnotations: google.cloud.vision.v1.ILocalizedObjectAnnotation[];

AnnotateImageResponse localizedObjectAnnotations.

logoAnnotations

public logoAnnotations: google.cloud.vision.v1.IEntityAnnotation[];

AnnotateImageResponse logoAnnotations.

productSearchResults

public productSearchResults?: (google.cloud.vision.v1.IProductSearchResults|null);

AnnotateImageResponse productSearchResults.

safeSearchAnnotation

public safeSearchAnnotation?: (google.cloud.vision.v1.ISafeSearchAnnotation|null);

AnnotateImageResponse safeSearchAnnotation.

textAnnotations

public textAnnotations: google.cloud.vision.v1.IEntityAnnotation[];

AnnotateImageResponse textAnnotations.

webDetection

public webDetection?: (google.cloud.vision.v1.IWebDetection|null);

AnnotateImageResponse webDetection.

Methods

create(properties)

public static create(properties?: google.cloud.vision.v1.IAnnotateImageResponse): google.cloud.vision.v1.AnnotateImageResponse;

Creates a new AnnotateImageResponse instance using the specified properties.

Parameter
NameDescription
properties IAnnotateImageResponse

Properties to set

Returns
TypeDescription
google.cloud.vision.v1.AnnotateImageResponse

AnnotateImageResponse instance

decode(reader, length)

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

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

AnnotateImageResponse

decodeDelimited(reader)

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

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

AnnotateImageResponse

encode(message, writer)

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

Encodes the specified AnnotateImageResponse message. Does not implicitly messages.

Parameters
NameDescription
message IAnnotateImageResponse

AnnotateImageResponse 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.vision.v1.IAnnotateImageResponse, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IAnnotateImageResponse

AnnotateImageResponse 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.vision.v1.AnnotateImageResponse;

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

AnnotateImageResponse

toJSON()

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

Converts this AnnotateImageResponse to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message google.cloud.vision.v1.AnnotateImageResponse

AnnotateImageResponse

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 AnnotateImageResponse 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