RunArgs class - aiplatform library

Constructors

RunArgs({Input<String>? description, required Input<String> displayName, Input<String>? etag, required Input<String> experimentId, Input<Map<String, String>>? labels, Input<String>? location, Input<String>? project, required Input<String> tensorboardId, required Input<String> tensorboardRunId}): Creates a new RunArgs. description Description of this TensorboardRun. displayName User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment. etag Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens. experimentId Required. labels The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable. location Optional. project Optional. tensorboardId Required. tensorboardRunId Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
const
RunArgs.fromMap(Map<String, dynamic> map): factory

Properties

description → Input<String>?: Description of this TensorboardRun.
final
displayName → Input<String>: User provided name of this TensorboardRun. This value must be unique among all TensorboardRuns belonging to the same parent TensorboardExperiment.
final
etag → Input<String>?: Used to perform a consistent read-modify-write updates. If not set, a blind "overwrite" update happens.
final
experimentId → Input<String>: final
hashCode → int: The hash code for this object.
no setterinherited
labels → Input<Map<String, String>>?: The labels with user-defined metadata to organize your TensorboardRuns. This field will be used to filter and visualize Runs in the Tensorboard UI. For example, a Vertex AI training job can set a label aiplatform.googleapis.com/training_job_id=xxxxx to all the runs created within that job. An end user can set a label experiment_id=xxxxx for all the runs produced in a Jupyter notebook. These runs can be grouped by a label value and visualized together in the Tensorboard UI. Label keys and values can be no longer than 64 characters (Unicode codepoints), can only contain lowercase letters, numeric characters, underscores and dashes. International characters are allowed. No more than 64 user labels can be associated with one TensorboardRun (System labels are excluded). See https://goo.gl/xmQnxf for more information and examples of labels. System reserved label keys are prefixed with "aiplatform.googleapis.com/" and are immutable.
final
location → Input<String>?: final
project → Input<String>?: final
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
tensorboardId → Input<String>: final
tensorboardRunId → Input<String>: Required. The ID to use for the Tensorboard run, which becomes the final component of the Tensorboard run's resource name. This value should be 1-128 characters, and valid characters are /a-z-/.
final

Methods

noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited