Class protos.google.cloud.aiplatform.v1.Examples (3.9.0)

Represents an Examples.

Package

@google-cloud/aiplatform

Constructors

(constructor)(properties)

constructor(properties?: google.cloud.aiplatform.v1.IExamples);

Constructs a new Examples.

Parameter
NameDescription
properties IExamples

Properties to set

Properties

config

public config?: ("nearestNeighborSearchConfig"|"presets");

Examples config.

exampleGcsSource

public exampleGcsSource?: (google.cloud.aiplatform.v1.Examples.IExampleGcsSource|null);

Examples exampleGcsSource.

nearestNeighborSearchConfig

public nearestNeighborSearchConfig?: (google.protobuf.IValue|null);

Examples nearestNeighborSearchConfig.

neighborCount

public neighborCount: number;

Examples neighborCount.

presets

public presets?: (google.cloud.aiplatform.v1.IPresets|null);

Examples presets.

source

public source?: "exampleGcsSource";

Examples source.

Methods

create(properties)

public static create(properties?: google.cloud.aiplatform.v1.IExamples): google.cloud.aiplatform.v1.Examples;

Creates a new Examples instance using the specified properties.

Parameter
NameDescription
properties IExamples

Properties to set

Returns
TypeDescription
Examples

Examples instance

decode(reader, length)

public static decode(reader: ($protobuf.Reader|Uint8Array), length?: number): google.cloud.aiplatform.v1.Examples;

Decodes an Examples message from the specified reader or buffer.

Parameters
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

length number

Message length if known beforehand

Returns
TypeDescription
Examples

Examples

decodeDelimited(reader)

public static decodeDelimited(reader: ($protobuf.Reader|Uint8Array)): google.cloud.aiplatform.v1.Examples;

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

Parameter
NameDescription
reader (Reader|Uint8Array)

Reader or buffer to decode from

Returns
TypeDescription
Examples

Examples

encode(message, writer)

public static encode(message: google.cloud.aiplatform.v1.IExamples, writer?: $protobuf.Writer): $protobuf.Writer;

Encodes the specified Examples message. Does not implicitly messages.

Parameters
NameDescription
message IExamples

Examples 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: google.cloud.aiplatform.v1.IExamples, writer?: $protobuf.Writer): $protobuf.Writer;

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

Parameters
NameDescription
message IExamples

Examples 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 }): google.cloud.aiplatform.v1.Examples;

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

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

Plain object

Returns
TypeDescription
Examples

Examples

getTypeUrl(typeUrlPrefix)

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

Gets the default type url for Examples

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

Returns
TypeDescription
{ [k: string]: any }

JSON object

toObject(message, options)

public static toObject(message: google.cloud.aiplatform.v1.Examples, options?: $protobuf.IConversionOptions): { [k: string]: any };

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

Parameters
NameDescription
message Examples

Examples

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