Package com.google.cloud.aiplatform.v1

Class NasJob

  • All Implemented Interfaces:
    NasJobOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class NasJob
extends com.google.protobuf.GeneratedMessageV3
implements NasJobOrBuilder
     Represents a Neural Architecture Search (NAS) job.
    Protobuf type google.cloud.aiplatform.v1.NasJob
    See Also:
    Serialized Form

    • 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()

      • internalGetMapField

        protected com.google.protobuf.MapField internalGetMapField​(int number)
        Overrides:
        internalGetMapField 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 the NasJob.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getName in interface NasJobOrBuilder
        Returns:
        The name.

      • getNameBytes

        public com.google.protobuf.ByteString getNameBytes()
         Output only. Resource name of the NasJob.
        string name = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNameBytes in interface NasJobOrBuilder
        Returns:
        The bytes for name.

      • getDisplayName

        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];
        Specified by:
        getDisplayName in interface NasJobOrBuilder
        Returns:
        The displayName.

      • getDisplayNameBytes

        public 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];
        Specified by:
        getDisplayNameBytes in interface NasJobOrBuilder
        Returns:
        The bytes for displayName.

      • hasNasJobSpec

        public boolean hasNasJobSpec()
         Required. The specification of a NasJob.
        .google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        hasNasJobSpec in interface NasJobOrBuilder
        Returns:
        Whether the nasJobSpec field is set.

      • getNasJobSpec

        public NasJobSpec getNasJobSpec()
         Required. The specification of a NasJob.
        .google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNasJobSpec in interface NasJobOrBuilder
        Returns:
        The nasJobSpec.

      • getNasJobSpecOrBuilder

        public NasJobSpecOrBuilder getNasJobSpecOrBuilder()
         Required. The specification of a NasJob.
        .google.cloud.aiplatform.v1.NasJobSpec nas_job_spec = 4 [(.google.api.field_behavior) = REQUIRED];
        Specified by:
        getNasJobSpecOrBuilder in interface NasJobOrBuilder

      • hasNasJobOutput

        public boolean hasNasJobOutput()
         Output only. Output of the NasJob.
        .google.cloud.aiplatform.v1.NasJobOutput nas_job_output = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasNasJobOutput in interface NasJobOrBuilder
        Returns:
        Whether the nasJobOutput field is set.

      • getNasJobOutput

        public NasJobOutput getNasJobOutput()
         Output only. Output of the NasJob.
        .google.cloud.aiplatform.v1.NasJobOutput nas_job_output = 5 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getNasJobOutput in interface NasJobOrBuilder
        Returns:
        The nasJobOutput.

      • getStateValue

        public int getStateValue()
         Output only. The detailed state of the job.
        .google.cloud.aiplatform.v1.JobState state = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getStateValue in interface NasJobOrBuilder
        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 = 6 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getState in interface NasJobOrBuilder
        Returns:
        The state.

      • hasCreateTime

        public boolean hasCreateTime()
         Output only. Time when the NasJob was created.
        .google.protobuf.Timestamp create_time = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        hasCreateTime in interface NasJobOrBuilder
        Returns:
        Whether the createTime field is set.

      • getCreateTime

        public 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];
        Specified by:
        getCreateTime in interface NasJobOrBuilder
        Returns:
        The createTime.

      • getCreateTimeOrBuilder

        public 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];
        Specified by:
        getCreateTimeOrBuilder in interface NasJobOrBuilder

      • hasStartTime

        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];
        Specified by:
        hasStartTime in interface NasJobOrBuilder
        Returns:
        Whether the startTime field is set.

      • getStartTime

        public 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];
        Specified by:
        getStartTime in interface NasJobOrBuilder
        Returns:
        The startTime.

      • getStartTimeOrBuilder

        public 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];
        Specified by:
        getStartTimeOrBuilder in interface NasJobOrBuilder

      • hasEndTime

        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];
        Specified by:
        hasEndTime in interface NasJobOrBuilder
        Returns:
        Whether the endTime field is set.

      • getEndTime

        public 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];
        Specified by:
        getEndTime in interface NasJobOrBuilder
        Returns:
        The endTime.

      • getEndTimeOrBuilder

        public 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];
        Specified by:
        getEndTimeOrBuilder in interface NasJobOrBuilder

      • hasUpdateTime

        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];
        Specified by:
        hasUpdateTime in interface NasJobOrBuilder
        Returns:
        Whether the updateTime field is set.

      • getUpdateTime

        public 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];
        Specified by:
        getUpdateTime in interface NasJobOrBuilder
        Returns:
        The updateTime.

      • getUpdateTimeOrBuilder

        public 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];
        Specified by:
        getUpdateTimeOrBuilder in interface NasJobOrBuilder

      • hasError

        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];
        Specified by:
        hasError in interface NasJobOrBuilder
        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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getError in interface NasJobOrBuilder
        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 = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
        Specified by:
        getErrorOrBuilder in interface NasJobOrBuilder

      • getLabelsCount

        public int getLabelsCount()
        Description copied from interface: NasJobOrBuilder
         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;
        Specified by:
        getLabelsCount in interface NasJobOrBuilder

      • containsLabels

        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;
        Specified by:
        containsLabels in interface NasJobOrBuilder

      • getLabelsMap

        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;
        Specified by:
        getLabelsMap in interface NasJobOrBuilder

      • getLabelsOrDefault

        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;
        Specified by:
        getLabelsOrDefault in interface NasJobOrBuilder

      • getLabelsOrThrow

        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;
        Specified by:
        getLabelsOrThrow in interface NasJobOrBuilder

      • hasEncryptionSpec

        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;
        Specified by:
        hasEncryptionSpec in interface NasJobOrBuilder
        Returns:
        Whether the encryptionSpec field is set.

      • getEncryptionSpec

        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;
        Specified by:
        getEncryptionSpec in interface NasJobOrBuilder
        Returns:
        The encryptionSpec.

      • getEncryptionSpecOrBuilder

        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;
        Specified by:
        getEncryptionSpecOrBuilder in interface NasJobOrBuilder

      • getEnableRestrictedImageTraining

        @Deprecated
public 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];
        Specified by:
        getEnableRestrictedImageTraining in interface NasJobOrBuilder
        Returns:
        The enableRestrictedImageTraining.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static NasJob parseFrom​(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NasJob parseFrom​(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NasJob parseFrom​(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NasJob parseFrom​(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NasJob parseFrom​(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NasJob parseFrom​(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static NasJob parseFrom​(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException
        Throws:
        IOException

      • newBuilderForType

        public NasJob.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public NasJob.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected NasJob.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static NasJob getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<NasJob> parser()

      • getParserForType

        public com.google.protobuf.Parser<NasJob> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public NasJob getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder