public sealed class CustomJob : IMessage<CustomJob>, IEquatable<CustomJob>, IDeepCloneable<CustomJob>, IBufferMessage, IMessageReference documentation and code samples for the Cloud AI Platform v1 API class CustomJob.
Represents a job that runs custom workloads such as a Docker container or a Python package. A CustomJob can have multiple worker pools and each worker pool can have its own machine and input spec. A CustomJob will be cleaned up once the job enters terminal state (failed or succeeded).
Implements
IMessageCustomJob, IEquatableCustomJob, IDeepCloneableCustomJob, IBufferMessage, IMessageNamespace
Google.Cloud.AIPlatform.V1Assembly
Google.Cloud.AIPlatform.V1.dll
Constructors
CustomJob()
public CustomJob()CustomJob(CustomJob)
public CustomJob(CustomJob other)| Parameter | |
|---|---|
| Name | Description |
other | CustomJob |
Properties
CreateTime
public Timestamp CreateTime { get; set; }Output only. Time when the CustomJob was created.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
CustomJobName
public CustomJobName CustomJobName { get; set; }CustomJobName-typed view over the Name resource name property.
| Property Value | |
|---|---|
| Type | Description |
CustomJobName | |
DisplayName
public string DisplayName { get; set; }Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
| Property Value | |
|---|---|
| Type | Description |
string | |
EncryptionSpec
public EncryptionSpec EncryptionSpec { get; set; }Customer-managed encryption key options for a CustomJob. If this is set, then all resources created by the CustomJob will be encrypted with the provided encryption key.
| Property Value | |
|---|---|
| Type | Description |
EncryptionSpec | |
EndTime
public Timestamp EndTime { get; set; }Output only. Time when the CustomJob entered any of the following states:
JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
Error
public Status Error { get; set; }Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
| Property Value | |
|---|---|
| Type | Description |
Status | |
JobSpec
public CustomJobSpec JobSpec { get; set; }Required. Job spec.
| Property Value | |
|---|---|
| Type | Description |
CustomJobSpec | |
Labels
public MapField<string, string> Labels { get; }The labels with user-defined metadata to organize CustomJobs.
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.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |
Name
public string Name { get; set; }Output only. Resource name of a CustomJob.
| Property Value | |
|---|---|
| Type | Description |
string | |
StartTime
public Timestamp StartTime { get; set; }Output only. Time when the CustomJob for the first time entered the
JOB_STATE_RUNNING state.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
State
public JobState State { get; set; }Output only. The detailed state of the job.
| Property Value | |
|---|---|
| Type | Description |
JobState | |
UpdateTime
public Timestamp UpdateTime { get; set; }Output only. Time when the CustomJob was most recently updated.
| Property Value | |
|---|---|
| Type | Description |
Timestamp | |
WebAccessUris
public MapField<string, string> WebAccessUris { get; }Output only. URIs for accessing interactive
shells
(one URI for each training node). Only available if
[job_spec.enable_web_access][google.cloud.aiplatform.v1.CustomJobSpec.enable_web_access]
is true.
The keys are names of each node in the training job; for example,
workerpool0-0 for the primary node, workerpool1-0 for the first node in
the second worker pool, and workerpool1-1 for the second node in the
second worker pool.
The values are the URIs for each node's interactive shell.
| Property Value | |
|---|---|
| Type | Description |
MapFieldstringstring | |