Class protos.google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison

Represents an ExampleComparison.

Package

@google-cloud/datalabeling!

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison);

Constructs a new ExampleComparison.

Parameter
TypeNameDescription
IExampleComparisonproperties

Properties to set

Properties

groundTruthExample

public groundTruthExample?: (google.cloud.datalabeling.v1beta1.IExample|null);

ExampleComparison groundTruthExample.

Property Value
TypeDescription
(google.cloud.datalabeling.v1beta1.IExample|null)

modelCreatedExamples

public modelCreatedExamples: google.cloud.datalabeling.v1beta1.IExample[];

ExampleComparison modelCreatedExamples.

Property Value
TypeDescription
google.cloud.datalabeling.v1beta1.IExample[]

Methods

create(properties)

public static create(properties?: google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison): google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison;

Creates a new ExampleComparison instance using the specified properties.

Parameter
TypeNameDescription
IExampleComparisonproperties

Properties to set

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison

ExampleComparison instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison;

Decodes an ExampleComparison message from the specified reader or buffer.

Parameters
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

numberlength

Message length if known beforehand

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison

ExampleComparison

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison;

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

Parameter
TypeNameDescription
($protobuf.Reader|Uint8Array)reader

Reader or buffer to decode from

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison

ExampleComparison

encode(message, writer)

public static encode(message: google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified ExampleComparison message. Does not implicitly messages.

Parameters
TypeNameDescription
IExampleComparisonmessage

ExampleComparison message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

encodeDelimited(message, writer)

public static encodeDelimited(message: google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.IExampleComparison, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
TypeNameDescription
IExampleComparisonmessage

ExampleComparison message or plain object to encode

$protobuf.Writerwriter

Writer to encode to

Returns
TypeDescription
$protobuf.Writer

Writer

fromObject(object)

public static fromObject(object: { [k: string]: any }): google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison;

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

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

Plain object

Returns
TypeDescription
google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison

ExampleComparison

toJSON()

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

Converts this ExampleComparison to JSON.

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparison, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
TypeNameDescription
google.cloud.datalabeling.v1beta1.SearchExampleComparisonsResponse.ExampleComparisonmessage

ExampleComparison

$protobuf.IConversionOptionsoptions

Conversion options

Returns
TypeDescription
{ [k: string]: any }

Plain object

verify(message)

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

Verifies an ExampleComparison message.

Parameter
TypeNameDescription
{ [k: string]: any }message

Plain object to verify

Returns
TypeDescription
(string|null)

null if valid, otherwise the reason why it is not