Class protos.grafeas.v1.ImageNote

Represents an ImageNote.

Package

@google-cloud/grafeas

Constructors

(constructor)(properties)

constructor(properties?: grafeas.v1.IImageNote);

Constructs a new ImageNote.

Parameter
NameDescription
properties IImageNote

Properties to set

Properties

fingerprint

public fingerprint?: (grafeas.v1.IFingerprint|null);

ImageNote fingerprint.

resourceUrl

public resourceUrl: string;

ImageNote resourceUrl.

Methods

create(properties)

public static create(properties?: grafeas.v1.IImageNote): grafeas.v1.ImageNote;

Creates a new ImageNote instance using the specified properties.

Parameter
NameDescription
properties IImageNote

Properties to set

Returns
TypeDescription
grafeas.v1.ImageNote

ImageNote instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): grafeas.v1.ImageNote;

Decodes an ImageNote 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
grafeas.v1.ImageNote

ImageNote

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): grafeas.v1.ImageNote;

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

Parameter
NameDescription
reader ($protobuf.Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
grafeas.v1.ImageNote

ImageNote

encode(message, writer)

public static encode(message: grafeas.v1.IImageNote, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ImageNote message. Does not implicitly messages.

Parameters
NameDescription
message IImageNote

ImageNote 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: grafeas.v1.IImageNote, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IImageNote

ImageNote 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 }): grafeas.v1.ImageNote;

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

Parameter
NameDescription
object { [k: string]: any }

Plain object

Returns
TypeDescription
grafeas.v1.ImageNote

ImageNote

toJSON()

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

Converts this ImageNote to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: grafeas.v1.ImageNote, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message grafeas.v1.ImageNote

ImageNote

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