AnnotateImageRequest

google.cloud.vision.v1. AnnotateImageRequest

Represents an AnnotateImageRequest.

Constructor

new AnnotateImageRequest(propertiesopt)

Constructs a new AnnotateImageRequest.

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

Properties to set

Implements:
  • IAnnotateImageRequest

Members

features :Array.<google.cloud.vision.v1.IFeature>

AnnotateImageRequest features.

image :google.cloud.vision.v1.IImage|null|undefined

AnnotateImageRequest image.

imageContext :google.cloud.vision.v1.IImageContext|null|undefined

AnnotateImageRequest imageContext.

Methods

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

Creates a new AnnotateImageRequest instance using the specified properties.

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

Properties to set

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

Decodes an AnnotateImageRequest 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

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.AnnotateImageRequest}

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

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

Reader or buffer to decode from

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 AnnotateImageRequest message. Does not implicitly verify messages.

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

AnnotateImageRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

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

AnnotateImageRequest message or plain object to encode

writer $protobuf.Writer <optional>

Writer to encode to

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

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

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

Plain object

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

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

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

AnnotateImageRequest

options $protobuf.IConversionOptions <optional>

Conversion options

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

Verifies an AnnotateImageRequest message.

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

Plain object to verify

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

Converts this AnnotateImageRequest to JSON.