Vertex AI V1 API - Class Google::Cloud::AIPlatform::V1::NasJob (v0.56.0)

Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::NasJob.

Represents a Neural Architecture Search (NAS) job.

Inherits

Object

Extended By

Google::Protobuf::MessageExts::ClassMethods

Includes

Google::Protobuf::MessageExts

Methods

#create_time

def create_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the NasJob was created.

#display_name

def display_name() -> ::String

Returns

(::String) — Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#display_name=

def display_name=(value) -> ::String

Parameter

value (::String) — Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

Returns

(::String) — Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.

#enable_restricted_image_training

def enable_restricted_image_training() -> ::Boolean

Returns

(::Boolean) — Optional. Enable a separation of Custom model training and restricted image training for tenant project.

#enable_restricted_image_training=

def enable_restricted_image_training=(value) -> ::Boolean

Parameter

value (::Boolean) — Optional. Enable a separation of Custom model training and restricted image training for tenant project.

Returns

(::Boolean) — Optional. Enable a separation of Custom model training and restricted image training for tenant project.

#encryption_spec

def encryption_spec() -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Returns

(::Google::Cloud::AIPlatform::V1::EncryptionSpec) — 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.

#encryption_spec=

def encryption_spec=(value) -> ::Google::Cloud::AIPlatform::V1::EncryptionSpec

Parameter

value (::Google::Cloud::AIPlatform::V1::EncryptionSpec) — 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.

Returns

(::Google::Cloud::AIPlatform::V1::EncryptionSpec) — 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.

#end_time

def end_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the NasJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.

#error

def error() -> ::Google::Rpc::Status

Returns

(::Google::Rpc::Status) — Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}

Parameter

value (::Google::Protobuf::Map{::String => ::String}) — 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.

Returns

(::Google::Protobuf::Map{::String => ::String}) — 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.

#name

def name() -> ::String

Returns

(::String) — Output only. Resource name of the NasJob.

#nas_job_output

def nas_job_output() -> ::Google::Cloud::AIPlatform::V1::NasJobOutput

Returns

(::Google::Cloud::AIPlatform::V1::NasJobOutput) — Output only. Output of the NasJob.

#nas_job_spec

def nas_job_spec() -> ::Google::Cloud::AIPlatform::V1::NasJobSpec

Returns

(::Google::Cloud::AIPlatform::V1::NasJobSpec) — Required. The specification of a NasJob.

#nas_job_spec=

def nas_job_spec=(value) -> ::Google::Cloud::AIPlatform::V1::NasJobSpec

Parameter

value (::Google::Cloud::AIPlatform::V1::NasJobSpec) — Required. The specification of a NasJob.

Returns

(::Google::Cloud::AIPlatform::V1::NasJobSpec) — Required. The specification of a NasJob.

#satisfies_pzi

def satisfies_pzi() -> ::Boolean

Returns

(::Boolean) — Output only. Reserved for future use.

#satisfies_pzs

def satisfies_pzs() -> ::Boolean

Returns

(::Boolean) — Output only. Reserved for future use.

#start_time

def start_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the NasJob for the first time entered the JOB_STATE_RUNNING state.

#state

def state() -> ::Google::Cloud::AIPlatform::V1::JobState

Returns

(::Google::Cloud::AIPlatform::V1::JobState) — Output only. The detailed state of the job.

#update_time

def update_time() -> ::Google::Protobuf::Timestamp

Returns

(::Google::Protobuf::Timestamp) — Output only. Time when the NasJob was most recently updated.