com.google.cloud.aiplatform.v1

Interface NasJobOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

NasJob, NasJob.Builder

public interface NasJobOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) The labels with user-defined metadata to organize NasJobs.
com.google.protobuf.Timestamp	getCreateTime() Output only.
com.google.protobuf.TimestampOrBuilder	getCreateTimeOrBuilder() Output only.
String	getDisplayName() Required.
com.google.protobuf.ByteString	getDisplayNameBytes() Required.
boolean	getEnableRestrictedImageTraining() Deprecated. google.cloud.aiplatform.v1.NasJob.enable_restricted_image_training is deprecated. See google/cloud/aiplatform/v1/nas_job.proto;l=97
EncryptionSpec	getEncryptionSpec() Customer-managed encryption key options for a NasJob.
EncryptionSpecOrBuilder	getEncryptionSpecOrBuilder() Customer-managed encryption key options for a NasJob.
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.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() The labels with user-defined metadata to organize NasJobs.
Map<String,String>	getLabelsMap() The labels with user-defined metadata to organize NasJobs.
String	getLabelsOrDefault(String key, String defaultValue) The labels with user-defined metadata to organize NasJobs.
String	getLabelsOrThrow(String key) The labels with user-defined metadata to organize NasJobs.
String	getName() Output only.
com.google.protobuf.ByteString	getNameBytes() Output only.
NasJobOutput	getNasJobOutput() Output only.
NasJobOutputOrBuilder	getNasJobOutputOrBuilder() Output only.
NasJobSpec	getNasJobSpec() Required.
NasJobSpecOrBuilder	getNasJobSpecOrBuilder() Required.
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.
boolean	hasCreateTime() Output only.
boolean	hasEncryptionSpec() Customer-managed encryption key options for a NasJob.
boolean	hasEndTime() Output only.
boolean	hasError() Output only.
boolean	hasNasJobOutput() Output only.
boolean	hasNasJobSpec() Required.
boolean	hasStartTime() Output only.
boolean	hasUpdateTime() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

String getName()

 Output only. Resource name of the NasJob.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The name.

getNameBytes

com.google.protobuf.ByteString getNameBytes()

 Output only. Resource name of the NasJob.
 

string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The bytes for name.

getDisplayName

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:

The displayName.

getDisplayNameBytes

com.google.protobuf.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:

The bytes for displayName.

hasNasJobSpec

boolean hasNasJobSpec()

 Required. The specification of a NasJob.
 

.google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

Whether the nasJobSpec field is set.

getNasJobSpec

NasJobSpec getNasJobSpec()

 Required. The specification of a NasJob.
 

.google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

Returns:

The nasJobSpec.

getNasJobSpecOrBuilder

NasJobSpecOrBuilder getNasJobSpecOrBuilder()

 Required. The specification of a NasJob.
 

.google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];

hasNasJobOutput

boolean hasNasJobOutput()

 Output only. Output of the NasJob.
 

.google.cloud.aiplatform.v1.NasJobOutput nas_job_output = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the nasJobOutput field is set.

getNasJobOutput

NasJobOutput getNasJobOutput()

 Output only. Output of the NasJob.
 

.google.cloud.aiplatform.v1.NasJobOutput nas_job_output = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The nasJobOutput.

getNasJobOutputOrBuilder

NasJobOutputOrBuilder getNasJobOutputOrBuilder()

 Output only. Output of the NasJob.
 

.google.cloud.aiplatform.v1.NasJobOutput nas_job_output = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];

getStateValue

int getStateValue()

 Output only. The detailed state of the job.
 

.google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The enum numeric value on the wire for state.

getState

JobState getState()

 Output only. The detailed state of the job.
 

.google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The state.

hasCreateTime

boolean hasCreateTime()

 Output only. Time when the NasJob was created.
 

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

Returns:

Whether the createTime field is set.

getCreateTime

com.google.protobuf.Timestamp getCreateTime()

 Output only. Time when the NasJob was created.
 

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

Returns:

The createTime.

getCreateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()

 Output only. Time when the NasJob was created.
 

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

hasStartTime

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:

Whether the startTime field is set.

getStartTime

com.google.protobuf.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:

The startTime.

getStartTimeOrBuilder

com.google.protobuf.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];

hasEndTime

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:

Whether the endTime field is set.

getEndTime

com.google.protobuf.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:

The endTime.

getEndTimeOrBuilder

com.google.protobuf.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];

hasUpdateTime

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:

Whether the updateTime field is set.

getUpdateTime

com.google.protobuf.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:

The updateTime.

getUpdateTimeOrBuilder

com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()

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

.google.protobuf.Timestamp update_time = 10 [(.google.api.field_behavior) = OUTPUT_ONLY];

hasError

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:

Whether the error field is set.

getError

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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The error.

getErrorOrBuilder

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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

getLabelsCount

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;

containsLabels

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;

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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;

getLabelsOrDefault

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;

getLabelsOrThrow

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;

hasEncryptionSpec

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:

Whether the encryptionSpec field is set.

getEncryptionSpec

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:

The encryptionSpec.

getEncryptionSpecOrBuilder

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;

getEnableRestrictedImageTraining

@Deprecated
boolean getEnableRestrictedImageTraining()

Deprecated. google.cloud.aiplatform.v1.NasJob.enable_restricted_image_training is deprecated. See google/cloud/aiplatform/v1/nas_job.proto;l=97

 Optional. Enable a separation of Custom model training
 and restricted image training for tenant project.
 

bool enable_restricted_image_training = 14 [deprecated = true, (.google.api.field_behavior) = OPTIONAL];

Returns:

The enableRestrictedImageTraining.