Class TrainingJobMetadata

Generated

from message viam.app.mltraining.v1.TrainingJobMetadata

Hierarchy

Constructors

constructor

Properties

createdOn? datasetId errorStatus? id isCustomJob lastModified? modelFramework modelName modelType modelVersion organizationId registryItemId registryItemVersion status syncedModelId tags trainingEnded? trainingStarted? fields runtime typeName

Methods

clone equals fromBinary fromJson fromJsonString getType toBinary toJson toJSON toJsonString equals fromBinary fromJson fromJsonString

Constructors

constructor

Properties

OptionalcreatedOn

createdOn?: Timestamp

Generated

from field: google.protobuf.Timestamp created_on = 3;

datasetId

datasetId: string

Generated

from field: string dataset_id = 11;

OptionalerrorStatus

errorStatus?: Status

Generated

from field: google.rpc.Status error_status = 8;

id

id: string

Generated

from field: string id = 7;

isCustomJob

isCustomJob: boolean

Generated

from field: bool is_custom_job = 18;

OptionallastModified

lastModified?: Timestamp

Generated

from field: google.protobuf.Timestamp last_modified = 4;

modelFramework

modelFramework: ModelFramework

Generated

from field: viam.app.mltraining.v1.ModelFramework model_framework = 17;

modelName

modelName: string

Generated

from field: string model_name = 13;

modelType

modelType: ModelType

Generated

from field: viam.app.mltraining.v1.ModelType model_type = 15;

modelVersion

modelVersion: string

Generated

from field: string model_version = 14;

organizationId

organizationId: string

Generated

from field: string organization_id = 12;

registryItemId

registryItemId: string

Generated

from field: string registry_item_id = 19;

registryItemVersion

registryItemVersion: string

Generated

from field: string registry_item_version = 20;

status

status: TrainingStatus

Generated

from field: viam.app.mltraining.v1.TrainingStatus status = 2;

syncedModelId

syncedModelId: string

Generated

from field: string synced_model_id = 5;

tags

tags: string[]

Generated

from field: repeated string tags = 16;

OptionaltrainingEnded

trainingEnded?: Timestamp

Generated

from field: google.protobuf.Timestamp training_ended = 10;

OptionaltrainingStarted

trainingStarted?: Timestamp

Generated

from field: google.protobuf.Timestamp training_started = 9;

Static Readonlyfields

fields: FieldList

Static Readonlyruntime

runtime: ProtoRuntime

Static ReadonlytypeName

typeName: "viam.app.mltraining.v1.TrainingJobMetadata"

Methods

clone

equals

fromBinary

  • fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): this

    Parse from binary data, merging fields.

    Repeated fields are appended. Map entries are added, overwriting existing keys.

    If a message field is already present, it will be merged with the new data.

    Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns this

fromJson

  • fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON value.

    Parameters

    • jsonValue: JsonValue
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

fromJsonString

  • fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): this

    Parse a message from a JSON string.

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns this

getType

  • getType(): MessageType<TrainingJobMetadata>

    Retrieve the MessageType of this message - a singleton that represents the protobuf message declaration and provides metadata for reflection- based operations.

    Returns MessageType<TrainingJobMetadata>

toBinary

  • toBinary(options?: Partial<BinaryWriteOptions>): Uint8Array

    Serialize the message to binary data.

    Parameters

    • Optionaloptions: Partial<BinaryWriteOptions>

    Returns Uint8Array

toJson

  • toJson(options?: Partial<JsonWriteOptions>): JsonValue

    Serialize the message to a JSON value, a JavaScript value that can be passed to JSON.stringify().

    Parameters

    • Optionaloptions: Partial<JsonWriteOptions>

    Returns JsonValue

ProtectedtoJSON

  • toJSON(): JsonValue

    Override for serialization behavior. This will be invoked when calling JSON.stringify on this message (i.e. JSON.stringify(msg)).

    Note that this will not serialize google.protobuf.Any with a packed message because the protobuf JSON format specifies that it needs to be unpacked, and this is only possible with a type registry to look up the message type. As a result, attempting to serialize a message with this type will throw an Error.

    This method is protected because you should not need to invoke it directly -- instead use JSON.stringify or toJsonString for stringified JSON. Alternatively, if actual JSON is desired, you should use toJson.

    Returns JsonValue

toJsonString

  • toJsonString(options?: Partial<JsonWriteStringOptions>): string

    Serialize the message to a JSON string.

    Parameters

    • Optionaloptions: Partial<JsonWriteStringOptions>

    Returns string

Staticequals

StaticfromBinary

  • fromBinary(
        bytes: Uint8Array,
        options?: Partial<BinaryReadOptions>,
    ): TrainingJobMetadata

    Parameters

    • bytes: Uint8Array
    • Optionaloptions: Partial<BinaryReadOptions>

    Returns TrainingJobMetadata

StaticfromJson

StaticfromJsonString

  • fromJsonString(
        jsonString: string,
        options?: Partial<JsonReadOptions>,
    ): TrainingJobMetadata

    Parameters

    • jsonString: string
    • Optionaloptions: Partial<JsonReadOptions>

    Returns TrainingJobMetadata

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
MMNEPVFCICPMFPCPTTAAATR