CustomJob (proto-google-cloud-aiplatform-v1 3.63.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite
- - com.google.protobuf.AbstractMessage
  - - com.google.protobuf.GeneratedMessageV3
    - - com.google.cloud.aiplatform.v1.CustomJob

All Implemented Interfaces:: CustomJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class CustomJob
extends com.google.protobuf.GeneratedMessageV3
implements CustomJobOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.CustomJob

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class CustomJob.Builder
Represents a job that runs custom workloads such as a Docker container or a Python package.
- Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3
  com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter
- Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite
  com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Nested Classes
Modifier and Type	Class and Description
`static class`	`CustomJob.Builder` Represents a job that runs custom workloads such as a Docker container or a Python package.

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`CREATE_TIME_FIELD_NUMBER`
`static int`	`DISPLAY_NAME_FIELD_NUMBER`
`static int`	`ENCRYPTION_SPEC_FIELD_NUMBER`
`static int`	`END_TIME_FIELD_NUMBER`
`static int`	`ERROR_FIELD_NUMBER`
`static int`	`JOB_SPEC_FIELD_NUMBER`
`static int`	`LABELS_FIELD_NUMBER`
`static int`	`NAME_FIELD_NUMBER`
`static int`	`SATISFIES_PZI_FIELD_NUMBER`
`static int`	`SATISFIES_PZS_FIELD_NUMBER`
`static int`	`START_TIME_FIELD_NUMBER`
`static int`	`STATE_FIELD_NUMBER`
`static int`	`UPDATE_TIME_FIELD_NUMBER`
`static int`	`WEB_ACCESS_URIS_FIELD_NUMBER`

Fields inherited from class com.google.protobuf.GeneratedMessageV3
alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage
memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite
memoizedHashCode

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`containsLabels(String key)` The labels with user-defined metadata to organize CustomJobs.
`boolean`	`containsWebAccessUris(String key)` Output only.
`boolean`	`equals(Object obj)`
`com.google.protobuf.Timestamp`	`getCreateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getCreateTimeOrBuilder()` Output only.
`static CustomJob`	`getDefaultInstance()`
`CustomJob`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`String`	`getDisplayName()` Required.
`com.google.protobuf.ByteString`	`getDisplayNameBytes()` Required.
`EncryptionSpec`	`getEncryptionSpec()` Customer-managed encryption key options for a CustomJob.
`EncryptionSpecOrBuilder`	`getEncryptionSpecOrBuilder()` Customer-managed encryption key options for a CustomJob.
`com.google.protobuf.Timestamp`	`getEndTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getEndTimeOrBuilder()` Output only.
`com.google.rpc.Status`	`getError()` Output only.
`com.google.rpc.StatusOrBuilder`	`getErrorOrBuilder()` Output only.
`CustomJobSpec`	`getJobSpec()` Required.
`CustomJobSpecOrBuilder`	`getJobSpecOrBuilder()` Required.
`Map<String,String>`	`getLabels()` Deprecated.
`int`	`getLabelsCount()` The labels with user-defined metadata to organize CustomJobs.
`Map<String,String>`	`getLabelsMap()` The labels with user-defined metadata to organize CustomJobs.
`String`	`getLabelsOrDefault(String key, String defaultValue)` The labels with user-defined metadata to organize CustomJobs.
`String`	`getLabelsOrThrow(String key)` The labels with user-defined metadata to organize CustomJobs.
`String`	`getName()` Output only.
`com.google.protobuf.ByteString`	`getNameBytes()` Output only.
`com.google.protobuf.Parser<CustomJob>`	`getParserForType()`
`boolean`	`getSatisfiesPzi()` Output only.
`boolean`	`getSatisfiesPzs()` Output only.
`int`	`getSerializedSize()`
`com.google.protobuf.Timestamp`	`getStartTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getStartTimeOrBuilder()` Output only.
`JobState`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`com.google.protobuf.Timestamp`	`getUpdateTime()` Output only.
`com.google.protobuf.TimestampOrBuilder`	`getUpdateTimeOrBuilder()` Output only.
`Map<String,String>`	`getWebAccessUris()` Deprecated.
`int`	`getWebAccessUrisCount()` Output only.
`Map<String,String>`	`getWebAccessUrisMap()` Output only.
`String`	`getWebAccessUrisOrDefault(String key, String defaultValue)` Output only.
`String`	`getWebAccessUrisOrThrow(String key)` Output only.
`boolean`	`hasCreateTime()` Output only.
`boolean`	`hasEncryptionSpec()` Customer-managed encryption key options for a CustomJob.
`boolean`	`hasEndTime()` Output only.
`boolean`	`hasError()` Output only.
`int`	`hashCode()`
`boolean`	`hasJobSpec()` Required.
`boolean`	`hasStartTime()` Output only.
`boolean`	`hasUpdateTime()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`protected com.google.protobuf.MapFieldReflectionAccessor`	`internalGetMapFieldReflection(int number)`
`boolean`	`isInitialized()`
`static CustomJob.Builder`	`newBuilder()`
`static CustomJob.Builder`	`newBuilder(CustomJob prototype)`
`CustomJob.Builder`	`newBuilderForType()`
`protected CustomJob.Builder`	`newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)`
`protected Object`	`newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)`
`static CustomJob`	`parseDelimitedFrom(InputStream input)`
`static CustomJob`	`parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomJob`	`parseFrom(byte[] data)`
`static CustomJob`	`parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomJob`	`parseFrom(ByteBuffer data)`
`static CustomJob`	`parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomJob`	`parseFrom(com.google.protobuf.ByteString data)`
`static CustomJob`	`parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomJob`	`parseFrom(com.google.protobuf.CodedInputStream input)`
`static CustomJob`	`parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static CustomJob`	`parseFrom(InputStream input)`
`static CustomJob`	`parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`static com.google.protobuf.Parser<CustomJob>`	`parser()`
`CustomJob.Builder`	`toBuilder()`
`void`	`writeTo(com.google.protobuf.CodedOutputStream output)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3
canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage
findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite
addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite
toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail
- NAME_FIELD_NUMBER
```
public static final int NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- DISPLAY_NAME_FIELD_NUMBER
```
public static final int DISPLAY_NAME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- JOB_SPEC_FIELD_NUMBER
```
public static final int JOB_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- STATE_FIELD_NUMBER
```
public static final int STATE_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- CREATE_TIME_FIELD_NUMBER
```
public static final int CREATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- START_TIME_FIELD_NUMBER
```
public static final int START_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- END_TIME_FIELD_NUMBER
```
public static final int END_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- UPDATE_TIME_FIELD_NUMBER
```
public static final int UPDATE_TIME_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ERROR_FIELD_NUMBER
```
public static final int ERROR_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- LABELS_FIELD_NUMBER
```
public static final int LABELS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- ENCRYPTION_SPEC_FIELD_NUMBER
```
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- WEB_ACCESS_URIS_FIELD_NUMBER
```
public static final int WEB_ACCESS_URIS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SATISFIES_PZS_FIELD_NUMBER
```
public static final int SATISFIES_PZS_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values
- SATISFIES_PZI_FIELD_NUMBER
```
public static final int SATISFIES_PZI_FIELD_NUMBER
```
  See Also:
  
  Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:: newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetMapFieldReflection
```
protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
```
Overrides:

internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessageV3

internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName
```
public String getName()
```
```
 Output only. Resource name of a CustomJob.
 
```
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getName in interface CustomJobOrBuilder

Returns:

The name.

getNameBytes
```
public com.google.protobuf.ByteString getNameBytes()
```
```
 Output only. Resource name of a CustomJob.
 
```
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getNameBytes in interface CustomJobOrBuilder

Returns:

The bytes for name.

getDisplayName

public String getDisplayName()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getDisplayName in interface CustomJobOrBuilder
Returns:: The displayName.

getDisplayNameBytes

public com.google.protobuf.ByteString getDisplayNameBytes()

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

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Specified by:: getDisplayNameBytes in interface CustomJobOrBuilder
Returns:: The bytes for displayName.

hasJobSpec
```
public boolean hasJobSpec()
```
```
 Required. Job spec.
 
```
.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
Specified by:

hasJobSpec in interface CustomJobOrBuilder

Returns:

Whether the jobSpec field is set.

getJobSpec
```
public CustomJobSpec getJobSpec()
```
```
 Required. Job spec.
 
```
.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getJobSpec in interface CustomJobOrBuilder

Returns:

The jobSpec.

getJobSpecOrBuilder
```
public CustomJobSpecOrBuilder getJobSpecOrBuilder()
```
```
 Required. Job spec.
 
```
.google.cloud.aiplatform.v1.CustomJobSpec job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
Specified by:

getJobSpecOrBuilder in interface CustomJobOrBuilder

getStateValue
```
public int getStateValue()
```
```
 Output only. The detailed state of the job.
 
```
.google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getStateValue in interface CustomJobOrBuilder

Returns:

The enum numeric value on the wire for state.

getState
```
public JobState getState()
```
```
 Output only. The detailed state of the job.
 
```
.google.cloud.aiplatform.v1.JobState state = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getState in interface CustomJobOrBuilder

Returns:

The state.

hasCreateTime
```
public boolean hasCreateTime()
```
```
 Output only. Time when the CustomJob was created.
 
```
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasCreateTime in interface CustomJobOrBuilder

Returns:

Whether the createTime field is set.

getCreateTime
```
public com.google.protobuf.Timestamp getCreateTime()
```
```
 Output only. Time when the CustomJob was created.
 
```
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTime in interface CustomJobOrBuilder

Returns:

The createTime.

getCreateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
```
```
 Output only. Time when the CustomJob was created.
 
```
.google.protobuf.Timestamp create_time = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getCreateTimeOrBuilder in interface CustomJobOrBuilder

hasStartTime
```
public boolean hasStartTime()
```
```
 Output only. Time when the CustomJob for the first time entered the
 `JOB_STATE_RUNNING` state.
 
```
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasStartTime in interface CustomJobOrBuilder

Returns:

Whether the startTime field is set.

getStartTime
```
public com.google.protobuf.Timestamp getStartTime()
```
```
 Output only. Time when the CustomJob for the first time entered the
 `JOB_STATE_RUNNING` state.
 
```
.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getStartTime in interface CustomJobOrBuilder

Returns:

The startTime.

getStartTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getStartTimeOrBuilder()

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

.google.protobuf.Timestamp start_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getStartTimeOrBuilder in interface CustomJobOrBuilder

hasEndTime
```
public boolean hasEndTime()
```
```
 Output only. Time when the CustomJob entered any of the following states:
 `JOB_STATE_SUCCEEDED`, `JOB_STATE_FAILED`, `JOB_STATE_CANCELLED`.
 
```
.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasEndTime in interface CustomJobOrBuilder

Returns:

Whether the endTime field is set.

getEndTime

public com.google.protobuf.Timestamp getEndTime()

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

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getEndTime in interface CustomJobOrBuilder
Returns:: The endTime.

getEndTimeOrBuilder

public com.google.protobuf.TimestampOrBuilder getEndTimeOrBuilder()

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

.google.protobuf.Timestamp end_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getEndTimeOrBuilder in interface CustomJobOrBuilder

hasUpdateTime
```
public boolean hasUpdateTime()
```
```
 Output only. Time when the CustomJob was most recently updated.
 
```
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasUpdateTime in interface CustomJobOrBuilder

Returns:

Whether the updateTime field is set.

getUpdateTime
```
public com.google.protobuf.Timestamp getUpdateTime()
```
```
 Output only. Time when the CustomJob was most recently updated.
 
```
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTime in interface CustomJobOrBuilder

Returns:

The updateTime.

getUpdateTimeOrBuilder
```
public com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
```
```
 Output only. Time when the CustomJob was most recently updated.
 
```
.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getUpdateTimeOrBuilder in interface CustomJobOrBuilder

hasError
```
public boolean hasError()
```
```
 Output only. Only populated when job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
 
```
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

hasError in interface CustomJobOrBuilder

Returns:

Whether the error field is set.

getError
```
public com.google.rpc.Status getError()
```
```
 Output only. Only populated when job's state is `JOB_STATE_FAILED` or
 `JOB_STATE_CANCELLED`.
 
```
.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Specified by:

getError in interface CustomJobOrBuilder

Returns:

The error.

getErrorOrBuilder

public com.google.rpc.StatusOrBuilder getErrorOrBuilder()

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

.google.rpc.Status error = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

Specified by:: getErrorOrBuilder in interface CustomJobOrBuilder