custom_jobs

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

Overview

Name	custom_jobs
Type	Resource
Id	google.aiplatform.custom_jobs

Fields

Name	Datatype	Description
name	string	Output only. Resource name of a CustomJob.
createTime	string	Output only. Time when the CustomJob was created.
displayName	string	Required. The display name of the CustomJob. The name can be up to 128 characters long and can consist of any UTF-8 characters.
encryptionSpec	object	Represents a customer-managed encryption key spec that can be applied to a top-level resource.
endTime	string	Output only. Time when the CustomJob entered any of the following states: JOB_STATE_SUCCEEDED, JOB_STATE_FAILED, JOB_STATE_CANCELLED.
error	object	The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.
jobSpec	object	Represents the spec of a CustomJob.
labels	object	The labels with user-defined metadata to organize CustomJobs. 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.
satisfiesPzi	boolean	Output only. Reserved for future use.
satisfiesPzs	boolean	Output only. Reserved for future use.
startTime	string	Output only. Time when the CustomJob for the first time entered the JOB_STATE_RUNNING state.
state	string	Output only. The detailed state of the job.
updateTime	string	Output only. Time when the CustomJob was most recently updated.
webAccessUris	object	Output only. URIs for accessing interactive shells (one URI for each training node). Only available if job_spec.enable_web_access is true. The keys are names of each node in the training job; for example, workerpool0-0 for the primary node, workerpool1-0 for the first node in the second worker pool, and workerpool1-1 for the second node in the second worker pool. The values are the URIs for each node's interactive shell.

Methods

Name	Accessible by	Required Params	Description
get	SELECT	customJobsId, locationsId, projectsId	Gets a CustomJob.
list	SELECT	locationsId, projectsId	Lists CustomJobs in a Location.
create	INSERT	locationsId, projectsId	Creates a CustomJob. A created CustomJob right away will be attempted to be run.
delete	DELETE	customJobsId, locationsId, projectsId	Deletes a CustomJob.
cancel	EXEC	customJobsId, locationsId, projectsId	Cancels a CustomJob. Starts asynchronous cancellation on the CustomJob. The server makes a best effort to cancel the job, but success is not guaranteed. Clients can use JobService.GetCustomJob or other methods to check whether the cancellation succeeded or whether the job completed despite cancellation. On successful cancellation, the CustomJob is not deleted; instead it becomes a job with a CustomJob.error value with a google.rpc.Status.code of 1, corresponding to Code.CANCELLED, and CustomJob.state is set to CANCELLED.

SELECT examples

Lists CustomJobs in a Location.

SELECT
name,
createTime,
displayName,
encryptionSpec,
endTime,
error,
jobSpec,
labels,
satisfiesPzi,
satisfiesPzs,
startTime,
state,
updateTime,
webAccessUris
FROM google.aiplatform.custom_jobs
WHERE locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';

INSERT example

Use the following StackQL query and manifest file to create a new custom_jobs resource.

All Properties

/*+ create */
INSERT INTO google.aiplatform.custom_jobs (
locationsId,
projectsId,
displayName,
labels,
jobSpec,
encryptionSpec
)
SELECT 
'{{ locationsId }}',
'{{ projectsId }}',
'{{ displayName }}',
'{{ labels }}',
'{{ jobSpec }}',
'{{ encryptionSpec }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: startTime
      value: string
    - name: error
      value:
        - name: code
          value: integer
        - name: message
          value: string
        - name: details
          value:
            - object
    - name: satisfiesPzs
      value: boolean
    - name: endTime
      value: string
    - name: createTime
      value: string
    - name: name
      value: string
    - name: satisfiesPzi
      value: boolean
    - name: displayName
      value: string
    - name: labels
      value: object
    - name: jobSpec
      value:
        - name: scheduling
          value:
            - name: restartJobOnWorkerRestart
              value: boolean
            - name: timeout
              value: string
            - name: strategy
              value: string
            - name: disableRetries
              value: boolean
            - name: maxWaitDuration
              value: string
        - name: persistentResourceId
          value: string
        - name: baseOutputDirectory
          value:
            - name: outputUriPrefix
              value: string
        - name: experimentRun
          value: string
        - name: protectedArtifactLocationId
          value: string
        - name: serviceAccount
          value: string
        - name: workerPoolSpecs
          value:
            - - name: pythonPackageSpec
                value:
                  - name: args
                    value:
                      - string
                  - name: env
                    value:
                      - - name: value
                          value: string
                        - name: name
                          value: string
                  - name: pythonModule
                    value: string
                  - name: executorImageUri
                    value: string
                  - name: packageUris
                    value:
                      - string
              - name: diskSpec
                value:
                  - name: bootDiskType
                    value: string
                  - name: bootDiskSizeGb
                    value: integer
              - name: machineSpec
                value:
                  - name: acceleratorCount
                    value: integer
                  - name: tpuTopology
                    value: string
                  - name: machineType
                    value: string
                  - name: acceleratorType
                    value: string
                  - name: reservationAffinity
                    value:
                      - name: reservationAffinityType
                        value: string
                      - name: values
                        value:
                          - string
                      - name: key
                        value: string
              - name: containerSpec
                value:
                  - name: command
                    value:
                      - string
                  - name: args
                    value:
                      - string
                  - name: imageUri
                    value: string
                  - name: env
                    value:
                      - - name: value
                          value: string
                        - name: name
                          value: string
              - name: nfsMounts
                value:
                  - - name: mountPoint
                      value: string
                    - name: path
                      value: string
                    - name: server
                      value: string
              - name: replicaCount
                value: string
        - name: enableDashboardAccess
          value: boolean
        - name: network
          value: string
        - name: enableWebAccess
          value: boolean
        - name: experiment
          value: string
        - name: reservedIpRanges
          value:
            - string
        - name: tensorboard
          value: string
        - name: models
          value:
            - string
    - name: encryptionSpec
      value:
        - name: kmsKeyName
          value: string
    - name: updateTime
      value: string
    - name: state
      value: string
    - name: webAccessUris
      value: object

DELETE example

Deletes the specified custom_jobs resource.

/*+ delete */
DELETE FROM google.aiplatform.custom_jobs
WHERE customJobsId = '{{ customJobsId }}'
AND locationsId = '{{ locationsId }}'
AND projectsId = '{{ projectsId }}';