nas_jobs

Creates, updates, deletes, gets or lists a nas_jobs resource.

Overview

Name	nas_jobs
Type	Resource
Id	google.aiplatform.nas_jobs

Fields

The following fields are returned by SELECT queries:

get

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the NasJob.
createTime	string (google-datetime)	Output only. Time when the NasJob was created.
displayName	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.
enableRestrictedImageTraining	boolean	Optional. Enable a separation of Custom model training and restricted image training for tenant project.
encryptionSpec	object	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. (id: GoogleCloudAiplatformV1EncryptionSpec)
endTime	string (google-datetime)	Output only. Time when the NasJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
error	object	Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. (id: GoogleRpcStatus)
labels	object	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.
nasJobOutput	object	Output only. Output of the NasJob. (id: GoogleCloudAiplatformV1NasJobOutput)
nasJobSpec	object	Required. The specification of a NasJob. (id: GoogleCloudAiplatformV1NasJobSpec)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
startTime	string (google-datetime)	Output only. Time when the NasJob for the first time entered the JOB_STATE_RUNNING state.
state	string	Output only. The detailed state of the job.
updateTime	string (google-datetime)	Output only. Time when the NasJob was most recently updated.

list

Successful response

Name	Datatype	Description
name	string	Output only. Resource name of the NasJob.
createTime	string (google-datetime)	Output only. Time when the NasJob was created.
displayName	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.
enableRestrictedImageTraining	boolean	Optional. Enable a separation of Custom model training and restricted image training for tenant project.
encryptionSpec	object	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. (id: GoogleCloudAiplatformV1EncryptionSpec)
endTime	string (google-datetime)	Output only. Time when the NasJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
error	object	Output only. Only populated when job's state is JOB_STATE_FAILED or JOB_STATE_CANCELLED. (id: GoogleRpcStatus)
labels	object	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.
nasJobOutput	object	Output only. Output of the NasJob. (id: GoogleCloudAiplatformV1NasJobOutput)
nasJobSpec	object	Required. The specification of a NasJob. (id: GoogleCloudAiplatformV1NasJobSpec)
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
startTime	string (google-datetime)	Output only. Time when the NasJob for the first time entered the JOB_STATE_RUNNING state.
state	string	Output only. The detailed state of the job.
updateTime	string (google-datetime)	Output only. Time when the NasJob was most recently updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	projectsId, locationsId, nasJobsId		Gets a NasJob
list	select	projectsId, locationsId	filter, pageSize, pageToken, readMask	Lists NasJobs in a Location.
create	insert	projectsId, locationsId		Creates a NasJob
delete	delete	projectsId, locationsId, nasJobsId		Deletes a NasJob.
cancel	exec	projectsId, locationsId, nasJobsId		Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
locationsId	string
nasJobsId	string
projectsId	string
filter	string
pageSize	integer (int32)
pageToken	string
readMask	string (google-fieldmask)

SELECT examples

get

Gets a NasJob

SELECT
name,
createTime,
displayName,
enableRestrictedImageTraining,
encryptionSpec,
endTime,
error,
labels,
nasJobOutput,
nasJobSpec,
satisfiesPzi,
satisfiesPzs,
startTime,
state,
updateTime
FROM google.aiplatform.nas_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND nasJobsId = '{{ nasJobsId }}' -- required;

list

Lists NasJobs in a Location.

SELECT
name,
createTime,
displayName,
enableRestrictedImageTraining,
encryptionSpec,
endTime,
error,
labels,
nasJobOutput,
nasJobSpec,
satisfiesPzi,
satisfiesPzs,
startTime,
state,
updateTime
FROM google.aiplatform.nas_jobs
WHERE projectsId = '{{ projectsId }}' -- required
AND locationsId = '{{ locationsId }}' -- required
AND filter = '{{ filter }}'
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND readMask = '{{ readMask }}';

INSERT examples

create

Creates a NasJob

INSERT INTO google.aiplatform.nas_jobs (
data__displayName,
data__nasJobSpec,
data__labels,
data__encryptionSpec,
data__enableRestrictedImageTraining,
projectsId,
locationsId
)
SELECT 
'{{ displayName }}',
'{{ nasJobSpec }}',
'{{ labels }}',
'{{ encryptionSpec }}',
{{ enableRestrictedImageTraining }},
'{{ projectsId }}',
'{{ locationsId }}'
RETURNING
name,
createTime,
displayName,
enableRestrictedImageTraining,
encryptionSpec,
endTime,
error,
labels,
nasJobOutput,
nasJobSpec,
satisfiesPzi,
satisfiesPzs,
startTime,
state,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: nas_jobs
  props:
    - name: projectsId
      value: string
      description: Required parameter for the nas_jobs resource.
    - name: locationsId
      value: string
      description: Required parameter for the nas_jobs resource.
    - name: displayName
      value: string
      description: >
        Required. The display name of the NasJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
        
    - name: nasJobSpec
      value: object
      description: >
        Required. The specification of a NasJob.
        
    - name: labels
      value: object
      description: >
        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: encryptionSpec
      value: object
      description: >
        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.
        
    - name: enableRestrictedImageTraining
      value: boolean
      description: >
        Optional. Enable a separation of Custom model training and restricted image training for tenant project.
        

DELETE examples

delete

Deletes a NasJob.

DELETE FROM google.aiplatform.nas_jobs
WHERE projectsId = '{{ projectsId }}' --required
AND locationsId = '{{ locationsId }}' --required
AND nasJobsId = '{{ nasJobsId }}' --required;

Lifecycle Methods

cancel

Cancels a NasJob. Starts asynchronous cancellation on the NasJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetNasJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the NasJob is not deleted; instead it becomes a job with a NasJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and NasJob.state is set to CANCELLED.

EXEC google.aiplatform.nas_jobs.cancel 
@projectsId='{{ projectsId }}' --required, 
@locationsId='{{ locationsId }}' --required, 
@nasJobsId='{{ nasJobsId }}' --required;