Class protos.grafeas.v1.ImageOccurrence (4.1.2)

Represents an ImageOccurrence.

Package

Constructors

(constructor)(properties)

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

Constructs a new ImageOccurrence.

Parameter

Name	Description
properties	`IImageOccurrence` Properties to set

Properties

baseResourceUrl

public baseResourceUrl: string;

ImageOccurrence baseResourceUrl.

distance

public distance: number;

ImageOccurrence distance.

fingerprint

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

ImageOccurrence fingerprint.

layerInfo

public layerInfo: grafeas.v1.ILayer[];

ImageOccurrence layerInfo.

Methods

create(properties)

public static create(properties?: grafeas.v1.IImageOccurrence): grafeas.v1.ImageOccurrence;

Creates a new ImageOccurrence instance using the specified properties.

Parameter

Name	Description
properties	`IImageOccurrence` Properties to set

Returns

Type	Description
grafeas.v1.ImageOccurrence	ImageOccurrence instance

decode(reader, length)

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

Decodes an ImageOccurrence message from the specified reader or buffer.

Parameters

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from
length	`number` Message length if known beforehand

Returns

Type	Description
grafeas.v1.ImageOccurrence	ImageOccurrence

decodeDelimited(reader)

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

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

Parameter

Name	Description
reader	`($protobuf.Reader\|Uint8Array)` Reader or buffer to decode from

Returns

Type	Description
grafeas.v1.ImageOccurrence	ImageOccurrence

encode(message, writer)

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

Encodes the specified ImageOccurrence message. Does not implicitly messages.

Parameters

Name	Description
message	`IImageOccurrence` ImageOccurrence 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: grafeas.v1.IImageOccurrence, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters

Name	Description
message	`IImageOccurrence` ImageOccurrence 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 }): grafeas.v1.ImageOccurrence;

Creates an ImageOccurrence 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
grafeas.v1.ImageOccurrence	ImageOccurrence

getTypeUrl(typeUrlPrefix)

public static getTypeUrl(typeUrlPrefix?: string): string;

Gets the default type url for ImageOccurrence

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 ImageOccurrence to JSON.

Returns

Type	Description
{ [k: string]: any }	JSON object

toObject(message, options)

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

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

Parameters

Name	Description
message	`grafeas.v1.ImageOccurrence` ImageOccurrence
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 ImageOccurrence message.

Parameter

Name	Description
message	`{ [k: string]: any }` Plain object to verify

Returns

Type	Description
(string\|null)	`null` if valid, otherwise the reason why it is not