HyperparameterTuningJob class

Creates a HyperparameterTuningJob Auto-naming is currently not supported for this resource.

Constructors

HyperparameterTuningJob(String name, {HyperparameterTuningJobArgs? args, CustomResourceOptions? options})

Creates a new HyperparameterTuningJob. name The Pulumi resource name. args Arguments used to configure this HyperparameterTuningJob. The set of arguments for HyperparameterTuningJob. options Resource options controlling this resource's behavior.

Properties

childResources → Set<Resource>

final, inherited

completionSources ↔ Map<String, IOutputCompletionSource>

late, final, inherited

createTime ↔ Output<String>

Time when the HyperparameterTuningJob was created.

late, final

displayName ↔ Output<String>

The display name of the HyperparameterTuningJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

late, final

encryptionSpec ↔ Output<GoogleCloudAiplatformV1EncryptionSpecResponse>

Customer-managed encryption key options for a HyperparameterTuningJob. If this is set, then all resources created by the HyperparameterTuningJob will be encrypted with the provided encryption key.

late, final

endTime ↔ Output<String>

Time when the HyperparameterTuningJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

late, final

error ↔ Output<GoogleRpcStatusResponse>

Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

late, final

hashCode → int

The hash code for this object.

no setter, inherited

id ↔ Output<String>

getter/setter pair, inherited

isCustom → bool

Returns whether this resource is provider-managed.

no setter, inherited

isProtected → bool

Returns whether this resource is protected from deletion.

no setter, inherited

isRemote → bool

Whether this resource is registered as remote.

no setter, inherited

isResourceReference → bool

Whether this instance represents a resource value returned over RPC.

final, inherited

labels ↔ Output<Map<String, String>>

The labels with user-defined metadata to organize HyperparameterTuningJobs. 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. See https://goo.gl/xmQnxf for more information and examples of labels.

late, final

location ↔ Output<String>

late, final

maxFailedTrialCount ↔ Output<int>

The number of failed Trials that need to be seen before failing the HyperparameterTuningJob. If set to 0, Vertex AI decides how many Trials must fail before the whole job fails.

late, final

maxTrialCount ↔ Output<int>

The desired total number of Trials.

late, final

name ↔ Output<String>

Resource name of the HyperparameterTuningJob.

late, final

parallelTrialCount ↔ Output<int>

The desired number of Trials to run in parallel.

late, final

project ↔ Output<String>

late, final

resourceTransforms → List<ResourceTransform>

Inherited/explicit async transforms.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

startTime ↔ Output<String>

Time when the HyperparameterTuningJob for the first time entered the JOB_STATE_RUNNING state.

late, final

state ↔ Output<String>

The detailed state of the job.

late, final

studySpec ↔ Output<GoogleCloudAiplatformV1StudySpecResponse>

Study configuration of the HyperparameterTuningJob.

late, final

transformations → List<ResourceTransformation>

Inherited/explicit legacy transformations.

no setter, inherited

trialJobSpec ↔ Output<GoogleCloudAiplatformV1CustomJobSpecResponse>

The spec of a trial job. The same spec applies to the CustomJobs created in all the trials.

late, final

trials ↔ Output<List<Map<String, dynamic>>>

Trials of the HyperparameterTuningJob.

late, final

updateTime ↔ Output<String>

Time when the HyperparameterTuningJob was most recently updated.

late, final

urn ↔ Output<String>

late, final, inherited

Methods

failId(Object error) → void

Completes this resource ID with an error when registration fails.

inherited

failOutputs(Object error) → void

Completes all output properties with error.

inherited

failUrn(Object error) → void

Completes this resource URN with an error when registration fails.

inherited

getProvider(String moduleMember) → ProviderResource?

Returns provider for moduleMember's package, if configured.

inherited

getResourceName() → String

Returns this resource's logical name.

inherited

getResourceType() → String

Returns this resource's Pulumi type token.

inherited

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>

Registers a dynamic output property for this resource.

inherited

resolveId(String? value, {required bool isKnown}) → void

Resolves the provider-assigned ID for this resource.

inherited

resolveOutputs(Struct outputs) → void

Resolves all output properties from a monitor response payload.

inherited

resolveUrn(String value) → void

Resolves this resource's URN once assigned by the engine.

inherited

serializeProperties(Map<String, dynamic> properties) → Future<Struct>

Serializes resource properties for RPC transmission.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited