AnnotateImageResponse

google.cloud.vision.v1. AnnotateImageResponse

Represents an AnnotateImageResponse.

Constructor

new AnnotateImageResponse(propertiesopt)

Constructs a new AnnotateImageResponse.

Parameters:
Name Type Attributes Description
properties google.cloud.vision.v1.IAnnotateImageResponse <optional>

Properties to set

Implements:
  • IAnnotateImageResponse

Members

context

AnnotateImageResponse context.

cropHintsAnnotation

AnnotateImageResponse cropHintsAnnotation.

error

AnnotateImageResponse error.

faceAnnotations

AnnotateImageResponse faceAnnotations.

fullTextAnnotation

AnnotateImageResponse fullTextAnnotation.

imagePropertiesAnnotation

AnnotateImageResponse imagePropertiesAnnotation.

labelAnnotations

AnnotateImageResponse labelAnnotations.

landmarkAnnotations

AnnotateImageResponse landmarkAnnotations.

localizedObjectAnnotations

AnnotateImageResponse localizedObjectAnnotations.

logoAnnotations

AnnotateImageResponse logoAnnotations.

productSearchResults

AnnotateImageResponse productSearchResults.

safeSearchAnnotation

AnnotateImageResponse safeSearchAnnotation.

textAnnotations

AnnotateImageResponse textAnnotations.

webDetection

AnnotateImageResponse webDetection.

Methods

toJSON() → {Object.<string, *>}

Converts this AnnotateImageResponse to JSON.

Returns:
Type Description
Object.<string, *>

JSON object

(static) create(propertiesopt) → {google.cloud.vision.v1.AnnotateImageResponse}

Creates a new AnnotateImageResponse instance using the specified properties.

Parameters:
Name Type Attributes Description
properties google.cloud.vision.v1.IAnnotateImageResponse <optional>

Properties to set

Returns:
Type Description
google.cloud.vision.v1.AnnotateImageResponse

AnnotateImageResponse instance

(static) decode(reader, lengthopt) → {google.cloud.vision.v1.AnnotateImageResponse}

Decodes an AnnotateImageResponse message from the specified reader or buffer.

Parameters:
Name Type Attributes Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

length number <optional>

Message length if known beforehand

Returns:
Type Description
google.cloud.vision.v1.AnnotateImageResponse

AnnotateImageResponse

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) decodeDelimited(reader) → {google.cloud.vision.v1.AnnotateImageResponse}

Decodes an AnnotateImageResponse message from the specified reader or buffer, length delimited.

Parameters:
Name Type Description
reader $protobuf.Reader | Uint8Array

Reader or buffer to decode from

Returns:
Type Description
google.cloud.vision.v1.AnnotateImageResponse

AnnotateImageResponse

Throws:
  • If the payload is not a reader or valid buffer

    Type
    Error
  • If required fields are missing

    Type
    $protobuf.util.ProtocolError

(static) encode(message, writeropt) → {$protobuf.Writer}

Encodes the specified AnnotateImageResponse message. Does not implicitly verify messages.

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1.IAnnotateImageResponse

AnnotateImageResponse message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) encodeDelimited(message, writeropt) → {$protobuf.Writer}

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

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1.IAnnotateImageResponse

AnnotateImageResponse message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

Returns:
Type Description
$protobuf.Writer

Writer

(static) fromObject(object) → {google.cloud.vision.v1.AnnotateImageResponse}

Creates an AnnotateImageResponse message from a plain object. Also converts values to their respective internal types.

Parameters:
Name Type Description
object Object.<string, *>

Plain object

Returns:
Type Description
google.cloud.vision.v1.AnnotateImageResponse

AnnotateImageResponse

(static) getTypeUrl(typeUrlPrefixopt) → {string}

Gets the default type url for AnnotateImageResponse

Parameters:
Name Type Attributes Description
typeUrlPrefix string <optional>

your custom typeUrlPrefix(default "type.googleapis.com")

Returns:
Type Description
string

The default type url

(static) toObject(message, optionsopt) → {Object.<string, *>}

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

Parameters:
Name Type Attributes Description
message google.cloud.vision.v1.AnnotateImageResponse

AnnotateImageResponse

options $protobuf.IConversionOptions <optional>

Conversion options

Returns:
Type Description
Object.<string, *>

Plain object

(static) verify(message) → {string|null}

Verifies an AnnotateImageResponse message.

Parameters:
Name Type Description
message Object.<string, *>

Plain object to verify

Returns:
Type Description
string | null

null if valid, otherwise the reason why it is not