CustomJobSpec class final

Represents the spec of a CustomJob.

Inheritance
  • Object
  • ProtoMessage
  • CustomJobSpec

Constructors

CustomJobSpec({String persistentResourceId = '', required List<WorkerPoolSpec> workerPoolSpecs, Scheduling? scheduling, String serviceAccount = '', String network = '', List<String> reservedIpRanges = const [], PscInterfaceConfig? pscInterfaceConfig, GcsDestination? baseOutputDirectory, String protectedArtifactLocationId = '', String tensorboard = '', bool enableWebAccess = false, bool enableDashboardAccess = false, String experiment = '', String experimentRun = '', List<String> models = const []})
CustomJobSpec.fromJson(Object? j)
factory

Properties

baseOutputDirectory → GcsDestination?
The Cloud Storage location to store the output of this CustomJob or HyperparameterTuningJob. For HyperparameterTuningJob, the baseOutputDirectory of each child CustomJob backing a Trial is set to a subdirectory of name id under its parent HyperparameterTuningJob's baseOutputDirectory.
final
enableDashboardAccess → bool
Optional. Whether you want Vertex AI to enable access to the customized dashboard in training chief container.
final
enableWebAccess → bool
Optional. Whether you want Vertex AI to enable interactive shell access to training containers.
final
experiment → String
Optional. The Experiment associated with this job. Format: projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}
final
experimentRun → String
Optional. The Experiment Run associated with this job. Format: projects/{project}/locations/{location}/metadataStores/{metadataStores}/contexts/{experiment-name}-{experiment-run-name}
final
hashCode → int
The hash code for this object.
no setterinherited
models → List<String>
Optional. The name of the Model resources for which to generate a mapping to artifact URIs. Applicable only to some of the Google-provided custom jobs. Format: projects/{project}/locations/{location}/models/{model}
final
network → String
Optional. The full name of the Compute Engine network to which the Job should be peered. For example, projects/12345/global/networks/myVPC. Format is of the form projects/{project}/global/networks/{network}. Where {project} is a project number, as in 12345, and {network} is a network name.
final
persistentResourceId → String
Optional. The ID of the PersistentResource in the same Project and Location which to run
final
protectedArtifactLocationId → String
The ID of the location to store protected artifacts. e.g. us-central1. Populate only when the location is different than CustomJob location. List of supported locations: https://cloud.google.com/vertex-ai/docs/general/locations
final
pscInterfaceConfig → PscInterfaceConfig?
Optional. Configuration for PSC-I for CustomJob.
final
qualifiedName → String
The fully qualified name of this message, i.e., google.protobuf.Duration or google.rpc.ErrorInfo.
finalinherited
reservedIpRanges → List<String>
Optional. A list of names for the reserved ip ranges under the VPC network that can be used for this job.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
scheduling → Scheduling?
Scheduling options for a CustomJob.
final
serviceAccount → String
Specifies the service account for workload run-as account. Users submitting jobs must have act-as permission on this run-as account. If unspecified, the Vertex AI Custom Code Service Agent for the CustomJob's project is used.
final
tensorboard → String
Optional. The name of a Vertex AI Tensorboard resource to which this CustomJob will upload Tensorboard logs. Format: projects/{project}/locations/{location}/tensorboards/{tensorboard}
final
workerPoolSpecs → List<WorkerPoolSpec>
Required. The spec of the worker pools including machine type and Docker image. All worker pools except the first one are optional and can be skipped by providing an empty value.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Object
override
toString() → String
A string representation of this object.
override

Operators

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

Constants

fullyQualifiedName → const String