public final class NasJob extends GeneratedMessageV3 implements NasJobOrBuilder
Represents a Neural Architecture Search (NAS) job.
Protobuf type google.cloud.aiplatform.v1.NasJob
Static Fields
public static final int CREATE_TIME_FIELD_NUMBER
Field Value
public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
public static final int ENABLE_RESTRICTED_IMAGE_TRAINING_FIELD_NUMBER
Field Value
public static final int ENCRYPTION_SPEC_FIELD_NUMBER
Field Value
public static final int END_TIME_FIELD_NUMBER
Field Value
public static final int ERROR_FIELD_NUMBER
Field Value
public static final int LABELS_FIELD_NUMBER
Field Value
public static final int NAME_FIELD_NUMBER
Field Value
public static final int NAS_JOB_OUTPUT_FIELD_NUMBER
Field Value
public static final int NAS_JOB_SPEC_FIELD_NUMBER
Field Value
public static final int START_TIME_FIELD_NUMBER
Field Value
public static final int STATE_FIELD_NUMBER
Field Value
public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Static Methods
public static NasJob getDefaultInstance()
Returns
public static final Descriptors.Descriptor getDescriptor()
Returns
public static NasJob.Builder newBuilder()
Returns
public static NasJob.Builder newBuilder(NasJob prototype)
Parameter
Name | Description |
prototype | NasJob
|
Returns
public static NasJob parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static NasJob parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static NasJob parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
public static NasJob parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static NasJob parseFrom(ByteString data)
Parameter
Returns
Exceptions
public static NasJob parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static NasJob parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static NasJob parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static NasJob parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static NasJob parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static NasJob parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
public static NasJob parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Parser<NasJob> parser()
Returns
Methods
public boolean containsLabels(String key)
The labels with user-defined metadata to organize NasJobs.
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.
map<string, string> labels = 12;
Parameter
Returns
public boolean equals(Object obj)
Parameter
Returns
Overrides
public Timestamp getCreateTime()
Output only. Time when the NasJob was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public TimestampOrBuilder getCreateTimeOrBuilder()
Output only. Time when the NasJob was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public NasJob getDefaultInstanceForType()
Returns
public String getDisplayName()
Required. The display name of the NasJob.
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];
Returns
Type | Description |
String | The displayName.
|
public ByteString getDisplayNameBytes()
Required. The display name of the NasJob.
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];
Returns
Type | Description |
ByteString | The bytes for displayName.
|
public boolean getEnableRestrictedImageTraining()
Optional. Enable a separation of Custom model training
and restricted image training for tenant project.
bool enable_restricted_image_training = 14 [(.google.api.field_behavior) = OPTIONAL];
Returns
Type | Description |
boolean | The enableRestrictedImageTraining.
|
public EncryptionSpec getEncryptionSpec()
Customer-managed encryption key options for a NasJob.
If this is set, then all resources created by the NasJob
will be encrypted with the provided encryption key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 13;
Returns
public EncryptionSpecOrBuilder getEncryptionSpecOrBuilder()
Customer-managed encryption key options for a NasJob.
If this is set, then all resources created by the NasJob
will be encrypted with the provided encryption key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 13;
Returns
public Timestamp getEndTime()
Output only. Time when the NasJob entered any of the following states:
JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
.
.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public TimestampOrBuilder getEndTimeOrBuilder()
Output only. Time when the NasJob entered any of the following states:
JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
.
.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
com.google.rpc.Status | The error.
|
public StatusOrBuilder getErrorOrBuilder()
Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
com.google.rpc.StatusOrBuilder | |
public Map<String,String> getLabels()
Returns
public int getLabelsCount()
The labels with user-defined metadata to organize NasJobs.
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.
map<string, string> labels = 12;
Returns
public Map<String,String> getLabelsMap()
The labels with user-defined metadata to organize NasJobs.
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.
map<string, string> labels = 12;
Returns
public String getLabelsOrDefault(String key, String defaultValue)
The labels with user-defined metadata to organize NasJobs.
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.
map<string, string> labels = 12;
Parameters
Returns
public String getLabelsOrThrow(String key)
The labels with user-defined metadata to organize NasJobs.
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.
map<string, string> labels = 12;
Parameter
Returns
Output only. Resource name of the NasJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
String | The name.
|
public ByteString getNameBytes()
Output only. Resource name of the NasJob.
string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public NasJobOutput getNasJobOutput()
Output only. Output of the NasJob.
.google.cloud.aiplatform.v1.NasJobOutput nas_job_output = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public NasJobOutputOrBuilder getNasJobOutputOrBuilder()
Output only. Output of the NasJob.
.google.cloud.aiplatform.v1.NasJobOutput nas_job_output = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public NasJobSpec getNasJobSpec()
Required. The specification of a NasJob.
.google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
public NasJobSpecOrBuilder getNasJobSpecOrBuilder()
Required. The specification of a NasJob.
.google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
public Parser<NasJob> getParserForType()
Returns
Overrides
public int getSerializedSize()
Returns
Overrides
public Timestamp getStartTime()
Output only. Time when the NasJob for the first time entered the
JOB_STATE_RUNNING
state.
.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public TimestampOrBuilder getStartTimeOrBuilder()
Output only. Time when the NasJob for the first time entered the
JOB_STATE_RUNNING
state.
.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public JobState getState()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public int getStateValue()
Output only. The detailed state of the job.
.google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
int | The enum numeric value on the wire for state.
|
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
public Timestamp getUpdateTime()
Output only. Time when the NasJob was most recently updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public TimestampOrBuilder getUpdateTimeOrBuilder()
Output only. Time when the NasJob was most recently updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
public boolean hasCreateTime()
Output only. Time when the NasJob was created.
.google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the createTime field is set.
|
public boolean hasEncryptionSpec()
Customer-managed encryption key options for a NasJob.
If this is set, then all resources created by the NasJob
will be encrypted with the provided encryption key.
.google.cloud.aiplatform.v1.EncryptionSpec encryption_spec = 13;
Returns
Type | Description |
boolean | Whether the encryptionSpec field is set.
|
public boolean hasEndTime()
Output only. Time when the NasJob entered any of the following states:
JOB_STATE_SUCCEEDED
, JOB_STATE_FAILED
, JOB_STATE_CANCELLED
.
.google.protobuf.Timestamp end_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the endTime field is set.
|
public boolean hasError()
Output only. Only populated when job's state is JOB_STATE_FAILED or
JOB_STATE_CANCELLED.
.google.rpc.Status error = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the error field is set.
|
public boolean hasNasJobOutput()
Output only. Output of the NasJob.
.google.cloud.aiplatform.v1.NasJobOutput nas_job_output = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the nasJobOutput field is set.
|
public boolean hasNasJobSpec()
Required. The specification of a NasJob.
.google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
Returns
Type | Description |
boolean | Whether the nasJobSpec field is set.
|
public boolean hasStartTime()
Output only. Time when the NasJob for the first time entered the
JOB_STATE_RUNNING
state.
.google.protobuf.Timestamp start_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the startTime field is set.
|
public boolean hasUpdateTime()
Output only. Time when the NasJob was most recently updated.
.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns
Type | Description |
boolean | Whether the updateTime field is set.
|
Returns
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
protected MapField internalGetMapField(int number)
Parameter
Returns
Overrides
public final boolean isInitialized()
Returns
Overrides
public NasJob.Builder newBuilderForType()
Returns
protected NasJob.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
public NasJob.Builder toBuilder()
Returns
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions