Represents an AnnotateImageResponse.
Package
@google-cloud/visionConstructors
(constructor)(properties)
constructor(properties?: google.cloud.vision.v1p1beta1.IAnnotateImageResponse);
Constructs a new AnnotateImageResponse.
Parameter | |
---|---|
Name | Description |
properties |
IAnnotateImageResponse
Properties to set |
Properties
cropHintsAnnotation
public cropHintsAnnotation?: (google.cloud.vision.v1p1beta1.ICropHintsAnnotation|null);
AnnotateImageResponse cropHintsAnnotation.
error
public error?: (google.rpc.IStatus|null);
AnnotateImageResponse error.
faceAnnotations
public faceAnnotations: google.cloud.vision.v1p1beta1.IFaceAnnotation[];
AnnotateImageResponse faceAnnotations.
fullTextAnnotation
public fullTextAnnotation?: (google.cloud.vision.v1p1beta1.ITextAnnotation|null);
AnnotateImageResponse fullTextAnnotation.
imagePropertiesAnnotation
public imagePropertiesAnnotation?: (google.cloud.vision.v1p1beta1.IImageProperties|null);
AnnotateImageResponse imagePropertiesAnnotation.
labelAnnotations
public labelAnnotations: google.cloud.vision.v1p1beta1.IEntityAnnotation[];
AnnotateImageResponse labelAnnotations.
landmarkAnnotations
public landmarkAnnotations: google.cloud.vision.v1p1beta1.IEntityAnnotation[];
AnnotateImageResponse landmarkAnnotations.
logoAnnotations
public logoAnnotations: google.cloud.vision.v1p1beta1.IEntityAnnotation[];
AnnotateImageResponse logoAnnotations.
safeSearchAnnotation
public safeSearchAnnotation?: (google.cloud.vision.v1p1beta1.ISafeSearchAnnotation|null);
AnnotateImageResponse safeSearchAnnotation.
textAnnotations
public textAnnotations: google.cloud.vision.v1p1beta1.IEntityAnnotation[];
AnnotateImageResponse textAnnotations.
webDetection
public webDetection?: (google.cloud.vision.v1p1beta1.IWebDetection|null);
AnnotateImageResponse webDetection.
Methods
create(properties)
public static create(properties?: google.cloud.vision.v1p1beta1.IAnnotateImageResponse): google.cloud.vision.v1p1beta1.AnnotateImageResponse;
Creates a new AnnotateImageResponse instance using the specified properties.
Parameter | |
---|---|
Name | Description |
properties |
IAnnotateImageResponse
Properties to set |
Returns | |
---|---|
Type | Description |
AnnotateImageResponse |
AnnotateImageResponse instance |
decode(reader, length)
public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.vision.v1p1beta1.AnnotateImageResponse;
Decodes an AnnotateImageResponse message from the specified reader or buffer.
Parameters | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
length |
number
Message length if known beforehand |
Returns | |
---|---|
Type | Description |
AnnotateImageResponse |
AnnotateImageResponse |
decodeDelimited(reader)
public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.vision.v1p1beta1.AnnotateImageResponse;
Decodes an AnnotateImageResponse message from the specified reader or buffer, length delimited.
Parameter | |
---|---|
Name | Description |
reader |
(Reader|Uint8Array)
Reader or buffer to decode from |
Returns | |
---|---|
Type | Description |
AnnotateImageResponse |
AnnotateImageResponse |
encode(message, writer)
public static encode(message: google.cloud.vision.v1p1beta1.IAnnotateImageResponse, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AnnotateImageResponse message. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAnnotateImageResponse
AnnotateImageResponse 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.v1p1beta1.IAnnotateImageResponse, writer?: $protobuf.Writer): $protobuf.Writer;
Encodes the specified AnnotateImageResponse message, length delimited. Does not implicitly messages.
Parameters | |
---|---|
Name | Description |
message |
IAnnotateImageResponse
AnnotateImageResponse 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.v1p1beta1.AnnotateImageResponse;
Creates an AnnotateImageResponse 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 |
AnnotateImageResponse |
AnnotateImageResponse |
getTypeUrl(typeUrlPrefix)
public static getTypeUrl(typeUrlPrefix?: string): string;
Gets the default type url for AnnotateImageResponse
Parameter | |
---|---|
Name | Description |
typeUrlPrefix |
string
your custom typeUrlPrefix(default "type.googleapis.com") |
Returns | |
---|---|
Type | Description |
string |
The default type url |
toJSON()
public toJSON(): { [k: string]: any };
Converts this AnnotateImageResponse to JSON.
Returns | |
---|---|
Type | Description |
{ [k: string]: any } |
JSON object |
toObject(message, options)
public static toObject(message: google.cloud.vision.v1p1beta1.AnnotateImageResponse, options?: $protobuf.IConversionOptions): { [k: string]: any };
Creates a plain object from an AnnotateImageResponse message. Also converts values to other types if specified.
Parameters | |
---|---|
Name | Description |
message |
AnnotateImageResponse
AnnotateImageResponse |
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 AnnotateImageResponse message.
Parameter | |
---|---|
Name | Description |
message |
{ [k: string]: any }
Plain object to verify |
Returns | |
---|---|
Type | Description |
(string|null) |
|