Google Cloud Ai Platform V1 Client - Class NasJob (1.13.0)

Version latest

• 1.13.0 (latest)
• 1.12.0
• 1.11.0
• 1.10.0
• 1.9.0
• 1.8.0
• 1.7.0
• 1.6.0
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.0
• 0.39.0
• 0.38.0
• 0.37.1
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.2
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.13.0
• 0.12.0
• 0.11.1
• 0.10.0

Reference documentation and code samples for the Google Cloud Ai Platform V1 Client class NasJob.

Represents a Neural Architecture Search (NAS) job.

Generated from protobuf message google.cloud.aiplatform.v1.NasJob

Namespace

Google \ Cloud \ AIPlatform \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ name	string Output only. Resource name of the NasJob.
↳ display_name	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.
↳ nas_job_spec	NasJobSpec Required. The specification of a NasJob.
↳ nas_job_output	NasJobOutput Output only. Output of the NasJob.
↳ state	int Output only. The detailed state of the job.
↳ create_time	Google\Protobuf\Timestamp Output only. Time when the NasJob was created.
↳ start_time	Google\Protobuf\Timestamp Output only. Time when the NasJob for the first time entered the JOB_STATE_RUNNING state.
↳ end_time	Google\Protobuf\Timestamp Output only. Time when the NasJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
↳ update_time	Google\Protobuf\Timestamp Output only. Time when the NasJob was most recently updated.
↳ error	Google\Rpc\Status Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED.
↳ labels	array|Google\Protobuf\Internal\MapField 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.
↳ encryption_spec	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.
↳ enable_restricted_image_training	bool Optional. Enable a separation of Custom model training and restricted image training for tenant project.
↳ satisfies_pzs	bool Output only. Reserved for future use.
↳ satisfies_pzi	bool Output only. Reserved for future use.

getName

Output only. Resource name of the NasJob.

Returns
Type	Description
string

setName

Output only. Resource name of the NasJob.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

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.

Returns
Type	Description
string

setDisplayName

Required. The display name of the NasJob.

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

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getNasJobSpec

Required. The specification of a NasJob.

Returns
Type	Description
NasJobSpec|null

hasNasJobSpec

clearNasJobSpec

setNasJobSpec

Required. The specification of a NasJob.

Parameter
Name	Description
var	NasJobSpec

Returns
Type	Description
$this

getNasJobOutput

Output only. Output of the NasJob.

Returns
Type	Description
NasJobOutput|null

hasNasJobOutput

clearNasJobOutput

setNasJobOutput

Output only. Output of the NasJob.

Parameter
Name	Description
var	NasJobOutput

Returns
Type	Description
$this

getState

Output only. The detailed state of the job.

Returns
Type	Description
int

setState

Output only. The detailed state of the job.

Parameter
Name	Description
var	int

Returns
Type	Description
$this

getCreateTime

Output only. Time when the NasJob was created.

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasCreateTime

clearCreateTime

setCreateTime

Output only. Time when the NasJob was created.

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getStartTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasStartTime

clearStartTime

setStartTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getEndTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasEndTime

clearEndTime

setEndTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getUpdateTime

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

Returns
Type	Description
Google\Protobuf\Timestamp|null

hasUpdateTime

clearUpdateTime

setUpdateTime

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

Parameter
Name	Description
var	Google\Protobuf\Timestamp

Returns
Type	Description
$this

getError

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

Returns
Type	Description
Google\Rpc\Status|null

hasError

clearError

setError

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

Parameter
Name	Description
var	Google\Rpc\Status

Returns
Type	Description
$this

getLabels

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
Type	Description
Google\Protobuf\Internal\MapField

setLabels

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.

Parameter
Name	Description
var	array|Google\Protobuf\Internal\MapField

Returns
Type	Description
$this

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.

Returns
Type	Description
EncryptionSpec|null

hasEncryptionSpec

clearEncryptionSpec

setEncryptionSpec

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.

Parameter
Name	Description
var	EncryptionSpec

Returns
Type	Description
$this

getEnableRestrictedImageTraining

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

Returns
Type	Description
bool

setEnableRestrictedImageTraining

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

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getSatisfiesPzs

Output only. Reserved for future use.

Returns
Type	Description
bool

setSatisfiesPzs

Output only. Reserved for future use.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getSatisfiesPzi

Output only. Reserved for future use.

Returns
Type	Description
bool

setSatisfiesPzi

Output only. Reserved for future use.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this