Class protos.grafeas.v1.Fingerprint (4.1.2)

Represents a Fingerprint.

Package

@google-cloud/grafeas

Constructors

(constructor)(properties)

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

Constructs a new Fingerprint.

Parameter
NameDescription
properties IFingerprint

Properties to set

Properties

v1Name

public v1Name: string;

Fingerprint v1Name.

v2Blob

public v2Blob: string[];

Fingerprint v2Blob.

v2Name

public v2Name: string;

Fingerprint v2Name.

Methods

create(properties)

public static create(properties?: grafeas.v1.IFingerprint): grafeas.v1.Fingerprint;

Creates a new Fingerprint instance using the specified properties.

Parameter
NameDescription
properties IFingerprint

Properties to set

Returns
TypeDescription
grafeas.v1.Fingerprint

Fingerprint instance

decode(reader, length)

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

Decodes a Fingerprint 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.Fingerprint

Fingerprint

decodeDelimited(reader)

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

Decodes a Fingerprint 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.Fingerprint

Fingerprint

encode(message, writer)

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

Encodes the specified Fingerprint message. Does not implicitly messages.

Parameters
NameDescription
message IFingerprint

Fingerprint 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.IFingerprint, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IFingerprint

Fingerprint 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.Fingerprint;

Creates a Fingerprint 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.Fingerprint

Fingerprint

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Fingerprint

Parameter
NameDescription
typeUrlPrefix string

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

Returns
TypeDescription
string

The default type url

toJSON()

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

Converts this Fingerprint to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

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

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

Parameters
NameDescription
message grafeas.v1.Fingerprint

Fingerprint

options $protobuf.IConversionOptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

public static verify(message: { [k: string]: any }): (string|null);

Verifies a Fingerprint 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