Class GoogleCloudAiplatformV1CustomJob

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).

Inheritance
object
GoogleCloudAiplatformV1CustomJob
Implements
Inherited Members
Namespace: Google.Apis.Aiplatform.v1.Data
Assembly: Google.Apis.Aiplatform.v1.dll
Syntax
public class GoogleCloudAiplatformV1CustomJob : IDirectResponseSchema

Properties

CreateTime

object representation of CreateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use CreateTimeDateTimeOffset instead.")]
public virtual object CreateTime { get; set; }
Property Value
Type Description
object

CreateTimeDateTimeOffset

DateTimeOffset representation of CreateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? CreateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

CreateTimeRaw

Output only. Time when the CustomJob was created.

Declaration
[JsonProperty("createTime")]
public virtual string CreateTimeRaw { get; set; }
Property Value
Type Description
string

DisplayName

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

Declaration
[JsonProperty("displayName")]
public virtual string DisplayName { get; set; }
Property Value
Type Description
string

ETag

The ETag of the item.

Declaration
public virtual string ETag { get; set; }
Property Value
Type Description
string

EncryptionSpec

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.

Declaration
[JsonProperty("encryptionSpec")]
public virtual GoogleCloudAiplatformV1EncryptionSpec EncryptionSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1EncryptionSpec

EndTime

object representation of EndTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use EndTimeDateTimeOffset instead.")]
public virtual object EndTime { get; set; }
Property Value
Type Description
object

EndTimeDateTimeOffset

DateTimeOffset representation of EndTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? EndTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

EndTimeRaw

Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

Declaration
[JsonProperty("endTime")]
public virtual string EndTimeRaw { get; set; }
Property Value
Type Description
string

Error

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

Declaration
[JsonProperty("error")]
public virtual GoogleRpcStatus Error { get; set; }
Property Value
Type Description
GoogleRpcStatus

JobSpec

Required. Job spec.

Declaration
[JsonProperty("jobSpec")]
public virtual GoogleCloudAiplatformV1CustomJobSpec JobSpec { get; set; }
Property Value
Type Description
GoogleCloudAiplatformV1CustomJobSpec

Labels

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.

Declaration
[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }
Property Value
Type Description
IDictionary<string, string>

Name

Output only. Resource name of a CustomJob.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

SatisfiesPzi

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzi")]
public virtual bool? SatisfiesPzi { get; set; }
Property Value
Type Description
bool?

SatisfiesPzs

Output only. Reserved for future use.

Declaration
[JsonProperty("satisfiesPzs")]
public virtual bool? SatisfiesPzs { get; set; }
Property Value
Type Description
bool?

StartTime

object representation of StartTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use StartTimeDateTimeOffset instead.")]
public virtual object StartTime { get; set; }
Property Value
Type Description
object

StartTimeDateTimeOffset

DateTimeOffset representation of StartTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? StartTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

StartTimeRaw

Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING state.

Declaration
[JsonProperty("startTime")]
public virtual string StartTimeRaw { get; set; }
Property Value
Type Description
string

State

Output only. The detailed state of the job.

Declaration
[JsonProperty("state")]
public virtual string State { get; set; }
Property Value
Type Description
string

UpdateTime

object representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
[Obsolete("This property is obsolete and may behave unexpectedly; please use UpdateTimeDateTimeOffset instead.")]
public virtual object UpdateTime { get; set; }
Property Value
Type Description
object

UpdateTimeDateTimeOffset

DateTimeOffset representation of UpdateTimeRaw.

Declaration
[JsonIgnore]
public virtual DateTimeOffset? UpdateTimeDateTimeOffset { get; set; }
Property Value
Type Description
DateTimeOffset?

UpdateTimeRaw

Output only. Time when the CustomJob was most recently updated.

Declaration
[JsonProperty("updateTime")]
public virtual string UpdateTimeRaw { get; set; }
Property Value
Type Description
string

WebAccessUris

Output only. URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.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.

Declaration
[JsonProperty("webAccessUris")]
public virtual IDictionary<string, string> WebAccessUris { get; set; }
Property Value
Type Description
IDictionary<string, string>

Implements