Viam SDK
    Preparing search index...

    Class TrainingJobMetadata

    from message viam.app.mltraining.v1.TrainingJobMetadata

    Hierarchy

    Index

    Constructors

    constructor

    Properties

    arguments containerVersion 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

    Properties

    arguments: { [key: string]: string }

    from field: map<string, string> arguments = 21;

    containerVersion: string

    from field: string container_version = 22;

    createdOn?: Timestamp

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

    datasetId: string

    from field: string dataset_id = 11;

    errorStatus?: Status

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

    id: string

    from field: string id = 7;

    isCustomJob: boolean

    from field: bool is_custom_job = 18;

    lastModified?: Timestamp

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

    modelFramework: ModelFramework

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

    modelName: string

    from field: string model_name = 13;

    modelType: ModelType

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

    modelVersion: string

    from field: string model_version = 14;

    organizationId: string

    from field: string organization_id = 12;

    registryItemId: string

    from field: string registry_item_id = 19;

    registryItemVersion: string

    from field: string registry_item_version = 20;

    status: TrainingStatus

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

    syncedModelId: string

    from field: string synced_model_id = 5;

    tags: string[]

    from field: repeated string tags = 16;

    trainingEnded?: Timestamp

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

    trainingStarted?: Timestamp

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

    fields: FieldList
    runtime: ProtoRuntime
    typeName: "viam.app.mltraining.v1.TrainingJobMetadata"

    Methods

    • 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

    • Parse a message from a JSON value.

      Parameters

      • jsonValue: JsonValue
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

    • Parse a message from a JSON string.

      Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns this

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

      Returns MessageType<TrainingJobMetadata>

    • Serialize the message to binary data.

      Parameters

      • Optionaloptions: Partial<BinaryWriteOptions>

      Returns Uint8Array

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

      Parameters

      • Optionaloptions: Partial<JsonWriteOptions>

      Returns 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

    • Serialize the message to a JSON string.

      Parameters

      • Optionaloptions: Partial<JsonWriteStringOptions>

      Returns string

    • Parameters

      • bytes: Uint8Array
      • Optionaloptions: Partial<BinaryReadOptions>

      Returns TrainingJobMetadata

    • Parameters

      • jsonString: string
      • Optionaloptions: Partial<JsonReadOptions>

      Returns TrainingJobMetadata

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods